Merge pull request #21 from cameronbrill/cb/better-pr-reviews

report test coverage in a PR

.github/workflows/check.yml

@@ -16,13 +16,21 @@ jobs:
           token: ${{ secrets.GITHUB_TOKEN }}
           self: Mergeability
 
+  actionlint:
+    name: lint github actions
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: reviewdog/action-actionlint@v1
+
+
   yarn-check:
     name: yarn ${{ matrix.command }}
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        command: ["lint:ci", "format:ci", "build:scss", "build:ts", "test"]
+        command: ["lint:ci", "format:ci", "build:scss", "build:ts", "test:coverage"]
     steps:
       - uses: actions/checkout@v4
 
@@ -42,3 +50,12 @@ jobs:
         run: yarn ${{ matrix.command }}
         env:
           FORCE_COLOR: 2
+          CONDITION: always()
+          CONDITION2: ${{ matrix.command == 'test:coverage' }}
+          CONDITION3: ${{ matrix.command == 'test:coverage' }} && always()
+      - name: 'Report Coverage'
+        if: matrix.command == 'test:coverage' && always() 
+        uses:  davelosert/vitest-coverage-report-action@v2
+        with:
+          json-summary-path	: './src/__tests__/coverage/coverage-summary.json'
+

.gitignore

@@ -6,8 +6,10 @@
 .pnp.js
 
 # testing
-/coverage
+vitest.config.mts.timestamp-*.mjs
 vitest.config.ts.timestamp-*.mjs
+html/
+src/__tests__/coverage
 
 # production
 /build

.vscode/extensions.json

@@ -8,6 +8,7 @@
     "vitest.explorer",
     "wallabyjs.wallaby-vscode",
     "file-icons.file-icons",
-    "usernamehw.errorlens"
+    "usernamehw.errorlens",
+    "ryanluker.vscode-coverage-gutters"
   ]
 }

.vscode/settings.json

@@ -6,6 +6,10 @@
   },
   "typescript.tsdk": ".yarn/sdks/typescript/lib",
   "typescript.enablePromptUseWorkspaceTsdk": true,
+  "[typescript]": {
+    "editor.defaultFormatter": "Jota0222.multi-formatter",
+    "multiFormatter.formatterList": ["biomejs.biome", "esbenp.prettier-vscode"]
+  },
   "[typescriptreact]": {
     "editor.defaultFormatter": "Jota0222.multi-formatter",
     "multiFormatter.formatterList": ["biomejs.biome", "esbenp.prettier-vscode"]
@@ -16,5 +20,5 @@
   "vitest.watchOnStartup": true,
   "vitest.showFailMessages": true,
   "vitest.enable": true,
-  "vitest.commandLine": "yarn test:watch"
+  "vitest.commandLine": "yarn test:coverage:watch"
 }

biome.json

@@ -7,7 +7,8 @@
     "ignore": [
       ".prettierrc.js",
       ".yarn/*",
-      "vitest.config.mts"
+      "vitest.config.mts",
+      "src/__tests__/coverage/*"
     ]
   },
   "linter": {

package.json

@@ -25,7 +25,11 @@
     "format": "yarn _conc 'yarn:format:ts:biome' 'yarn:format:ts:imports'",
     "format:fix": "yarn format:ts:fix:biome && yarn format:ts:fix:imports",
     "test": "vitest run",
-    "test:watch": "vitest",
+    "test:coverage": "yarn test --coverage",
+    "test:watch": "vitest watch",
+    "test:coverage:watch": "yarn test:watch --coverage",
+    "test:ui:watch": "vitest watch --ui",
+    "test:coverage:ui:watch": "yarn test:ui:watch --coverage",
     "build:ts": "next build",
     "build:ts:watch": "next dev",
     "build:scss": "yarn typed-scss-modules src --banner '// This file is automatically generated. Do not edit.'",
@@ -80,6 +84,8 @@
     "@types/lodash": "^4",
     "@types/node": "20.11.19",
     "@vitejs/plugin-react": "^4.2.1",
+    "@vitest/coverage-istanbul": "^1.3.1",
+    "@vitest/ui": "^1.3.1",
     "@yarnpkg/sdks": "^3.1.0",
     "concurrently": "^8.2.2",
     "eslint": "^8.56.0",

vitest.config.mts

@@ -1,11 +1,33 @@
-import { defineConfig } from 'vitest/config'
-import react from '@vitejs/plugin-react'
- 
+import { configDefaults, defineConfig } from "vitest/config";
+import react from "@vitejs/plugin-react";
+
 export default defineConfig({
   plugins: [react()],
   test: {
-    environment: 'jsdom',
-    globals:true,
-    setupFiles: "src/setupTests.ts"
+    environment: "jsdom",
+    globals: true,
+    setupFiles: "src/setupTests.ts",
+    reporters: ["default", "html", "json"],
+    coverage: {
+      exclude: [
+        ...(configDefaults.coverage.exclude || []),
+        "html/**",
+        "build/**/*",
+        ".yarn/**/*",
+        "next.config.js",
+        "**/.{idea,git,cache,output,temp,yarn}/**",
+      ],
+      provider: "istanbul",
+      reporter: ["json", "text", "html", "json-summary", "lcov"],
+      reportsDirectory: "./src/__tests__/coverage",
+      reportOnFailure: true,
+      thresholds: {
+        autoUpdate: true,
+        statements: 9,
+        branches: 5,
+        functions: 8.57,
+        lines: 9.37,
+      },
+    },
   },
-})
+});