Add coverage and codecov

.github/workflows/test.yml

@@ -6,6 +6,9 @@ on:
   pull_request:
     branches: [ "main" ]
 
+permissions:
+  id-token: write # This is required for requesting the JWT
+
 jobs:
   test:
     runs-on: ubuntu-latest
@@ -24,4 +27,9 @@ jobs:
       - name: Install Playwright Browsers
         run: pnpm exec playwright install --with-deps chromium
       - name: Test
-        run: pnpm test
+        run: pnpm test -- run --coverage --coverage.reporter=clover
+      - name: Code coverage upload
+        uses: codecov/codecov-action@v4
+        with:
+          files: ./coverage/clover.xml
+          use_oidc: true

.gitignore

@@ -26,3 +26,6 @@ docs
 
 # Pack
 i-vresse-haddock3-ui-*.tgz
+
+# Test
+coverage

CONTRIBUTING.md

@@ -48,10 +48,13 @@ pnpm format
 Testing logic can be done with tests written with [vitest](https://vitest.dev) in [browser mode](https://vitest.dev/guide/browser/).
 
 ```bash
-pnpm exec playwright install # Only needed once
+pnpm exec playwright install # Only needed once per installation
 pnpm test
 # Or to run headless
 CI=1 pnpm test
+# Or for coverage
+CI=1 pnpm test -- run --coverage --coverage.reporter=html
+# Open coverage/index.html in browser
 ```
 
 Stories and tests can be located next to the code in the `src/` folder.

package.json

@@ -47,6 +47,7 @@
 		"@typescript-eslint/parser": "^7.15.0",
 		"@vitejs/plugin-react": "^4.3.1",
 		"@vitest/browser": "^2.0.5",
+		"@vitest/coverage-istanbul": "^2.0.5",
 		"autoprefixer": "^10.4.19",
 		"playwright": "^1.46.0",
 		"postcss": "^8.4.40",

vite.config.ts

@@ -13,5 +13,11 @@ export default defineConfig({
 			provider: "playwright",
 			providerOptions: {},
 		},
+		coverage: {
+			provider: "istanbul",
+			reporter: ["text"],
+			include: ["src/**/*"],
+			exclude: ["**/*.stories.*", "**/*.test.*"],
+		},
 	},
 });