chore: add test coveragge

.github/workflows/coverage-badge.yml → .github/workflows/test-coverage.yml

@@ -7,7 +7,7 @@ on:
       - main
 
 jobs:
-  coverage-badge:
+  test-coverage:
     strategy:
       matrix:
         os:
@@ -17,6 +17,13 @@ jobs:
         pnpm:
           - 7
     runs-on: ${{ matrix.os }}
+
+    permissions:
+      # Required to checkout the code
+      contents: read
+      # Required to put a comment into the pull-request
+      pull-requests: write
+
     steps:
       - name: checkout repository
         uses: actions/checkout@v4
@@ -28,17 +35,10 @@ jobs:
       - name: 📥 Install Dependencies
         run: yarn --frozen-lockfile
 
-      - name: run coverage
-        run: yarn test:coverage
+      - name: 'Run test coverage'
+        run: npx vitest --coverage.enabled true
 
-      - name: generate badges
-        run: yarn generate-badges
-
-      - name: push coverage artifacts to another branch
-        uses: peaceiris/actions-gh-pages@v3
-        if: github.ref == 'refs/heads/main'
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./coverage
-          publish_branch: coverage
-          allow_empty_commit: true
+      - name: 'Report Coverage'
+        # Set if: always() to also generate the report if tests are failing
+        # Only works if you set `reportOnFailure: true` in your vite config as specified above
+        uses:  davelosert/vitest-coverage-report-action@v2

.vscode/launch.json

@@ -9,7 +9,7 @@
       "request": "launch",
       "name": "Debug Test File",
       "runtimeExecutable": "npm",
-      "runtimeArgs": ["run-script", "test-unit"],
+      "runtimeArgs": ["run-script", "test"],
       "skipFiles": ["<node_internals>/**", "**/node_modules/**"],
       "args": ["${relativeFile}"],
       "env": {}

.vscode/settings.json

@@ -16,11 +16,10 @@
   "[javascript]": {
     "editor.formatOnSave": false
   },
-  "eslint.experimental.useFlatConfig": true,
   "[jsonc]": {
-    "editor.defaultFormatter": "vscode.json-language-features"
+    "editor.formatOnSave": false
   },
   "[json]": {
-    "editor.defaultFormatter": "vscode.json-language-features"
-  },
-}
+    "editor.formatOnSave": false
+  }
+}

tsconfig.build.json

@@ -10,12 +10,6 @@
     "baseUrl": "./",
     "paths": {}
   },
-  "include": [
-    "./src/index.ts"
-  ],
-  "exclude": [
-    "**/*.stories.tsx",
-    "**/*.stories.mdx",
-    ".storybook/**"
-  ]
-}
+  "include": ["./src/index.ts"],
+  "exclude": ["**/*.stories.tsx", "**/*.stories.mdx", ".storybook/**"]
+}

vitest.config.ts

@@ -9,9 +9,12 @@ export default defineConfig({
       '@/': new URL('./src/', import.meta.url).pathname,
     },
     coverage: {
-      provider: 'istanbul', // or 'v8'
-      reporter: ['text', 'json', 'html'],
       include: ['src/**'],
+      provider: 'istanbul', // or 'v8'
+      // you can include other reporters, but 'json-summary' is required, json is recommended
+      reporter: ['text', 'json-summary', 'json'],
+      // If you want a coverage reports even if your tests are failing, include the reportOnFailure option
+      reportOnFailure: true,
     },
     include: ['**/?(*.){test,spec}.?(c|m)[jt]s?(x)'],
   },

website/tsconfig.json

@@ -2,8 +2,6 @@
   "extends": "@tsconfig/docusaurus/tsconfig.json",
   "compilerOptions": {
     "baseUrl": "./",
-    "types": [
-      "vitest/globals"
-    ]
+    "types": ["vitest/globals"]
   }
-}
+}