chore: switch testing over to ava

Author: RebeccaStevens

.eslintrc.json

@@ -6,7 +6,6 @@
     "eslint-plugin",
     "functional",
     "import",
-    "jest",
     "jsdoc",
     "prettier"
   ],
@@ -30,7 +29,7 @@
   "ignorePatterns": ["build/", "coverage/", "lib/"],
   "rules": {
     "@typescript-eslint/no-unnecessary-condition": "off",
-    "import/no-unassigned-import": "off",
+    "import/no-relative-parent-imports": "error",
     "node/no-unsupported-features/es-builtins": "off",
     "node/no-unsupported-features/es-syntax": "off",
     // enable once supported in all our supported node versions.

.github/workflows/ci.yml

@@ -59,23 +59,18 @@ jobs:
     runs-on: ${{ matrix.os }}
     continue-on-error: ${{ matrix.ts_version == 'next' }}
     env:
-      # Use compiled tests on everything instances except this one.
-      USE_COMPILED_TEST: ${{ fromJSON('["false", "true"]')[matrix.ts_version != 'latest' || matrix.node_version != '16' || matrix.os != 'ubuntu-latest'] }}
+      REPORT_COVERAGE: ${{ fromJSON('["false", "true"]')[matrix.ts_version == 'latest' && matrix.node_version == '16' && matrix.os != 'ubuntu-latest'] }}
     steps:
       - name: Checkout
         uses: actions/checkout@v2
         with:
           # Fetch all commits for codecov.
-          fetch-depth: ${{ fromJSON('[0, 1]')[ env.USE_COMPILED_TEST == 'true'] }}
+          fetch-depth: ${{ fromJSON('[0, 1]')[ env.REPORT_COVERAGE == 'true'] }}
 
-      - name: Setup NodeJs
+      - name: Setup NodeJs for building
         uses: actions/setup-node@v1
         with:
-          node-version: ${{ matrix.node_version }}
-
-      # Remove dev-dependencies that aren't needed for testing and aren't compatable with all node versions being tested against.
-      - name: Remove unneeded incompatible dev-dependencies
-        run: yarn remove @rebeccastevens/eslint-config
+          node-version: "16"
 
       - name: Install Dependencies
         run: yarn install --frozen-lockfile
@@ -84,26 +79,28 @@ jobs:
         run: yarn build
 
       - name: Compile Tests
-        if: env.USE_COMPILED_TEST == 'true'
+        if: env.REPORT_COVERAGE == 'false'
         run: yarn compile-tests
 
+      - name: Setup NodeJs ${{ matrix.node_version }} for testing
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node_version }}
+
       - name: Remove Dev TypeScript
-        run: yarn remove typescript
+        run: yarn remove typescript --ignore-engines
 
       - name: Add TypeScript "${{ matrix.ts_version }}"
         if: matrix.ts_version != 'JS'
-        run: yarn add -D typescript@"${{ matrix.ts_version }}"
+        run: yarn add -D typescript@"${{ matrix.ts_version }}" --ignore-engines
 
-      - name: Run Tests (Uncompiled)
-        if: env.USE_COMPILED_TEST != 'true'
+      - name: Run Tests
         run: yarn test
-
-      - name: Run Tests (Compiled)
-        if: env.USE_COMPILED_TEST == 'true'
-        run: yarn test-compiled
+        env:
+          USE_COMPILED_TESTS: ${{ env.REPORT_COVERAGE == 'false' }}
 
       - name: Report coverage
         uses: codecov/codecov-action@v1
-        if: env.USE_COMPILED_TEST != 'true'
+        if: env.REPORT_COVERAGE == 'true'
         with:
           file: coverage/lcov.info

.gitignore

@@ -1,7 +1,7 @@
 .DS_Store
 thumbs.db
 *.log
-.rpt2_cache/
+.nyc_output/
 node_modules/
 /build/
 /lib/

.nycrc

@@ -0,0 +1,20 @@
+{
+  "extends": "@istanbuljs/nyc-config-typescript",
+  "include": [
+    "src/**/*"
+  ],
+  "exclude": [
+    "src/util/conditional-imports/**/*"
+  ],
+  "reporter": [
+    "lcov",
+    "text"
+  ],
+  "check-coverage": false,
+  "watermarks": {
+    "lines": [80, 95],
+    "functions": [80, 95],
+    "branches": [80, 95],
+    "statements": [80, 95]
+  }
+}

.vscode/settings.json

@@ -1,12 +1,12 @@
 {
   "files.exclude": {
-    ".rpt2_cache": true,
+    ".nyc_output": true,
     "coverage": true,
   },
   "files.trimTrailingWhitespace": true,
   "search.exclude": {
     "**/.git/": true,
-    "**/.rpt2_cache/": true,
+    "**/.nyc_output/": true,
     "**/yarn.lock": true,
     ".vscode/": true,
     "build/": true,

ava.config.js

@@ -0,0 +1,42 @@
+// @ts-check
+
+/**
+ * Get the intended boolean value from the given string.
+ */
+function getBoolean(value) {
+  if (value === undefined) {
+    return false;
+  }
+  const asNumber = Number(value);
+  return Number.isNaN(asNumber)
+    ? Boolean(String(value).toLowerCase().replace("false", ""))
+    : Boolean(asNumber);
+}
+
+const useCompiledTests = getBoolean(process.env.USE_COMPILED_TESTS);
+
+const avaCommonConfig = {
+  files: ["tests/**/!(_)*.test.*"],
+  timeout: "5m",
+};
+
+const avaTsConfig = {
+  ...avaCommonConfig,
+  extensions: ["ts"],
+  require: ["ts-node/register", "tsconfig-paths/register"],
+  environmentVariables: {
+    TS_NODE_PROJECT: "tests/tsconfig.json",
+  },
+};
+
+const avaJsConfig = {
+  ...avaCommonConfig,
+  files: avaCommonConfig.files.map((file) => `build/${file}`),
+  extensions: ["js"],
+  require: ["tsconfig-paths/register"],
+  environmentVariables: {
+    TS_NODE_PROJECT: "build/tests/tsconfig.json",
+  },
+};
+
+export default useCompiledTests ? avaJsConfig : avaTsConfig;

jest.config.js

@@ -46,13 +46,12 @@
     "prebuild-tests": "rimraf build",
     "build-tests": "yarn compile-tests",
     "compile": "rollup -c",
-    "compile-tests": "tsc -p tests/tsconfig.json && cpx ./tests/helpers/tsconfig.json ./build/tests/helpers/",
+    "compile-tests": "ts-node -P scripts/tsconfig.json scripts/compile-tests.ts",
     "prelint": "yarn build && yarn link && yarn link 'eslint-plugin-functional'",
     "lint": "eslint .",
     "lint-fix": "yarn lint --fix",
-    "test": "jest --testPathIgnorePatterns _work.test",
-    "test-compiled": "cross-env USE_COMPLIED=1 yarn test",
-    "test-work": "jest tests/rules/_work.test.ts --no-coverage",
+    "test": "nyc ava",
+    "test-work": "ava 'tests/rules/_work.test.ts'",
     "verify": "yarn build && yarn lint && yarn build-tests && yarn test-compiled && rimraf build",
     "preversion": "yarn verify",
     "version": "auto-changelog -p && git add CHANGELOG.md",
@@ -64,6 +63,7 @@
     "escape-string-regexp": "^4.0.0"
   },
   "devDependencies": {
+    "@istanbuljs/nyc-config-typescript": "^1.0.1",
     "@rebeccastevens/eslint-config": "^1.0.10",
     "@rollup/plugin-commonjs": "^17.0.0",
     "@rollup/plugin-json": "^4.1.0",
@@ -73,24 +73,24 @@
     "@types/eslint": "^7.2.6",
     "@types/estree": "^0.0.46",
     "@types/glob": "^7.1.1",
-    "@types/jest": "^26.0.19",
     "@types/node": "15.0.1",
     "@types/rollup-plugin-auto-external": "^2.0.2",
     "@typescript-eslint/eslint-plugin": "^4.28.4",
     "@typescript-eslint/parser": "^4.28.4",
     "auto-changelog": "^2.2.1",
+    "ava": "^3.15.0",
     "babel-eslint": "^10.0.2",
     "codecov": "^3.8.1",
-    "cpx": "^1.5.0",
     "cross-env": "^7.0.3",
     "dedent": "^0.7.0",
     "eslint": "^7.31.0",
+    "eslint-ava-rule-tester": "^4.0.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-import-resolver-typescript": "^2.4.0",
+    "eslint-plugin-ava": "^12.0.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-eslint-plugin": "^3.4.0",
     "eslint-plugin-import": "^2.23.4",
-    "eslint-plugin-jest": "^24.4.0",
     "eslint-plugin-jsdoc": "^35.5.1",
     "eslint-plugin-markdown": "^2.2.0",
     "eslint-plugin-node": "^11.1.0",
@@ -102,16 +102,17 @@
     "espree": "^8.0.0",
     "glob": "^7.1.6",
     "husky": "^6.0.0",
-    "jest": "^26.6.3",
     "json-schema": "^0.3.0",
+    "jsonc-parser": "^3.0.0",
     "lint-staged": "^10.5.3",
+    "nyc": "^15.1.0",
     "prettier": "^2.2.1",
     "rimraf": "^3.0.0",
     "rollup": "^2.34.2",
     "rollup-plugin-auto-external": "^2.0.0",
     "shelljs": "^0.8.3",
-    "ts-jest": "^26.4.4",
     "ts-node": "^10.1.0",
+    "tsc-prog": "^2.2.1",
     "tsconfig-paths": "^3.10.1",
     "tslib": "^2.0.3",
     "typescript": "^4.1.3"

package.json

@@ -0,0 +1,5 @@
+{
+  "rules": {
+    "node/no-unsupported-features/node-builtins": "off"
+  }
+}

scripts/.eslintrc.json

@@ -0,0 +1,62 @@
+import { promises as fs } from "fs";
+import * as JSONC from "jsonc-parser";
+import * as tsc from "tsc-prog";
+
+/**
+ * The script.
+ */
+async function run() {
+  transpileTests();
+  await Promise.all([createTestsTsConfig(), createTestsHelpersTsConfig()]);
+}
+
+/**
+ * Transpile the tests.
+ */
+function transpileTests() {
+  const program = tsc.createProgramFromConfig({
+    basePath: `${process.cwd()}/tests`,
+    configFilePath: "tsconfig.json",
+  });
+
+  tsc.emit(program, {
+    clean: { outDir: true },
+  });
+}
+
+/**
+ * Create a suitable "build/tests/tsconfig.json" file.
+ */
+async function createTestsTsConfig() {
+  const testsTsConfig = JSONC.parse(
+    await fs.readFile("tests/tsconfig.json", { encoding: "utf-8" })
+  );
+
+  const updatedTestsTsConfig = {
+    ...testsTsConfig,
+    extends: `../${testsTsConfig.extends}`,
+    compilerOptions: {
+      ...testsTsConfig.compilerOptions,
+      baseUrl: "..",
+    },
+  };
+
+  return fs.writeFile(
+    "build/tests/tsconfig.json",
+    JSON.stringify(updatedTestsTsConfig, null, 2),
+    { encoding: "utf-8" }
+  );
+}
+
+/**
+ * Create a suitable "build/tests/helpers/tsconfig.json" file.
+ */
+async function createTestsHelpersTsConfig() {
+  return fs.copyFile(
+    "tests/helpers/tsconfig.json",
+    "build/tests/helpers/tsconfig.json"
+  );
+}
+
+// Run the script.
+run().catch((error) => void console.error(error));

scripts/compile-tests.ts

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "target": "ES2018",
+    "module": "CommonJS",
+    "lib": ["esnext"],
+    "alwaysStrict": true,
+    "strict": true,
+    "esModuleInterop": true,
+    "moduleResolution": "node",
+    "noImplicitAny": false,
+    "noImplicitReturns": true,
+    "noImplicitThis": true,
+    "allowSyntheticDefaultImports": true,
+    "resolveJsonModule": true,
+    "forceConsistentCasingInFileNames": true,
+    "importHelpers": false,
+    "newLine": "LF",
+    "noEmitOnError": true,
+    "removeComments": true
+  }
+}