chore(tests): add coverage workflow

unicornware · unicornware · commit bee90a0b26b9 · 2021-11-04T20:06:11.000-04:00
- https://istanbul.js.org - https://github.com/istanbuljs/nyc - https://github.com/istanbuljs/esm-loader-hook
diff --git a/.env b/.env
@@ -4,7 +4,7 @@
 #
 # - https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/dotenv
 
-DEBUG='*,-babel*,-compression,-eslint:*,-eslintrc:*,-lint-staged:*,-mocha:*,-typescript-eslint*,-yarn'
+DEBUG='*,-babel*,-compression,-eslint:*,-eslintrc:*,-istanbuljs,-lint-staged:*,-mocha:*,-typescript-eslint*,-yarn'
 DEBUG_COLORS=true
 GITHUB_WORKSPACE=$(git rev-parse --show-toplevel)
 NODE_ENV=development
diff --git a/.eslintignore b/.eslintignore
@@ -1,6 +1,8 @@
 # ESLint Ignore
 # https://eslint.org/docs/user-guide/configuring#ignoring-files-and-directories
 
+**/.nyc/*
+**/coverage/*
 **/node_modules/*
 
 .yarn/*
diff --git a/.eslintrc.base.cjs b/.eslintrc.base.cjs
@@ -143,6 +143,7 @@ module.exports = {
           'mts',
           'namespace',
           'ncc',
+          'nycrc',
           'perf',
           'pnv',
           'ponyfill',
diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml
@@ -50,15 +50,15 @@ jobs:
       - id: check-style
         name: Check code style
         run: yarn check:style
-      # - id: check-tests
-      #   name: Check test suites
-      #   run: yarn test
       - id: env
-        name: Set build environment variables
+        name: Set environment variables
         run: node ./tools/cli/loadenv.cjs -gc=test
       - id: check-build
-        name: Check builds
-        run: yarn prepack --tarball --env=test
+        name: Check build
+        run: yarn prepack -te=test
+      - id: test
+        name: Run test suites
+        run: yarn test:ci
       - id: env-post
-        name: Post Set build environment variables
+        name: Post Set environment variables
         run: echo "NODE_OPTIONS=''" >> $GITHUB_ENV
diff --git a/.gitignore b/.gitignore
@@ -72,6 +72,8 @@ jspm_packages/
 .env*.local
 
 ### Testing ###
+**/.nyc/
+**/coverage/
 **/__tests__/results.json
 
 ### TypeScript ###
diff --git a/.nycrc b/.nycrc
@@ -0,0 +1,3 @@
+{
+  "extends": "./.nycrc.base"
+}
diff --git a/.nycrc.base b/.nycrc.base
@@ -0,0 +1,9 @@
+{
+  "all": false,
+  "cache": false,
+  "exclude": ["**/__tests__/*", "**/index.ts", "*.fixture.ts", "*.spec.ts"],
+  "extension": [".ts"],
+  "reporter": ["lcov", "text"],
+  "skip-full": false,
+  "temp-dir": "./.nyc"
+}
diff --git a/.prettierignore b/.prettierignore
@@ -1,6 +1,8 @@
 # Prettier Ignore
 # See: https://prettier.io/docs/en/ignore.html
 
+**/.nyc/*
+**/coverage/*
 **/node_modules/*
 .husky/_/*
 .yarn/*
diff --git a/.prettierrc.cjs b/.prettierrc.cjs
@@ -20,14 +20,20 @@ module.exports = {
   trailingComma: 'none',
   overrides: [
     {
-      files: ['*.cts', '*.mts'],
+      files: ['**/*.cts', '**/*.mts'],
       options: {
         parser: 'typescript'
       }
     },
+    {
+      files: ['**/.nycrc*'],
+      options: {
+        parser: 'json'
+      }
+    },
     {
       files: [
-        '*.sh',
+        '**/*.sh',
         '.husky/commit-msg',
         '.husky/pre-commit',
         '.husky/pre-push'
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -10,6 +10,7 @@
     "*.d.cts": "typescript",
     "*.d.mts": "typescript",
     ".env*": "shellscript",
+    ".nycrc*": "json",
     "commit-msg": "shellscript",
     "pre-commit": "shellscript",
     "pre-push": "shellscript"
@@ -46,6 +47,11 @@
       "format": "svg",
       "icon": "mocha"
     },
+    {
+      "extensions": [".nycrc.base", ".nycrc.react"],
+      "format": "svg",
+      "icon": "nyc"
+    },
     {
       "extensions": [
         "build.json",
diff --git a/__tests__/config/reporters.json b/__tests__/config/reporters.json
@@ -2,5 +2,5 @@
   "mochajsJsonFileReporterReporterOptions": {
     "output": "__tests__/results.json"
   },
-  "reporterEnabled": "spec, @mochajs/json-file-reporter"
+  "reporterEnabled": "spec,@mochajs/json-file-reporter"
 }
diff --git a/package.json b/package.json
@@ -22,7 +22,7 @@
     "bootstrap": ". ./.env && yarn prepack",
     "postinstall": "is-ci || chmod +x .husky/* && husky install",
     "prepack": "yarn workspaces foreach -iv --topological-dev run prepack",
-    "check:ci": "yarn check:types && yarn fix:format && yarn fix:style && yarn test && yarn build --tarball && rimraf packages/*/*.tgz",
+    "check:ci": "yarn check:types && yarn fix:format && yarn fix:style && yarn test && yarn build --tarball && rimraf ./*/*/*.tgz",
     "check:dedupe": "yarn dedupe --check",
     "check:format": "prettier --check .",
     "check:install": "yarn dlx @yarnpkg/doctor .",
@@ -33,6 +33,7 @@
     "fix:format": "prettier --write .",
     "fix:style": "yarn check:style --fix --cache",
     "test": "bash tools/scripts/mocha.sh",
+    "test:ci": "yarn test --no-growl --no-parallel --sort",
     "test:aggregate-error-ponyfill": "yarn workspace @flex-development/aggregate-error-ponyfill test",
     "test:coverage": "yarn workspace @flex-development/$0 test:coverage",
     "test:exceptions": "yarn workspace @flex-development/exceptions test",
@@ -50,6 +51,7 @@
     "@flex-development/log": "4.0.1-dev.0",
     "@flex-development/trext": "2.0.4",
     "@flex-development/tutils": "4.2.3",
+    "@istanbuljs/esm-loader-hook": "0.1.2",
     "@mochajs/json-file-reporter": "1.3.0",
     "@packages": "link:packages",
     "@types/chai": "4.2.22",
@@ -64,6 +66,7 @@
     "@typescript-eslint/eslint-plugin": "5.3.0",
     "@typescript-eslint/parser": "5.3.0",
     "@vercel/ncc": "0.31.1",
+    "babel-plugin-istanbul": "6.1.1",
     "chai": "4.3.4",
     "chalk": "4.1.2",
     "concurrently": "6.3.0",
@@ -91,6 +94,7 @@
     "lodash.merge": "4.6.2",
     "mocha": "9.1.3",
     "mocha-multi-reporters": "1.5.1",
+    "nyc": "15.1.0",
     "prettier": "2.4.1",
     "prettier-plugin-sh": "0.7.1",
     "pretty-format": "27.3.1",
diff --git a/packages/aggregate-error-ponyfill/.nycrc b/packages/aggregate-error-ponyfill/.nycrc
@@ -0,0 +1,5 @@
+{
+  "extends": "../../.nycrc.base",
+  "include": ["src"],
+  "report-dir": "./coverage"
+}
diff --git a/packages/aggregate-error-ponyfill/package.json b/packages/aggregate-error-ponyfill/package.json
@@ -83,6 +83,7 @@
     "chai": "4.3.4",
     "mocha": "9.1.3",
     "mocha-multi-reporters": "1.5.1",
+    "nyc": "15.1.0",
     "serve": "12.0.1",
     "ts-node": "10.4.0",
     "typescript": "4.5.0-beta"
diff --git a/packages/exceptions/.nycrc b/packages/exceptions/.nycrc
@@ -0,0 +1,5 @@
+{
+  "extends": "../../.nycrc.base",
+  "include": ["src"],
+  "report-dir": "./coverage"
+}
diff --git a/packages/exceptions/package.json b/packages/exceptions/package.json
@@ -122,6 +122,7 @@
     "firebase-admin": "10.0.0",
     "mocha": "9.1.3",
     "mocha-multi-reporters": "1.5.1",
+    "nyc": "15.1.0",
     "serve": "12.0.1",
     "ts-node": "10.4.0",
     "typescript": "4.5.0-beta"
diff --git a/tools/loaders/esm.mjs b/tools/loaders/esm.mjs
@@ -1,3 +1,4 @@
+import * as istanbul from '@istanbuljs/esm-loader-hook'
 import path from 'node:path'
 import { createMatchPath, loadConfig } from 'tsconfig-paths'
 import pkg from '../../package.json'
@@ -10,6 +11,8 @@ import pkg from '../../package.json'
  * @see https://nodejs.org/docs/latest-v12.x/api/all.html#esm_hooks
  */
 
+const TEST = process.env.NODE_ENV === 'test'
+
 /**
  * Determines if `url` should be interpreted as a CommonJS or ES module.
  *
@@ -83,4 +86,11 @@ export const resolve = async (specifier, ctx, fn) => {
  * @param {EsmLoader.Hooks.TransformSource} fn - Default transform fn
  * @return {Promise<EsmLoader.HookResult.TransformSource>} Source code
  */
-export const transformSource = hooks.transformSource
+export const transformSource = async (source, ctx, fn) => {
+  source = (await hooks.transformSource(source, ctx, fn)).source
+
+  /** @see https://github.com/istanbuljs/esm-loader-hook */
+  if (TEST) source = (await istanbul.transformSource(source, ctx, fn)).source
+
+  return { source }
+}
diff --git a/tools/scripts/mocha.sh b/tools/scripts/mocha.sh
@@ -4,15 +4,20 @@
 #
 # References:
 #
+# - https://github.com/istanbuljs/nyc
 # - https://github.com/piotrwitek/ts-mocha
 # - https://mochajs.org/#command-line-usage
 
 # 1. Load default environment variables
-. $GITHUB_WORKSPACE/.env
+# . $GITHUB_WORKSPACE/.env
 
 # 2. Set test environment variables
 export NODE_ENV=test
 export TS_NODE_PROJECT="$GITHUB_WORKSPACE/tsconfig.test.json"
 
-# 3. Run test suites
-ts-mocha $@
+# 3. Remove coverage output
+rimraf $GITHUB_WORKSPACE/.nyc/ $GITHUB_WORKSPACE/coverage/
+rimraf $GITHUB_WORKSPACE/*/*/.nyc/ $GITHUB_WORKSPACE/*/*/coverage/
+
+# 4. Run test suites
+nyc ts-mocha $@
diff --git a/tsconfig.test.json b/tsconfig.test.json
@@ -1,4 +1,6 @@
 {
-  "compilerOptions": {},
+  "compilerOptions": {
+    "inlineSourceMap": true
+  },
   "extends": "./tsconfig.json"
 }
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`#`
`5`	`5`	`# - https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/dotenv`
`6`	`6`
`7`		`-DEBUG=',-babel,-compression,-eslint:,-eslintrc:,-lint-staged:,-mocha:,-typescript-eslint*,-yarn'`
	`7`	`+DEBUG=',-babel,-compression,-eslint:,-eslintrc:,-istanbuljs,-lint-staged:,-mocha:,-typescript-eslint*,-yarn'`
`8`	`8`	`DEBUG_COLORS=true`
`9`	`9`	`GITHUB_WORKSPACE=$(git rev-parse --show-toplevel)`
`10`	`10`	`NODE_ENV=development`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "extends": "./.nycrc.base"`
	`3`	`+}`