Merge remote-tracking branch 'upstream/main'

Author: jhnns

.github/workflows/test-and-release.yml

@@ -30,6 +30,11 @@ jobs:
     steps:
       - name: 📥 Checkout repository
         uses: actions/checkout@0c366fd6a839edf440554fa01a7085ccba70ac98 # main
+        with:
+          # Fetches 20 commits.
+          # This is trade-off between checkout speed and ability to create an accurate CHANGELOG.md
+          # See https://github.com/peerigon/template-public-package/issues/2
+          fetch-depth: 20
 
       - name: 🟢 Setup Node.js
         uses: actions/setup-node@d02c89dce7e1ba9ef629ce0680989b3a1cc72edb # main
@@ -56,10 +61,10 @@ jobs:
           npm ci --ignore-scripts --prefer-offline --no-audit
 
       - name: 🧪 Run tests
-        run: |
-          npm test
         env:
           CI: true
+        run: |
+          npm test
 
       - name: 🧪 Run integration test
         if: "github.event_name == 'workflow_dispatch'"

.vscode/extensions.json

@@ -1,3 +1,7 @@
 {
-  "recommendations": ["esbenp.prettier-vscode", "dbaeumer.vscode-eslint"]
+  "recommendations": [
+    "esbenp.prettier-vscode",
+    "dbaeumer.vscode-eslint",
+    "vitest.explorer"
+  ]
 }

package-lock.json

@@ -82,6 +82,7 @@
     "@types/qs": "^6.14.0",
     "@vitest/coverage-v8": "^4.0.18",
     "dotenv": "^17.2.3",
+    "env-var": "^7.5.0",
     "eslint": "9.39.2",
     "husky": "^9.1.7",
     "jsr": "^0.14.3",

package.json

@@ -0,0 +1,21 @@
+/**
+ * @file Environment variable configuration.
+ *
+ *   This file intentionally exports an `env` object so that it can easily be
+ *   auto-imported just by typing `env`.
+ *
+ *   Getters are used so that required env vars only throw when they are actually
+ *   accessed. That way you do not always have to supply all env vars (e.g. when
+ *   running only a subset of the app).
+ *
+ *   However, it is strongly encouraged to destructure env vars at the top-level
+ *   module scope so that errors are thrown immediately: `const { CI } = env;`
+ *   Processes should fail immediately if an env var is missing.
+ */
+import envVar from "env-var";
+
+export const env = {
+  get CI() {
+    return envVar.get("CI").default("false").asBool();
+  },
+};

src/env.ts

@@ -1,17 +1,20 @@
+import { loadEnv } from "vite";
 import { defineConfig } from "vitest/config";
+import { env } from "./src/env.ts";
 
-const isCi = process.env["CI"] === "true";
+const { CI } = env;
 const isIntegrationTest = process.argv.at(-1) === "integration.test.ts";
 
-export default defineConfig({
+export default defineConfig(({ mode }) => ({
   test: {
+    env: loadEnv(mode, import.meta.dirname, ""),
     include: ["src/**/*.test.?(c|m)[jt]s?(x)"],
     exclude: isIntegrationTest ? [] : ["src/integration.test.ts"],
     setupFiles: ["dotenv/config", "./src/tests/setup.ts"],
     coverage: {
-      enabled: isCi,
+      enabled: CI,
       reporter: ["html", "lcov"],
       include: ["src/**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"],
     },
   },
-});
+}));