test documentation coverage

.github/workflows/test.docs.yml

@@ -37,11 +37,16 @@ jobs:
     name: Docs
     needs: files-changed
     runs-on: ubuntu-latest
+    env:
+      COVERAGE_REQUIRED: 10
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.1.7
       - uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.0.3
         with:
           node-version-file: './.tool-versions'
       - name: Docs
-        run: npm install && npm run docs:generate
+        run: |
+          npm install
+          npm run docs:generate
+          bash -c "if (( $(sed -nE 's/.*>([0-9]{1,3})%<.*/\1/p' docs/coverage.svg | head -1) > $COVERAGE_REQUIRED )) then exit 0; else exit 1; fi"
         working-directory: ./

package.json

@@ -13,7 +13,7 @@
     "test:lint:eslint": "eslint --ext .ts,.tsx,.js,.jsx,.cjs,.mjs,.json,.yml,.yaml --max-warnings 0 .",
     "test:unit": "npm run test:unit:dev -- run --coverage",
     "test:unit:dev": "vitest",
-    "docs:generate": "typedoc src/index.tsx",
+    "docs:generate": "typedoc --plugin typedoc-plugin-coverage src/index.tsx",
     "update": "npx npm-check-updates"
   },
   "files": [
@@ -61,6 +61,7 @@
     "rollup-plugin-typescript2": "^0.32.1",
     "tailwindcss": "^3.3.1",
     "typedoc": "^0.27.6",
+    "typedoc-plugin-coverage": "^3.4.1",
     "typescript": "^5.7.3",
     "vite": "^6.0.11",
     "vitest": "^3.0.5"