chore: specify files/directories to exclude from git archives (#2184)

Co-authored-by: Danshil Kokil Mungur <me@danshilm.com>
2025-10-03 00:48:07 +02:00 · 2023-10-16 10:02:01 -07:00
parent 3ea5076053
commit e2771a3011
4 changed files with 191 additions and 170 deletions
--- a/.gitattributes
+++ b/.gitattributes
@@ -24,3 +24,24 @@
 *.woff binary
 *.pyc binary
 *.pdf binary
+
+#
+## Theses files/directories should be excluded from git archives
+#
+
+.husky export-ignore
+.vscode export-ignore
+docs export-ignore
+
+.git* export-ignore
+*ignore export-ignore
+*.md export-ignore
+
+.all-contributorsrc export-ignore
+.editorconfig export-ignore
+Dockerfile.local export-ignore
+docker-compose.yml export-ignore
+stylelint.config.js export-ignore
+
+public/os_logo_filled.png export-ignore
+public/preview.jpg export-ignore
--- a/cypress/config/settings.cypress.json
+++ b/cypress/config/settings.cypress.json
@@ -3,147 +3,147 @@
  "vapidPrivate": "tmnslaO8ZWN6bNbSEv_rolPeBTlNxOwCCAHrM9oZz3M",
  "vapidPublic": "BK_EpP8NDm9waor2zn6_S28o3ZYv4kCkJOfYpO3pt3W6jnPmxrgTLANUBNbbyaNatPnSQ12De9CeqSYQrqWzHTs",
  "main": {
-   "apiKey": "testkey",
-   "applicationTitle": "Overseerr",
-   "applicationUrl": "",
-   "csrfProtection": false,
-   "cacheImages": false,
-   "defaultPermissions": 32,
-   "defaultQuotas": {
-    "movie": {},
-    "tv": {}
-   },
-   "hideAvailable": false,
-   "localLogin": true,
-   "newPlexLogin": true,
-   "region": "",
-   "originalLanguage": "",
-   "trustProxy": false,
-   "partialRequestsEnabled": true,
-   "locale": "en"
+    "apiKey": "testkey",
+    "applicationTitle": "Overseerr",
+    "applicationUrl": "",
+    "csrfProtection": false,
+    "cacheImages": false,
+    "defaultPermissions": 32,
+    "defaultQuotas": {
+      "movie": {},
+      "tv": {}
+    },
+    "hideAvailable": false,
+    "localLogin": true,
+    "newPlexLogin": true,
+    "region": "",
+    "originalLanguage": "",
+    "trustProxy": false,
+    "partialRequestsEnabled": true,
+    "locale": "en"
  },
  "plex": {
-   "name": "Seerr",
-   "ip": "192.168.1.1",
-   "port": 32400,
-   "useSsl": false,
-   "libraries": [
-    {
-     "id": "1",
-     "name": "Movies",
-     "enabled": true,
-     "type": "movie"
-    }
-   ],
-   "machineId": "test"
+    "name": "Seerr",
+    "ip": "192.168.1.1",
+    "port": 32400,
+    "useSsl": false,
+    "libraries": [
+      {
+        "id": "1",
+        "name": "Movies",
+        "enabled": true,
+        "type": "movie"
+      }
+    ],
+    "machineId": "test"
  },
  "tautulli": {},
  "radarr": [],
  "sonarr": [],
  "public": {
-   "initialized": true
+    "initialized": true
  },
  "notifications": {
-   "agents": {
-    "email": {
-     "enabled": false,
-     "options": {
-      "emailFrom": "",
-      "smtpHost": "",
-      "smtpPort": 587,
-      "secure": false,
-      "ignoreTls": false,
-      "requireTls": false,
-      "allowSelfSigned": false,
-      "senderName": "Overseerr"
-     }
-    },
-    "discord": {
-     "enabled": false,
-     "types": 0,
-     "options": {
-      "webhookUrl": "",
-      "enableMentions": true
-     }
-    },
-    "lunasea": {
-     "enabled": false,
-     "types": 0,
-     "options": {
-      "webhookUrl": ""
-     }
-    },
-    "slack": {
-     "enabled": false,
-     "types": 0,
-     "options": {
-      "webhookUrl": ""
-     }
-    },
-    "telegram": {
-     "enabled": false,
-     "types": 0,
-     "options": {
-      "botAPI": "",
-      "chatId": "",
-      "sendSilently": false
-     }
-    },
-    "pushbullet": {
-     "enabled": false,
-     "types": 0,
-     "options": {
-      "accessToken": ""
-     }
-    },
-    "pushover": {
-     "enabled": false,
-     "types": 0,
-     "options": {
-      "accessToken": "",
-      "userToken": ""
-     }
-    },
-    "webhook": {
-     "enabled": false,
-     "types": 0,
-     "options": {
-      "webhookUrl": "",
-      "jsonPayload": "IntcbiAgICBcIm5vdGlmaWNhdGlvbl90eXBlXCI6IFwie3tub3RpZmljYXRpb25fdHlwZX19XCIsXG4gICAgXCJldmVudFwiOiBcInt7ZXZlbnR9fVwiLFxuICAgIFwic3ViamVjdFwiOiBcInt7c3ViamVjdH19XCIsXG4gICAgXCJtZXNzYWdlXCI6IFwie3ttZXNzYWdlfX1cIixcbiAgICBcImltYWdlXCI6IFwie3tpbWFnZX19XCIsXG4gICAgXCJ7e21lZGlhfX1cIjoge1xuICAgICAgICBcIm1lZGlhX3R5cGVcIjogXCJ7e21lZGlhX3R5cGV9fVwiLFxuICAgICAgICBcInRtZGJJZFwiOiBcInt7bWVkaWFfdG1kYmlkfX1cIixcbiAgICAgICAgXCJ0dmRiSWRcIjogXCJ7e21lZGlhX3R2ZGJpZH19XCIsXG4gICAgICAgIFwic3RhdHVzXCI6IFwie3ttZWRpYV9zdGF0dXN9fVwiLFxuICAgICAgICBcInN0YXR1czRrXCI6IFwie3ttZWRpYV9zdGF0dXM0a319XCJcbiAgICB9LFxuICAgIFwie3tyZXF1ZXN0fX1cIjoge1xuICAgICAgICBcInJlcXVlc3RfaWRcIjogXCJ7e3JlcXVlc3RfaWR9fVwiLFxuICAgICAgICBcInJlcXVlc3RlZEJ5X2VtYWlsXCI6IFwie3tyZXF1ZXN0ZWRCeV9lbWFpbH19XCIsXG4gICAgICAgIFwicmVxdWVzdGVkQnlfdXNlcm5hbWVcIjogXCJ7e3JlcXVlc3RlZEJ5X3VzZXJuYW1lfX1cIixcbiAgICAgICAgXCJyZXF1ZXN0ZWRCeV9hdmF0YXJcIjogXCJ7e3JlcXVlc3RlZEJ5X2F2YXRhcn19XCJcbiAgICB9LFxuICAgIFwie3tpc3N1ZX19XCI6IHtcbiAgICAgICAgXCJpc3N1ZV9pZFwiOiBcInt7aXNzdWVfaWR9fVwiLFxuICAgICAgICBcImlzc3VlX3R5cGVcIjogXCJ7e2lzc3VlX3R5cGV9fVwiLFxuICAgICAgICBcImlzc3VlX3N0YXR1c1wiOiBcInt7aXNzdWVfc3RhdHVzfX1cIixcbiAgICAgICAgXCJyZXBvcnRlZEJ5X2VtYWlsXCI6IFwie3tyZXBvcnRlZEJ5X2VtYWlsfX1cIixcbiAgICAgICAgXCJyZXBvcnRlZEJ5X3VzZXJuYW1lXCI6IFwie3tyZXBvcnRlZEJ5X3VzZXJuYW1lfX1cIixcbiAgICAgICAgXCJyZXBvcnRlZEJ5X2F2YXRhclwiOiBcInt7cmVwb3J0ZWRCeV9hdmF0YXJ9fVwiXG4gICAgfSxcbiAgICBcInt7Y29tbWVudH19XCI6IHtcbiAgICAgICAgXCJjb21tZW50X21lc3NhZ2VcIjogXCJ7e2NvbW1lbnRfbWVzc2FnZX19XCIsXG4gICAgICAgIFwiY29tbWVudGVkQnlfZW1haWxcIjogXCJ7e2NvbW1lbnRlZEJ5X2VtYWlsfX1cIixcbiAgICAgICAgXCJjb21tZW50ZWRCeV91c2VybmFtZVwiOiBcInt7Y29tbWVudGVkQnlfdXNlcm5hbWV9fVwiLFxuICAgICAgICBcImNvbW1lbnRlZEJ5X2F2YXRhclwiOiBcInt7Y29tbWVudGVkQnlfYXZhdGFyfX1cIlxuICAgIH0sXG4gICAgXCJ7e2V4dHJhfX1cIjogW11cbn0i"
-     }
-    },
-    "webpush": {
-     "enabled": false,
-     "options": {}
-    },
-    "gotify": {
-     "enabled": false,
-     "types": 0,
-     "options": {
-      "url": "",
-      "token": ""
-     }
+    "agents": {
+      "email": {
+        "enabled": false,
+        "options": {
+          "emailFrom": "",
+          "smtpHost": "",
+          "smtpPort": 587,
+          "secure": false,
+          "ignoreTls": false,
+          "requireTls": false,
+          "allowSelfSigned": false,
+          "senderName": "Overseerr"
+        }
+      },
+      "discord": {
+        "enabled": false,
+        "types": 0,
+        "options": {
+          "webhookUrl": "",
+          "enableMentions": true
+        }
+      },
+      "lunasea": {
+        "enabled": false,
+        "types": 0,
+        "options": {
+          "webhookUrl": ""
+        }
+      },
+      "slack": {
+        "enabled": false,
+        "types": 0,
+        "options": {
+          "webhookUrl": ""
+        }
+      },
+      "telegram": {
+        "enabled": false,
+        "types": 0,
+        "options": {
+          "botAPI": "",
+          "chatId": "",
+          "sendSilently": false
+        }
+      },
+      "pushbullet": {
+        "enabled": false,
+        "types": 0,
+        "options": {
+          "accessToken": ""
+        }
+      },
+      "pushover": {
+        "enabled": false,
+        "types": 0,
+        "options": {
+          "accessToken": "",
+          "userToken": ""
+        }
+      },
+      "webhook": {
+        "enabled": false,
+        "types": 0,
+        "options": {
+          "webhookUrl": "",
+          "jsonPayload": "IntcbiAgICBcIm5vdGlmaWNhdGlvbl90eXBlXCI6IFwie3tub3RpZmljYXRpb25fdHlwZX19XCIsXG4gICAgXCJldmVudFwiOiBcInt7ZXZlbnR9fVwiLFxuICAgIFwic3ViamVjdFwiOiBcInt7c3ViamVjdH19XCIsXG4gICAgXCJtZXNzYWdlXCI6IFwie3ttZXNzYWdlfX1cIixcbiAgICBcImltYWdlXCI6IFwie3tpbWFnZX19XCIsXG4gICAgXCJ7e21lZGlhfX1cIjoge1xuICAgICAgICBcIm1lZGlhX3R5cGVcIjogXCJ7e21lZGlhX3R5cGV9fVwiLFxuICAgICAgICBcInRtZGJJZFwiOiBcInt7bWVkaWFfdG1kYmlkfX1cIixcbiAgICAgICAgXCJ0dmRiSWRcIjogXCJ7e21lZGlhX3R2ZGJpZH19XCIsXG4gICAgICAgIFwic3RhdHVzXCI6IFwie3ttZWRpYV9zdGF0dXN9fVwiLFxuICAgICAgICBcInN0YXR1czRrXCI6IFwie3ttZWRpYV9zdGF0dXM0a319XCJcbiAgICB9LFxuICAgIFwie3tyZXF1ZXN0fX1cIjoge1xuICAgICAgICBcInJlcXVlc3RfaWRcIjogXCJ7e3JlcXVlc3RfaWR9fVwiLFxuICAgICAgICBcInJlcXVlc3RlZEJ5X2VtYWlsXCI6IFwie3tyZXF1ZXN0ZWRCeV9lbWFpbH19XCIsXG4gICAgICAgIFwicmVxdWVzdGVkQnlfdXNlcm5hbWVcIjogXCJ7e3JlcXVlc3RlZEJ5X3VzZXJuYW1lfX1cIixcbiAgICAgICAgXCJyZXF1ZXN0ZWRCeV9hdmF0YXJcIjogXCJ7e3JlcXVlc3RlZEJ5X2F2YXRhcn19XCJcbiAgICB9LFxuICAgIFwie3tpc3N1ZX19XCI6IHtcbiAgICAgICAgXCJpc3N1ZV9pZFwiOiBcInt7aXNzdWVfaWR9fVwiLFxuICAgICAgICBcImlzc3VlX3R5cGVcIjogXCJ7e2lzc3VlX3R5cGV9fVwiLFxuICAgICAgICBcImlzc3VlX3N0YXR1c1wiOiBcInt7aXNzdWVfc3RhdHVzfX1cIixcbiAgICAgICAgXCJyZXBvcnRlZEJ5X2VtYWlsXCI6IFwie3tyZXBvcnRlZEJ5X2VtYWlsfX1cIixcbiAgICAgICAgXCJyZXBvcnRlZEJ5X3VzZXJuYW1lXCI6IFwie3tyZXBvcnRlZEJ5X3VzZXJuYW1lfX1cIixcbiAgICAgICAgXCJyZXBvcnRlZEJ5X2F2YXRhclwiOiBcInt7cmVwb3J0ZWRCeV9hdmF0YXJ9fVwiXG4gICAgfSxcbiAgICBcInt7Y29tbWVudH19XCI6IHtcbiAgICAgICAgXCJjb21tZW50X21lc3NhZ2VcIjogXCJ7e2NvbW1lbnRfbWVzc2FnZX19XCIsXG4gICAgICAgIFwiY29tbWVudGVkQnlfZW1haWxcIjogXCJ7e2NvbW1lbnRlZEJ5X2VtYWlsfX1cIixcbiAgICAgICAgXCJjb21tZW50ZWRCeV91c2VybmFtZVwiOiBcInt7Y29tbWVudGVkQnlfdXNlcm5hbWV9fVwiLFxuICAgICAgICBcImNvbW1lbnRlZEJ5X2F2YXRhclwiOiBcInt7Y29tbWVudGVkQnlfYXZhdGFyfX1cIlxuICAgIH0sXG4gICAgXCJ7e2V4dHJhfX1cIjogW11cbn0i"
+        }
+      },
+      "webpush": {
+        "enabled": false,
+        "options": {}
+      },
+      "gotify": {
+        "enabled": false,
+        "types": 0,
+        "options": {
+          "url": "",
+          "token": ""
+        }
+      }
    }
-   }
  },
  "jobs": {
-   "plex-recently-added-scan": {
-    "schedule": "0 */5 * * * *"
-   },
-   "plex-full-scan": {
-    "schedule": "0 0 3 * * *"
-   },
-   "radarr-scan": {
-    "schedule": "0 0 4 * * *"
-   },
-   "sonarr-scan": {
-    "schedule": "0 30 4 * * *"
-   },
-   "download-sync": {
-    "schedule": "0 * * * * *"
-   },
-   "download-sync-reset": {
-    "schedule": "0 0 1 * * *"
-   }
+    "plex-recently-added-scan": {
+      "schedule": "0 */5 * * * *"
+    },
+    "plex-full-scan": {
+      "schedule": "0 0 3 * * *"
+    },
+    "radarr-scan": {
+      "schedule": "0 0 4 * * *"
+    },
+    "sonarr-scan": {
+      "schedule": "0 30 4 * * *"
+    },
+    "download-sync": {
+      "schedule": "0 * * * * *"
+    },
+    "download-sync-reset": {
+      "schedule": "0 0 1 * * *"
+    }
  }
- }
+}
--- a/public/offline.html
+++ b/public/offline.html
@@ -17,7 +17,7 @@
      }

      h1 {
-        color: #6366F1;
+        color: #6366f1;
      }

      p {
@@ -37,7 +37,7 @@
    <!-- Inline the page's JavaScript file. -->
    <script>
      // Manual reload feature.
-      document.querySelector("button").addEventListener("click", () => {
+      document.querySelector('button').addEventListener('click', () => {
        window.location.reload();
      });

--- a/public/sw.js
+++ b/public/sw.js
@@ -4,30 +4,30 @@
 // This variable is intentionally declared and unused.
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const OFFLINE_VERSION = 3;
-const CACHE_NAME = "offline";
+const CACHE_NAME = 'offline';
 // Customize this with a different URL if needed.
-const OFFLINE_URL = "/offline.html";
+const OFFLINE_URL = '/offline.html';

-self.addEventListener("install", (event) => {
+self.addEventListener('install', (event) => {
  event.waitUntil(
    (async () => {
      const cache = await caches.open(CACHE_NAME);
      // Setting {cache: 'reload'} in the new request will ensure that the
      // response isn't fulfilled from the HTTP cache; i.e., it will be from
      // the network.
-      await cache.add(new Request(OFFLINE_URL, { cache: "reload" }));
+      await cache.add(new Request(OFFLINE_URL, { cache: 'reload' }));
    })()
  );
  // Force the waiting service worker to become the active service worker.
  self.skipWaiting();
 });

-self.addEventListener("activate", (event) => {
+self.addEventListener('activate', (event) => {
  event.waitUntil(
    (async () => {
      // Enable navigation preload if it's supported.
      // See https://developers.google.com/web/updates/2017/02/navigation-preload
-      if ("navigationPreload" in self.registration) {
+      if ('navigationPreload' in self.registration) {
        await self.registration.navigationPreload.enable();
      }
    })()
@@ -37,10 +37,10 @@ self.addEventListener("activate", (event) => {
  clients.claim();
 });

-self.addEventListener("fetch", (event) => {
+self.addEventListener('fetch', (event) => {
  // We only want to call event.respondWith() if this is a navigation request
  // for an HTML page.
-  if (event.request.mode === "navigate") {
+  if (event.request.mode === 'navigate') {
    event.respondWith(
      (async () => {
        try {
@@ -59,7 +59,7 @@ self.addEventListener("fetch", (event) => {
          // If fetch() returns a valid HTTP response with a response code in
          // the 4xx or 5xx range, the catch() will NOT be called.
          // eslint-disable-next-line no-console
-          console.log("Fetch failed; returning offline page instead.", error);
+          console.log('Fetch failed; returning offline page instead.', error);

          const cache = await caches.open(CACHE_NAME);
          const cachedResponse = await cache.match(OFFLINE_URL);
@@ -85,15 +85,13 @@ self.addEventListener('push', (event) => {
      requestId: payload.requestId,
    },
    actions: [],
-  }
+  };

-  if (payload.actionUrl){
-    options.actions.push(
-      {
-        action: 'view',
-        title: payload.actionUrlTitle ?? 'View',
-      }
-    );
+  if (payload.actionUrl) {
+    options.actions.push({
+      action: 'view',
+      title: payload.actionUrlTitle ?? 'View',
+    });
  }

  if (payload.notificationType === 'MEDIA_PENDING') {
@@ -109,27 +107,29 @@ self.addEventListener('push', (event) => {
    );
  }

-  event.waitUntil(
-    self.registration.showNotification(payload.subject, options)
-  );
+  event.waitUntil(self.registration.showNotification(payload.subject, options));
 });

-self.addEventListener('notificationclick', (event) => {
-  const notificationData = event.notification.data;
+self.addEventListener(
+  'notificationclick',
+  (event) => {
+    const notificationData = event.notification.data;

-  event.notification.close();
+    event.notification.close();

-  if (event.action === 'approve') {
-    fetch(`/api/v1/request/${notificationData.requestId}/approve`, {
-      method: 'POST',
-    });
-  } else if (event.action === 'decline') {
-    fetch(`/api/v1/request/${notificationData.requestId}/decline`, {
-      method: 'POST',
-    });
-  }
+    if (event.action === 'approve') {
+      fetch(`/api/v1/request/${notificationData.requestId}/approve`, {
+        method: 'POST',
+      });
+    } else if (event.action === 'decline') {
+      fetch(`/api/v1/request/${notificationData.requestId}/decline`, {
+        method: 'POST',
+      });
+    }

-  if (notificationData.actionUrl) {
-    clients.openWindow(notificationData.actionUrl);
-  }
-}, false);
+    if (notificationData.actionUrl) {
+      clients.openWindow(notificationData.actionUrl);
+    }
+  },
+  false
+);