Fix eslint-plugin-khan tests so that they can be run using jest (#1090)

## Summary: #1085 caused an issue where tests were only running for one of the eslint plugin rules. Thanks @beaesguerra for noticing this. This PR updates our testing setup so that we can use jest to run the eslint-plugin-khan tests instead of mocha. It also fixes a few failures that are due to changes in eslint and RuleTester's behaviour. Issue: None ## Test plan: - yarn test Author: kevinb-khan Reviewers: jeresig, kevinb-khan Required Reviewers: Approved By: jeresig Checks: ✅ Test (macos-latest, 20.x), ✅ codecov/project, ✅ CodeQL, ✅ Lint, typecheck, and coverage check (ubuntu-latest, 20.x), ✅ Analyze (javascript), ✅ Prime node_modules cache for primary configuration (ubuntu-latest, 20.x), ✅ gerald, ⏭️ dependabot Pull Request URL: #1090
Khan · Dec 9, 2024 · 4cba5ba · 4cba5ba
1 parent 919c72c
commit 4cba5ba
Show file tree

Hide file tree

Showing 16 changed files with 197 additions and 257 deletions.
diff --git a/.changeset/rotten-spiders-hear.md b/.changeset/rotten-spiders-hear.md
@@ -0,0 +1,2 @@
+---
+---
diff --git a/.github/workflows/node-ci.yml b/.github/workflows/node-ci.yml
@@ -183,7 +183,3 @@ jobs:
         full: yarn test
         limited-trigger: ${{ steps.js-ts-files.outputs.filtered }}
         limited: yarn test --findRelatedTests --passWithNoTests {}
-
-    - name: Mocha (eslint-plugin-khan)
-      working-directory: ./packages/eslint-plugin-khan
-      run: yarn test
diff --git a/config/jest/test-setup.js b/config/jest/test-setup.js
@@ -1 +1,8 @@
-// No setup to perform
+// Adapted from https://typescript-eslint.io/packages/rule-tester/#vitest
+import {afterAll, it, describe} from "@jest/globals";
+import {RuleTester} from "@typescript-eslint/rule-tester";
+
+RuleTester.afterAll = afterAll;
+RuleTester.describe = describe;
+RuleTester.it = it;
+RuleTester.itOnly = it.only;
diff --git a/config/jest/test.config.js b/config/jest/test.config.js
@@ -14,7 +14,6 @@ module.exports = {
     resetMocks: true,
     testEnvironment: "jest-environment-node",
     testMatch: ["<rootDir>/**/*.test.ts"],
-    testPathIgnorePatterns: ["/eslint-plugin-khan/"],
     setupFilesAfterEnv: [
         "jest-extended/all",
         "<rootDir>/config/jest/test-setup.js",

diff --git a/packages/eslint-plugin-khan/package.json b/packages/eslint-plugin-khan/package.json
@@ -21,13 +21,11 @@
     "@swc-node/register": "^1.6.8",
     "@swc/core": "^1.3.93",
     "eslint": "^8.52.0",
-    "mocha": "^10.2.0",
     "prettier": "^2.8.8",
     "pretty-quick": "^3.1.3"
   },
   "scripts": {
-    "prettier": "prettier --write '{lib,test}/**/*.{js,ts}'",
-    "test": "mocha"
+    "prettier": "prettier --write '{lib,test}/**/*.{js,ts}'"
   },
   "dependencies": {
     "@babel/types": "^7.23.0",

diff --git a/packages/eslint-plugin-khan/test/rules/array-type-style.test.ts b/packages/eslint-plugin-khan/test/rules/array-type-style.test.ts
@@ -1,12 +1,19 @@
+import {RuleTester} from "@typescript-eslint/rule-tester";
+
 import {rules} from "../../src/index";
-import {RuleTester} from "../RuleTester";
 
 const ruleTester = new RuleTester({
-    parser: "@typescript-eslint/parser",
-    parserOptions: {
-        ecmaVersion: 6,
-        sourceType: "module",
-        ecmaFeatures: {},
+    languageOptions: {
+        parserOptions: {
+            ecmaVersion: 6,
+            sourceType: "module",
+            ecmaFeatures: {},
+        },
+    },
+    linterOptions: {
+        // NOTE(kevinb): Avoids 'TypeError: Expected a Boolean' error
+        // when running the tests.
+        reportUnusedDisableDirectives: true,
     },
 });
 
@@ -30,9 +37,10 @@ ruleTester.run(ruleName, rule, {
             // Two errors are reported because there are two array types,
             // they just happen to be nested.
             errors: [{messageId: "errorString"}, {messageId: "errorString"}],
-            // This is a partial fix.  Multiple runs of eslint --fix are needed
-            // to fix nested (in the AST) array types completely.
-            output: "type foo = { bar: Array<number>[] }",
+            output: [
+                "type foo = { bar: Array<number>[] }",
+                "type foo = { bar: Array<Array<number>> }",
+            ],
         },
     ],
 });
diff --git a/packages/eslint-plugin-khan/test/rules/jest-async-use-real-timers.test.ts b/packages/eslint-plugin-khan/test/rules/jest-async-use-real-timers.test.ts
@@ -1,12 +1,19 @@
+import {RuleTester} from "@typescript-eslint/rule-tester";
+
 import {rules} from "../../src/index";
-import {RuleTester} from "../RuleTester";
 
 const ruleTester = new RuleTester({
-    parser: "@typescript-eslint/parser",
-    parserOptions: {
-        ecmaVersion: 6,
-        sourceType: "module",
-        ecmaFeatures: {},
+    languageOptions: {
+        parserOptions: {
+            ecmaVersion: 6,
+            sourceType: "module",
+            ecmaFeatures: {},
+        },
+    },
+    linterOptions: {
+        // NOTE(kevinb): Avoids 'TypeError: Expected a Boolean' error
+        // when running the tests.
+        reportUnusedDisableDirectives: true,
     },
 });
 

diff --git a/packages/eslint-plugin-khan/test/rules/jest-await-async-matchers.test.ts b/packages/eslint-plugin-khan/test/rules/jest-await-async-matchers.test.ts
@@ -1,12 +1,19 @@
+import {RuleTester} from "@typescript-eslint/rule-tester";
+
 import {rules} from "../../src/index";
-import {RuleTester} from "../RuleTester";
 
 const ruleTester = new RuleTester({
-    parser: "@typescript-eslint/parser",
-    parserOptions: {
-        ecmaVersion: 6,
-        sourceType: "module",
-        ecmaFeatures: {},
+    languageOptions: {
+        parserOptions: {
+            ecmaVersion: 6,
+            sourceType: "module",
+            ecmaFeatures: {},
+        },
+    },
+    linterOptions: {
+        // NOTE(kevinb): Avoids 'TypeError: Expected a Boolean' error
+        // when running the tests.
+        reportUnusedDisableDirectives: true,
     },
 });
 
@@ -85,14 +92,6 @@ ruleTester.run("jest-await-async-matchers", rule, {
             ],
             output: 'await expect(promise).rejects.not.toThrow(new Error("foo"));',
         },
-        {
-            code: `expect(promise).resolves.not.toBe(true);`,
-
-            errors: [
-                {messageId: "asyncMatchers", data: {matchers: ["resolves"]}},
-            ],
-            output: "await expect(promise).resolves.not.toBe(true);",
-        },
         {
             code: `expect(promise).toResolve();`,
 

diff --git a/packages/eslint-plugin-khan/test/rules/jest-enzyme-matchers.test.js b/packages/eslint-plugin-khan/test/rules/jest-enzyme-matchers.test.js
@@ -1,12 +1,22 @@
-import {RuleTester} from "eslint";
+import {RuleTester} from "@typescript-eslint/rule-tester";
 
 import {rules} from "../../src/index";
 
-const parserOptions = {
-    parser: require.resolve("@babel/eslint-parser"),
-};
+const ruleTester = new RuleTester({
+    languageOptions: {
+        parserOptions: {
+            ecmaVersion: 6,
+            sourceType: "module",
+            ecmaFeatures: {},
+        },
+    },
+    linterOptions: {
+        // NOTE(kevinb): Avoids 'TypeError: Expected a Boolean' error
+        // when running the tests.
+        reportUnusedDisableDirectives: true,
+    },
+});
 
-const ruleTester = new RuleTester(parserOptions);
 const rule = rules["jest-enzyme-matchers"];
 
 ruleTester.run("jest-real-timers", rule, {

diff --git a/packages/eslint-plugin-khan/test/rules/no-one-tuple.test.ts b/packages/eslint-plugin-khan/test/rules/no-one-tuple.test.ts
@@ -1,12 +1,19 @@
+import {RuleTester} from "@typescript-eslint/rule-tester";
+
 import {rules} from "../../src/index";
-import {RuleTester} from "../RuleTester";
 
 const ruleTester = new RuleTester({
-    parser: "@typescript-eslint/parser",
-    parserOptions: {
-        ecmaVersion: 6,
-        sourceType: "module",
-        ecmaFeatures: {},
+    languageOptions: {
+        parserOptions: {
+            ecmaVersion: 6,
+            sourceType: "module",
+            ecmaFeatures: {},
+        },
+    },
+    linterOptions: {
+        // NOTE(kevinb): Avoids 'TypeError: Expected a Boolean' error
+        // when running the tests.
+        reportUnusedDisableDirectives: true,
     },
 });
 
@@ -33,9 +40,10 @@ ruleTester.run(ruleName, rule, {
             // Two errors are reported because there are two one-tuples,
             // they just happen to be nested.
             errors: [{messageId: "errorString"}, {messageId: "errorString"}],
-            // This is a partial fix.  Multiple runs of eslint --fix are needed
-            // to fix nested 1-tuples completely.
-            output: "type foo = { bar: Array<[number]> }",
+            output: [
+                "type foo = { bar: Array<[number]> }",
+                "type foo = { bar: Array<Array<number>> }",
+            ],
         },
     ],
 });
diff --git a/packages/eslint-plugin-khan/test/rules/react-no-method-jsx-attribute.test.ts b/packages/eslint-plugin-khan/test/rules/react-no-method-jsx-attribute.test.ts
@@ -1,15 +1,22 @@
+import {RuleTester} from "@typescript-eslint/rule-tester";
+
 import {rules} from "../../src/index";
-import {RuleTester} from "../RuleTester";
 
 const ruleTester = new RuleTester({
-    parser: "@typescript-eslint/parser",
-    parserOptions: {
-        ecmaVersion: 6,
-        sourceType: "module",
-        ecmaFeatures: {
-            jsx: true,
+    languageOptions: {
+        parserOptions: {
+            ecmaVersion: 6,
+            sourceType: "module",
+            ecmaFeatures: {
+                jsx: true,
+            },
         },
     },
+    linterOptions: {
+        // NOTE(kevinb): Avoids 'TypeError: Expected a Boolean' error
+        // when running the tests.
+        reportUnusedDisableDirectives: true,
+    },
 });
 
 const ruleName = "react-no-method-jsx-attribute";

diff --git a/packages/eslint-plugin-khan/test/rules/react-no-subscriptions-before-mount.test.ts b/packages/eslint-plugin-khan/test/rules/react-no-subscriptions-before-mount.test.ts
@@ -1,12 +1,19 @@
+import {RuleTester} from "@typescript-eslint/rule-tester";
+
 import {rules} from "../../src/index";
-import {RuleTester} from "../RuleTester";
 
 const ruleTester = new RuleTester({
-    parser: "@typescript-eslint/parser",
-    parserOptions: {
-        ecmaVersion: 6,
-        sourceType: "module",
-        ecmaFeatures: {},
+    languageOptions: {
+        parserOptions: {
+            ecmaVersion: 6,
+            sourceType: "module",
+            ecmaFeatures: {},
+        },
+    },
+    linterOptions: {
+        // NOTE(kevinb): Avoids 'TypeError: Expected a Boolean' error
+        // when running the tests.
+        reportUnusedDisableDirectives: true,
     },
 });
 

diff --git a/packages/eslint-plugin-khan/test/rules/react-svg-path-precision.test.ts b/packages/eslint-plugin-khan/test/rules/react-svg-path-precision.test.ts
@@ -1,15 +1,22 @@
+import {RuleTester} from "@typescript-eslint/rule-tester";
+
 import {rules} from "../../src/index";
-import {RuleTester} from "../RuleTester";
 
 const ruleTester = new RuleTester({
-    parser: "@typescript-eslint/parser",
-    parserOptions: {
-        ecmaVersion: 6,
-        sourceType: "module",
-        ecmaFeatures: {
-            jsx: true,
+    languageOptions: {
+        parserOptions: {
+            ecmaVersion: 6,
+            sourceType: "module",
+            ecmaFeatures: {
+                jsx: true,
+            },
         },
     },
+    linterOptions: {
+        // NOTE(kevinb): Avoids 'TypeError: Expected a Boolean' error
+        // when running the tests.
+        reportUnusedDisableDirectives: true,
+    },
 });
 
 const ruleName = "react-svg-path-precision";

diff --git a/packages/eslint-plugin-khan/test/rules/sync-tag.test.ts b/packages/eslint-plugin-khan/test/rules/sync-tag.test.ts
@@ -1,17 +1,21 @@
+import {RuleTester} from "@typescript-eslint/rule-tester";
+
 import {rules} from "../../src/index";
 import * as util from "../../src/util";
 
-import {RuleTester} from "../RuleTester";
-
 const ruleTester = new RuleTester({
-    parser: "@typescript-eslint/parser",
-    parserOptions: {
-        ecmaVersion: 6,
-        sourceType: "module",
-        ecmaFeatures: {
-            jsx: true,
+    languageOptions: {
+        parserOptions: {
+            ecmaVersion: 6,
+            sourceType: "module",
+            ecmaFeatures: {},
         },
     },
+    linterOptions: {
+        // NOTE(kevinb): Avoids 'TypeError: Expected a Boolean' error
+        // when running the tests.
+        reportUnusedDisableDirectives: true,
+    },
 });
 
 beforeEach(() => {
@@ -188,12 +192,6 @@ ruleTester.run("sync-tag", rule, {
                     },
                 },
             ],
-            // Prettier is removing whitespace within backticks, so I had to add
-            // the newlines manually.
-            output: `
-                // sync-start:foo-bar 1424803960 filey
-                const FooBar = 'foobar';
-                // sync-end:foo-bar`,
             options: [
                 {
                     ignoreFiles: ["lint_blacklist.txt"],

diff --git a/packages/eslint-plugin-khan/test/rules/ts-no-error-suppressions.test.ts b/packages/eslint-plugin-khan/test/rules/ts-no-error-suppressions.test.ts
@@ -1,15 +1,22 @@
+import {RuleTester} from "@typescript-eslint/rule-tester";
+
 import {rules} from "../../src/index";
-import {RuleTester} from "../RuleTester";
 
 const ruleTester = new RuleTester({
-    parser: "@typescript-eslint/parser",
-    parserOptions: {
-        ecmaVersion: 6,
-        sourceType: "module",
-        ecmaFeatures: {
-            jsx: true,
+    languageOptions: {
+        parserOptions: {
+            ecmaVersion: 6,
+            sourceType: "module",
+            ecmaFeatures: {
+                jsx: true,
+            },
         },
     },
+    linterOptions: {
+        // NOTE(kevinb): Avoids 'TypeError: Expected a Boolean' error
+        // when running the tests.
+        reportUnusedDisableDirectives: true,
+    },
 });
 
 const ruleName = "ts-no-error-suppressions";