chore(tests): mocha-chai migration

- https://mochajs.org
- https://www.chaijs.com

Author: unicornware

.env

@@ -4,7 +4,7 @@
 #
 # - https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/dotenv
 
-DEBUG='*,-babel*,-yarn,-eslint:*,-eslintrc:*,-lint-staged:*,-typescript-eslint*'
+DEBUG='*,-babel*,-compression,-eslint:*,-eslintrc:*,-lint-staged:*,-mocha:*,-typescript-eslint*,-yarn'
 DEBUG_COLORS=true
 GITHUB_WORKSPACE=$PWD
 NODE_ENV=development
@@ -13,7 +13,7 @@ NODE_ENV=development
 NODE_MODULES=node_modules
 NPM_TOKEN=$NPM_TOKEN_FLDV
 PAT_GPR=$PAT_GPR_FLDV
-PROJECT_CWD=$GITHUB_WORKSPACE
+[[ $GITHUB_ACTIONS ]] && PROJECT_CWD=$GITHUB_WORKSPACE
 TS_NODE_PROJECT="$PROJECT_CWD/tsconfig.json"
 
 # NODE_OPTIONS - Use ESM

.eslintignore

@@ -1,7 +1,6 @@
 # ESLint Ignore
 # https://eslint.org/docs/user-guide/configuring#ignoring-files-and-directories
 
-**/coverage/*
 **/node_modules/*
 
 .yarn/*

.eslintrc.base.cjs

@@ -73,6 +73,7 @@ module.exports = {
           'EsmLoader',
           'Exception',
           'ExceptionJSON',
+          'Mocha',
           'NodeJS',
           'PackageResolverOptions',
           'PackageResolverPath',
@@ -122,7 +123,8 @@ module.exports = {
         skipWordIfMatch: [],
         skipWords: [
           'argv',
-          'basedir',
+          'bdd',
+          'chai',
           'cjs',
           'commitlint',
           'commonjs',
@@ -136,15 +138,17 @@ module.exports = {
           'formatter',
           'loadenv',
           'mjs',
+          'mocharc',
           'msg',
           'mts',
+          'namespace',
           'ncc',
           'perf',
-          'pkgfile',
           'pnv',
           'postinstall',
           'prepack',
           'prog',
+          'redeclare',
           'stringified',
           'tgz',
           'tsc',
@@ -266,16 +270,52 @@ module.exports = {
     {
       files: ['**/*.spec.ts'],
       env: {
-        jest: true
+        mocha: true
       },
-      extends: ['plugin:jest/recommended'],
       globals: {
-        'jest/globals': true
+        after: true,
+        afterEach: true,
+        before: true,
+        beforeEach: true,
+        describe: true,
+        expect: true,
+        it: true,
+        pf: true
       },
+      plugins: ['chai-expect', 'mocha'],
       rules: {
-        'jest/no-disabled-tests': 0,
-        'jest/valid-title': 0,
-        'tree-shaking/no-side-effects-in-initialization': 0
+        '@typescript-eslint/ban-ts-comment': 0,
+        'chai-expect/missing-assertion': 2,
+        'chai-expect/no-inner-compare': 2,
+        'chai-expect/no-inner-literal': 2,
+        'chai-expect/terminating-properties': [2, { properties: [] }],
+        'mocha/handle-done-callback': [2, { ignoreSkipped: false }],
+        'mocha/max-top-level-suites': [2, { limit: 1 }],
+        'mocha/no-async-describe': 2,
+        'mocha/no-exclusive-tests': 2,
+        'mocha/no-exports': 2,
+        'mocha/no-global-tests': 2,
+        'mocha/no-hooks': 0,
+        'mocha/no-hooks-for-single-case': 0,
+        'mocha/no-identical-title': 2,
+        'mocha/no-mocha-arrows': 0,
+        'mocha/no-nested-tests': 2,
+        'mocha/no-pending-tests': 2,
+        'mocha/no-return-and-callback': 2,
+        'mocha/no-return-from-async': 2,
+        'mocha/no-setup-in-describe': 0,
+        'mocha/no-sibling-hooks': 2,
+        'mocha/no-skipped-tests': 0,
+        'mocha/no-synchronous-tests': [0, { allowed: ['async'] }],
+        'mocha/no-top-level-hooks': 2,
+        'mocha/prefer-arrow-callback': 2,
+        'mocha/valid-suite-description': [2, { pattern: '^[.#@a-z0-9].+' }],
+        'prefer-arrow-callback': 0,
+        'mocha/valid-test-description': [2, { pattern: '^should.[a-z0-9]+.*' }],
+        'tree-shaking/no-side-effects-in-initialization': 0,
+        'unicorn/consistent-function-scoping': 0,
+        'unicorn/no-array-for-each': 0,
+        'unicorn/no-useless-undefined': 0
       }
     },
     {

.github/workflows/continuous-integration.yml

@@ -56,6 +56,9 @@ jobs:
       - id: env
         name: Set environment variables
         run: node ./tools/cli/loadenv.cjs -gc=test
+      - id: check-tests
+        name: Check test suites
+        run: yarn test
       - id: check-build
         name: Check builds
         run: yarn prepack --tarball --env=test

.gitignore

@@ -71,8 +71,7 @@ jspm_packages/
 # Environment variables
 .env*.local
 
-### Jest ###
-coverage/
+### Testing ###
 **/__tests__/results.json
 
 ### TypeScript ###

.mocharc.base.cjs

@@ -0,0 +1,53 @@
+/**
+ * @file Mocha Configuration - Base
+ * @see https://mochajs.org/#command-line-usage
+ * @see https://mochajs.org/#configuration-format
+ */
+
+const PWD = process.env.PROJECT_CWD
+const TYPES = ['', 'e2e', 'functional', 'integration']
+
+/** @type {Mocha.MochaInstanceOptions} */
+const config = {
+  allowUncaught: false,
+  asyncOnly: false,
+  bail: false,
+  checkLeaks: true,
+  color: true,
+  diff: true,
+  exit: true,
+  extension: TYPES.map(type => `${type}.spec.ts`),
+  failZero: false,
+  forbidOnly: true,
+  forbidPending: false,
+  fullTrace: true,
+  globals: ['chai', 'expect'],
+  growl: !(require('is-ci') || process.env.GITHUB_ACTIONS === true),
+  ignore: ['**/coverage/*', '**/node_modules/*'],
+  inlineDiffs: true,
+  isWorker: true,
+  /** @see https://typestrong.org/ts-node/docs/recipes/mocha */
+  loader: `${PWD}/tools/loaders/esm.mjs`,
+  noHighlighting: false,
+  nodeOption: [
+    'experimental-json-modules',
+    'es-module-specifier-resolution node'
+  ],
+  parallel: true,
+  recursive: true,
+  /** @see https://github.com/stanleyhlng/mocha-multi-reporters */
+  reporter: 'mocha-multi-reporters',
+  reporterOptions: [`configFile=${PWD}/__tests__/config/reporters.json`],
+  require: [
+    `${PWD}/__tests__/config/mocha-global-fixtures.ts`,
+    `${PWD}/__tests__/config/mocha-root-hooks.ts`
+  ],
+  retries: 0,
+  sort: false,
+  spec: '{,!(coverage|node_modules)/**}/__tests__/*.spec.*',
+  timeout: 2000,
+  ui: 'bdd',
+  watch: false
+}
+
+module.exports = config

.mocharc.cjs

@@ -0,0 +1,8 @@
+/**
+ * @file Mocha Configuration - Root
+ * @see https://mochajs.org/#configuration-format
+ * @see https://github.com/mochajs/mocha/blob/master/example/config/.mocharc.js
+ */
+
+/** @type {Mocha.MochaInstanceOptions} */
+module.exports = require('./.mocharc.base.cjs')

.prettierignore

@@ -1,7 +1,6 @@
 # Prettier Ignore
 # See: https://prettier.io/docs/en/ignore.html
 
-**/coverage/*
 **/node_modules/*
 .husky/_/*
 .yarn/*

.vscode/settings.json

@@ -41,6 +41,11 @@
       "format": "svg",
       "icon": "lintstagedrc"
     },
+    {
+      "extensions": [".mocharc.base.cjs", ".mocharc.cjs"],
+      "format": "svg",
+      "icon": "mocha"
+    },
     {
       "extensions": [
         "build.json",
@@ -58,6 +63,11 @@
     }
   ],
   "vsicons.associations.folders": [
+    {
+      "extensions": ["__doubles__"],
+      "format": "svg",
+      "icon": "mock"
+    },
     {
       "extensions": ["__fixtures__", "dtos"],
       "format": "svg",

CONTRIBUTING.md

@@ -229,12 +229,14 @@ be part of your code review.
 
 ### Testing
 
-This project uses [Jest][15] as its test runner. To run _all_ the tests in this
-project, run `yarn test` from the project root.
+This project uses [Mocha][15] x [Chai][16] testing workflow.
 
-Husky is configured to run tests before every push. Use [`describe.skip`][16] or
-[`it.skip`][17] if you need to create a new issue regarding the test, or need to
-make a `wip` commit.
+- run project-level test suites: `yarn test`
+- run workspace-level test suites: `yarn test:<package.json#name-no-scope>`
+
+Husky is configured to run tests before every push. If you need to create a new
+issue regarding a test, or need to make a `wip` commit, use Mocha's [inclusive
+tests feature][17] to mark your tests or suites as pending.
 
 ### Getting Help
 
@@ -362,7 +364,7 @@ Before releasing, the following steps must be completed:
    - once the PR is merged, the deployment workflow will be triggered
    - the maintainer who approved the PR should check to make sure the workflow
      completes all jobs as expected. if successful, the workflow will:
-     - publish package to the [GitHub Package Registry][19] and
+     - publish package to the [GitHub Package Registry][18] and
      - update the production branch (merge branch `next` into `main`)
      - publish the drafted release
    - the maintainer who approved the PR should go through the PR's linked issues
@@ -385,8 +387,8 @@ Before releasing, the following steps must be completed:
 [12]: https://eslint.org
 [13]: https://jsdoc.app
 [14]: https://github.com/gajus/eslint-plugin-jsdoc
-[15]: https://jestjs.io
-[16]: https://jestjs.io/docs/api#describeskipname-fn
-[17]: https://jestjs.io/docs/api#testskipname-fn
+[15]: https://mochajs.org
+[16]: https://www.chaijs.com
+[17]: https://mochajs.org/#inclusive-tests
 [18]: https://www.conventionalcommits.org/en/v1.0.0
 [19]: https://github.com/features/packages