Merge upstream master

.github/dependabot.yml

@@ -19,3 +19,13 @@ updates:
     commit-message:
       prefix: "ci(deps)"
       prefix-development: "ci(deps-dev)"
+
+  # Maintain dependencies for Devcontainers
+  - package-ecosystem: devcontainers
+    directory: "/"
+    schedule:
+      interval: weekly
+    open-pull-requests-limit: 10
+    commit-message:
+      prefix: "build(deps)"
+      prefix-development: "build(deps-dev)"

.github/workflows/codeql-analysis.yml

@@ -24,6 +24,8 @@ permissions:
 
 jobs:
   CodeQL-Build:
+    if: github.repository == 'anuraghazra/github-readme-stats'
+
     # CodeQL runs on ubuntu-latest, windows-latest, and macos-latest
     runs-on: ubuntu-latest
 

.github/workflows/deploy-prep.yml

@@ -13,7 +13,7 @@ jobs:
       - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
       - name: Deployment Prep
         run: python ./.github/workflows/deploy-prep.py
-      - uses: stefanzweifel/git-auto-commit-action@778341af668090896ca464160c2def5d1d1a3eb0 # v6.0.1
+      - uses: stefanzweifel/git-auto-commit-action@28e16e81777b558cc906c8750092100bbb34c5e3 # v7.0.0
         with:
           branch: vercel
           create_branch: true

.github/workflows/ossf-analysis.yml

@@ -27,7 +27,7 @@ jobs:
           persist-credentials: false
 
       - name: "Run analysis"
-        uses: ossf/scorecard-action@05b42c624433fc40578a4040d5cf5e36ddca8cde # v2.4.2
+        uses: ossf/scorecard-action@4eaacf0543bb3f2c246792bd56e8cdeffafb205a # v2.4.3
         with:
           results_file: results.sarif
           results_format: sarif

.github/workflows/preview-theme.yml

@@ -40,7 +40,7 @@ jobs:
           node-version: ${{ matrix.node-version }}
           cache: npm
 
-      - uses: bahmutov/npm-install@3714964fb879ebbbc108e167f0f3a0c81ec075c9 # v1.10.10
+      - uses: bahmutov/npm-install@4488656f8e90d3c85e3a964db0018dd624f340e7 # v1.11.1
         with:
           useLockFile: false
 

.github/workflows/stale-theme-pr-closer.yml

@@ -45,7 +45,7 @@ jobs:
           node-version: ${{ matrix.node-version }}
           cache: npm
 
-      - uses: bahmutov/npm-install@3714964fb879ebbbc108e167f0f3a0c81ec075c9 # v1.10.10
+      - uses: bahmutov/npm-install@4488656f8e90d3c85e3a964db0018dd624f340e7 # v1.11.1
         with:
           useLockFile: false
 

.github/workflows/theme-prs-closer.yml

@@ -1,9 +1,7 @@
 name: Theme Pull Requests Closer
 
 on:
-  pull_request:
-    types:
-      - labeled
+  - pull_request_target
 
 permissions:
   actions: read
@@ -21,8 +19,8 @@ permissions:
 
 jobs:
   close-prs:
+    if: github.repository == 'anuraghazra/github-readme-stats'
     runs-on: ubuntu-latest
-
     steps:
       - name: Check out the code
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
@@ -34,7 +32,7 @@ jobs:
 
       - name: Close Pull Requests
         run: |
-          comment_message="We are currently pausing addition of new themes. If this theme is exclusively for your personal use, then instead of adding it to our theme collection, you can use card customization options."
+          comment_message="We are currently pausing addition of new themes. If this theme is exclusively for your personal use, then instead of adding it to our theme collection, you can use card [customization options](https://github.com/anuraghazra/github-readme-stats?tab=readme-ov-file#customization)."
 
           for pr_number in $(gh pr list -l "themes" -q is:open --json number -q ".[].number"); do
             gh pr close $pr_number -c "$comment_message"

.vercelignore

@@ -1,3 +1,15 @@
+.devcontainer
+.github
+.husky
+.vscode
+benchmarks
+coverage
+scripts
+tests
 .env
-package-lock.json
-coverage
+**/*.md
+**/*.svg
+.eslintrc.json
+.prettierignore
+.pretterrc.json
+codecov.yml

.vscode/settings.json

@@ -2,4 +2,7 @@
     "markdown.extension.toc.levels": "1..3",
     "editor.formatOnSave": true,
     "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "[javascript]": {
+        "editor.tabSize": 2
+    }
 }

CONTRIBUTING.md

@@ -1,5 +1,8 @@
 # Contributing to [github-readme-stats](https://github.com/anuraghazra/github-readme-stats)
 
+> [!IMPORTANT]
+> Please note that we are NOT participating in Hacktoberfest this year. As a small team, we cannot handle the increased volume of PRs and issues that the event brings. We appreciate your understanding.
+
 We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
 
 -   Reporting [an issue](https://github.com/anuraghazra/github-readme-stats/issues/new?assignees=&labels=bug&template=bug_report.yml).
@@ -35,16 +38,17 @@ _(make sure you already have a [Vercel](https://vercel.com/) account)_
 3.  Run `npm install` in the repository root.
 4.  Run the command `vercel` in the root and follow the steps there.
 5.  Run the command `vercel dev` to start a development server at <http://localhost:3000>.
-6.  The cards will then be available from this local endpoint (i.e. `http://localhost:3000/api?username=anuraghazra`).
+6.  Create a `.env` file in the root and add the following line `NODE_ENV=development`, this will disable caching for local development.
+7.  The cards will then be available from this local endpoint (i.e. `http://localhost:3000/api?username=anuraghazra`).
 
-> [!NOTE]\
+> [!NOTE]
 > You can debug the package code in [Vscode](https://code.visualstudio.com/) by using the [Node.js: Attach to process](https://code.visualstudio.com/docs/nodejs/nodejs-debugging#_setting-up-an-attach-configuration) debug option. You can also debug any tests using the [VSCode Jest extension](https://marketplace.visualstudio.com/items?itemName=Orta.vscode-jest). For more information, see https://github.com/jest-community/vscode-jest/issues/912.
 
 ## Themes Contribution
 
 We're currently paused addition of new themes to decrease maintenance efforts. All pull requests related to new themes will be closed.
 
-> [!NOTE]\
+> [!NOTE]
 > If you are considering contributing your theme just because you are using it personally, then instead of adding it to our theme collection, you can use card [customization options](./readme.md#customization).
 
 ## Translations Contribution

api/gist.js

@@ -1,14 +1,23 @@
-import {
-  clampValue,
-  CONSTANTS,
-  renderError,
-  parseBoolean,
-} from "../src/common/utils.js";
-import { gistWhitelist } from "../src/common/whitelist.js";
+// @ts-check
+
+import { renderError } from "../src/common/render.js";
 import { isLocaleAvailable } from "../src/translations.js";
 import { renderGistCard } from "../src/cards/gist.js";
 import { fetchGist } from "../src/fetchers/gist.js";
+import {
+  CACHE_TTL,
+  resolveCacheSeconds,
+  setCacheHeaders,
+  setErrorCacheHeaders,
+} from "../src/common/cache.js";
+import { guardAccess } from "../src/common/access.js";
+import {
+  MissingParamError,
+  retrieveSecondaryMessage,
+} from "../src/common/error.js";
+import { parseBoolean } from "../src/common/ops.js";
 
+// @ts-ignore
 export default async (req, res) => {
   const {
     id,
@@ -27,51 +36,48 @@ export default async (req, res) => {
 
   res.setHeader("Content-Type", "image/svg+xml");
 
-  if (gistWhitelist && !gistWhitelist.includes(id)) {
+  const access = guardAccess({
+    res,
+    id,
+    type: "gist",
+    colors: {
+      title_color,
+      text_color,
+      bg_color,
+      border_color,
+      theme,
+    },
+  });
+  if (!access.isPassed) {
+    return access.result;
+  }
+
+  if (locale && !isLocaleAvailable(locale)) {
     return res.send(
-      renderError(
-        "This gist ID is not whitelisted",
-        "Please deploy your own instance",
-        {
+      renderError({
+        message: "Something went wrong",
+        secondaryMessage: "Language not found",
+        renderOptions: {
           title_color,
           text_color,
           bg_color,
           border_color,
           theme,
-          show_repo_link: false,
         },
-      ),
-    );
-  }
-
-  if (locale && !isLocaleAvailable(locale)) {
-    return res.send(
-      renderError("Something went wrong", "Language not found", {
-        title_color,
-        text_color,
-        bg_color,
-        border_color,
-        theme,
       }),
     );
   }
 
   try {
     const gistData = await fetchGist(id);
+    const cacheSeconds = resolveCacheSeconds({
+      requested: parseInt(cache_seconds, 10),
+      def: CACHE_TTL.GIST_CARD.DEFAULT,
+      min: CACHE_TTL.GIST_CARD.MIN,
+      max: CACHE_TTL.GIST_CARD.MAX,
+    });
 
-    let cacheSeconds = clampValue(
-      parseInt(cache_seconds || CONSTANTS.TWO_DAY, 10),
-      CONSTANTS.TWO_DAY,
-      CONSTANTS.SIX_DAY,
-    );
-    cacheSeconds = process.env.CACHE_SECONDS
-      ? parseInt(process.env.CACHE_SECONDS, 10) || cacheSeconds
-      : cacheSeconds;
-
-    res.setHeader(
-      "Cache-Control",
-      `max-age=${cacheSeconds}, s-maxage=${cacheSeconds}`,
-    );
+    setCacheHeaders(res, cacheSeconds);
 
     return res.send(
       renderGistCard(gistData, {
@@ -88,19 +94,33 @@ export default async (req, res) => {
       }),
     );
   } catch (err) {
-    res.setHeader(
-      "Cache-Control",
-      `max-age=${CONSTANTS.ERROR_CACHE_SECONDS / 2}, s-maxage=${
-        CONSTANTS.ERROR_CACHE_SECONDS
-      }, stale-while-revalidate=${CONSTANTS.ONE_DAY}`,
-    ); // Use lower cache period for errors.
+    setErrorCacheHeaders(res);
+    if (err instanceof Error) {
+      return res.send(
+        renderError({
+          message: err.message,
+          secondaryMessage: retrieveSecondaryMessage(err),
+          renderOptions: {
+            title_color,
+            text_color,
+            bg_color,
+            border_color,
+            theme,
+            show_repo_link: !(err instanceof MissingParamError),
+          },
+        }),
+      );
+    }
     return res.send(
-      renderError(err.message, err.secondaryMessage, {
-        title_color,
-        text_color,
-        bg_color,
-        border_color,
-        theme,
+      renderError({
+        message: "An unknown error occurred",
+        renderOptions: {
+          title_color,
+          text_color,
+          bg_color,
+          border_color,
+          theme,
+        },
       }),
     );
   }