Add code coverage report to unit test CI workflow, docs deletions, tweak vitest.config

Author: webstackdev

.eslintrc.js

@@ -11,6 +11,12 @@ jobs:
     name: Build and Test
     runs-on: ubuntu-latest
 
+    permissions:
+      # Required to checkout the code
+      contents: read
+      # Required to put a comment into the pull-request
+      pull-requests: write
+
     # Define environment variables once at the job level
     # These will be available to ALL steps in this job
     env:
@@ -40,8 +46,19 @@ jobs:
       - name: Run lint
         run: npm run lint
 
-      - name: Run unit tests
-        run: npm test -- --run
+      - name: Run unit tests (Vitest — coverage with GitHub Actions reporter)
+        run: |
+          # Run vitest with coverage. The built-in 'github-actions' reporter
+          # (configured in vitest.config.ts) will create annotations.
+          # Coverage reporters (json-summary, json) are configured in vitest.config.ts.
+          npx vitest run --coverage
+
+      - name: Report Coverage
+        uses: davelosert/vitest-coverage-report-action@v2
+        if: always()
+        with:
+          json-summary-path: './coverage/coverage-summary.json'
+          json-final-path: './coverage/coverage-final.json'
 
       - name: Build project
         run: npm run build

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

@@ -23,8 +23,6 @@ npm-debug.log*
 
 # dotenv environment variable files
 .env*
-# Commit default dotenv environment variable file
-!.env.local
 
 # Optional npm cache directory
 .npm

.gitignore

@@ -157,19 +157,21 @@ export default [
       'jsdoc/valid-types': 'off',
       'new-cap': [level, { newIsCap: true, capIsNew: false }],
       'no-new': level,
-      'no-process-env': level,
+      'no-process-env': [level, , {
+        "message": "Do not use  process.env directly. See docs/ENVIRONMENT_VARIABLES."
+      }]
       'no-restricted-globals': ['error'].concat(restrictedGlobals),
       'no-restricted-imports': [
         'error', {
             patterns: [
               {
                 group: ['../*'],
-                message: 'Usage of relative imports is not allowed. Please use path aliases.',
+                message: 'Usage of relative imports is not allowed. Use path aliases.',
               },
               {
                 group: ['*'],
                 importNames: ['*'],
-                message: 'Wildcard imports are not allowed. Please use named imports instead.',
+                message: 'Wildcard imports are not allowed. Use named imports instead.',
               },
             ],
           },
@@ -231,6 +233,34 @@ export default [
     },
   },
   {
+    // Test files can import from server code in src/lib
+    files: ['src/**/__tests__/**/*'],
+    rules: {
+      'import/no-restricted-paths': 'off',
+    },
+  },
+  {
+    // Test files can import from server code in src/lib
+    'import/no-restricted-paths': [
+      level,
+      {
+        zones: [
+          {
+            target: 'src/**/__tests__/**/*',
+            from: 'src/components/scripts/utils/environmentClient.ts',
+            message: 'use src/lib/config/environmentServer.ts in test files, not environmentClient.',
+          },
+          {
+            target: 'src/**/__tests__/**/*',
+            from: 'src/components/scripts/utils/siteUrlClient.ts',
+            message: 'use src/lib/config/siteUrlServer.ts in test files, not siteUrlClient.',
+          },
+        ],
+      },
+    ],
+  },
+  {
+    // Files that need access to process.env()
     files: [
       '.eslintrc.js',
       'astro.config.ts',
@@ -239,7 +269,6 @@ export default [
       'scripts/build/**/*'
     ],
     rules: {
-      // All files except Astro config should use import.meta.env.ENV_VAR
       'no-process-env': 'off',
     },
   },
@@ -254,7 +283,7 @@ export default [
         level,
         {
           'selector': 'MetaProperty[meta.name="import"][property.name="meta"]',
-          'message': 'Do not use import.meta.env directly. Use methods in src/components/scripts/utils like isCI(), isDev(), etc.'
+          'message': 'Do not use import.meta.env directly. See docs/ENVIRONMENT_VARIABLES.'
         }
       ],
     },

FRAMEWORK_CHOICE.md

@@ -42,10 +42,10 @@
     "lint:style": "npx stylelint \"src/**/*.{css,astro}\"",
     "preview": "npm run build:favicons && npx astro build && astro preview",
     "sync": "npx astro sync",
-    "test": "cross-env NODE_ENV=test npm run test:unit && npm run test:e2e",
-    "test:coverage": "cross-env NODE_ENV=test npx vitest run --coverage",
-    "test:e2e": "cross-env NODE_ENV=test npx playwright test",
-    "test:unit": "cross-env NODE_ENV=test npx vitest run",
+    "test": "npm run test:unit && npm run test:e2e",
+    "test:coverage": "npx vitest run --coverage",
+    "test:e2e": "npx playwright test",
+    "test:unit": "npx vitest run",
     "upgrade": "npx @astrojs/upgrade",
     "prepare": "husky"
   },