chore: add test coverage testing with Codecov (#79)

JoshuaKGoldberg · web-flow · commit 54e330bda4c8 · 2022-12-05T22:33:23.000-05:00
* chore: add test coverage testing with Codecov

* Add lcov to cspell.json words

* Add vitest/coverage-c8 package
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -12,4 +12,8 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - uses: ./.github/actions/prepare
-      - run: pnpm test
+      - run: pnpm run test --coverage
+      - name: Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,3 @@
+coverage/
 dist/
 node_modules/
diff --git a/.npmignore b/.npmignore
@@ -1,3 +1,4 @@
 .github/
 .vscode/
 *.test.*
+coverage/
diff --git a/.ts-prunerc b/.ts-prunerc
@@ -1,4 +1,4 @@
 {
 	"error": true,
-	"skip": "src/index.ts"
+	"skip": "(src/index\\.ts|vitest\\.config\\.ts)"
 }
diff --git a/cspell.json b/cspell.json
@@ -1,5 +1,5 @@
 {
 	"dictionaries": ["typescript"],
 	"ignorePaths": [".github", "dist", "node_modules", "pnpm-lock.yaml"],
-	"words": ["commitlint"]
+	"words": ["commitlint", "lcov"]
 }
diff --git a/package.json b/package.json
@@ -10,6 +10,7 @@
 		"@semantic-release/release-notes-generator": "^10.0.3",
 		"@typescript-eslint/eslint-plugin": "^5.38.1",
 		"@typescript-eslint/parser": "^5.38.1",
+		"@vitest/coverage-c8": "^0.25.4",
 		"cspell": "^6.12.0",
 		"eslint": "^8.24.0",
 		"eslint-config-prettier": "^8.5.0",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/vitest.config.ts b/vitest.config.ts
@@ -0,0 +1,9 @@
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+	test: {
+		coverage: {
+			reporter: ["html", "lcov"],
+		},
+	},
+});

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
	`1`	`+coverage/`
`1`	`2`	`dist/`
`2`	`3`	`node_modules/`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`{`
`2`	`2`	`"error": true,`
`3`		`- "skip": "src/index.ts"`
	`3`	`+ "skip": "(src/index\\.ts\|vitest\\.config\\.ts)"`
`4`	`4`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`	`2`	`"dictionaries": ["typescript"],`
`3`	`3`	`"ignorePaths": [".github", "dist", "node_modules", "pnpm-lock.yaml"],`
`4`		`- "words": ["commitlint"]`
	`4`	`+ "words": ["commitlint", "lcov"]`
`5`	`5`	`}`