Merge pull request #413 from MuckRock/jest-coverage

Testing improvements

.github/workflows/coverage.yml

@@ -0,0 +1,22 @@
+name: Coverage Report
+
+on:
+  pull_request:
+    branches: [master]
+
+jobs:
+  coverage:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js 18.x
+        uses: actions/setup-node@v3
+        with:
+          node-version: "18.x"
+      - run: npm ci
+      - run: npm run build
+        env:
+          NODE_ENV: production
+      - uses: ArtiomTr/jest-coverage-report-action@v2
+        with:
+          test-script: npm run test-coverage

.gitignore

@@ -31,6 +31,7 @@ public/assets/
 .env.*
 playwright-report
 test-results
+coverage
 
 # local fixtures, everyone should generate their own
 tests/fixtures/development.json

jest.config.js

@@ -1,16 +1,18 @@
 /** @type {import('jest').Config} */
 export default {
-  extensionsToTreatAsEsm: [".svelte"],
+  extensionsToTreatAsEsm: [".svelte", ".ts"],
   moduleNameMapper: {
     "^@/(.*)$": "<rootDir>/$1",
   },
-  moduleFileExtensions: ["js", "svelte"],
+  moduleFileExtensions: ["js", "ts", "svelte"],
   rootDir: "src",
   setupFiles: ["dotenv/config"],
   testEnvironment: "jsdom",
   transform: {
     "^.+\\.svelte$": ["svelte-jester", { preprocess: true }],
+    "^.+\\.ts$": ["ts-jest", { useESM: true }],
   },
-
   transformIgnorePatterns: ["/node_modules/(?!svue).+\\.js$"],
+  collectCoverageFrom: ["./**/*.{js,ts,svelte}"],
+  coverageReporters: ["html", "text-summary"],
 };

package.json

@@ -65,6 +65,7 @@
     "@storybook/svelte": "^7.6.4",
     "@storybook/svelte-webpack5": "^7.6.4",
     "@storybook/testing-library": "^0.2.2",
+    "@types/lucene": "^2.1.7",
     "chromatic": "^9.1.0",
     "eslint": "^7.32.0",
     "jest": "^29.6.3",
@@ -81,7 +82,8 @@
     "storybook": "7.6.4",
     "storybook-mock-date-decorator": "^1.0.1",
     "svelte-jester": "^3.0.0",
-    "tape": "^5.7.2"
+    "tape": "^5.7.2",
+    "ts-jest": "^29.1.2"
   },
   "scripts": {
     "build": "webpack",
@@ -97,7 +99,8 @@
     "serve": "serve public -l 80 --single",
     "storybook": "storybook dev -p 6006",
     "test": "NODE_OPTIONS=--experimental-vm-modules jest",
-    "test-watch": "jest --watchAll",
+    "test-watch": "NODE_OPTIONS=--experimental-vm-modules jest --watchAll",
+    "test-coverage": "NODE_OPTIONS=--experimental-vm-modules jest --coverage",
     "test:browser": "playwright test",
     "watch": "concurrently npm:serve npm:dev-embed npm:watch-app",
     "watch-app": "cross-env NODE_ENV=development webpack watch --config webpack.app.config.js"

src/api/test/fixtures/empty.ts

@@ -1,4 +1,4 @@
-import { Page } from "../types/common";
+import type { Page } from "../../types/common";
 
 export const emptyList: Page<never> = {
   count: 0,

src/api/test/fixtures/project.ts

@@ -1,5 +1,5 @@
-import { Page } from "../types/common";
-import { Project } from "../types/project";
+import type { Page } from "../../types/common";
+import type { Project } from "../../types/project";
 
 export const project: Project = {
   id: 200006,