[FEI-6012]: Update eslint-{config|plugin}-khan to work with TypeScrip…

…t v5.7.x (#1085) ## Summary: This PR updates all `@typescript-eslint/*` packages to 8.17.0. Earlier versions of `@typescript-eslint/typescript-estree` would print a warning message when loaded. This necessitated updating `eslint-jest-plugin` which uses `@typescript-eslint/utils` which uses `@typescript-eslint/typescript-estree` internally. I also needed to update eslint-plugin-khan's test harness to use `@typescript-eslint/rule-tester` since the old harness broke after the other upgrades. The plugins themselves needed some tweaking after some of the types changed when updating `@typescript-eslint/utils`. Issue: FEI-6012 ## Test plan: - yarn lint Author: kevinb-khan Reviewers: jeresig, kevinb-khan Required Reviewers: Approved By: jeresig Checks: ✅ Test (macos-latest, 20.x), ✅ CodeQL, ✅ Lint, typecheck, and coverage check (ubuntu-latest, 20.x), ✅ Prime node_modules cache for primary configuration (ubuntu-latest, 20.x), ✅ gerald, ✅ Analyze (javascript), ⏭️ dependabot Pull Request URL: #1085
Khan · Dec 4, 2024 · 86caa2d · 86caa2d
1 parent b2fc2d0
commit 86caa2d
Show file tree

Hide file tree

Showing 24 changed files with 276 additions and 233 deletions.
diff --git a/.changeset/silver-boxes-hang.md b/.changeset/silver-boxes-hang.md
@@ -0,0 +1,6 @@
+---
+"@khanacademy/eslint-config": patch
+"@khanacademy/eslint-plugin": patch
+---
+
+Update @typescript-eslint/\* to versions that work with TypeScript v5.7.x
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -55,17 +55,6 @@ module.exports = {
                 "no-console": "off",
             },
         },
-        {
-            files: [
-                "**/__tests__/**/*.test.ts",
-                "utils/*.js",
-                "config/**",
-                "build-settings/**",
-            ],
-            rules: {
-                "@typescript-eslint/no-var-requires": "off",
-            },
-        },
     ],
     rules: {
         /**
@@ -161,5 +150,11 @@ module.exports = {
          * monorepo rules
          */
         "monorepo/no-internal-import": "error",
+
+        /**
+         * typescript rules
+         */
+        // import/no-common-js covers this already
+        "@typescript-eslint/no-require-imports": "off",
     },
 };
diff --git a/.github/workflows/node-ci.yml b/.github/workflows/node-ci.yml
@@ -183,3 +183,7 @@ 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.config.js b/config/jest/test.config.js
@@ -14,6 +14,7 @@ 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/package.json b/package.json
@@ -37,8 +37,8 @@
     "@types/jsdom": "^21.1.1",
     "@types/superagent": "^4.1.16",
     "@types/winston": "^2.4.4",
-    "@typescript-eslint/eslint-plugin": "^7.3.1",
-    "@typescript-eslint/parser": "^7.3.1",
+    "@typescript-eslint/eslint-plugin": "8.17.0",
+    "@typescript-eslint/parser": "8.17.0",
     "babel-jest": "^29.7.0",
     "babel-watch": "^7.8.1",
     "eslint": "^8.52.0",
@@ -47,7 +47,7 @@
     "eslint-plugin-disable": "^2.0.3",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-import": "^2.28.1",
-    "eslint-plugin-jest": "^27.6.0",
+    "eslint-plugin-jest": "28.9.0",
     "eslint-plugin-jsdoc": "^48.1.0",
     "eslint-plugin-jsx-a11y": "^6.7.1",
     "eslint-plugin-monorepo": "^0.3.2",

diff --git a/packages/eslint-config-khan/index.js b/packages/eslint-config-khan/index.js
@@ -151,7 +151,7 @@ module.exports = {
 
         "@typescript-eslint/no-unused-vars": [
             ERROR,
-            {args: "none", varsIgnorePattern: "^_*$"},
+            {args: "none", caughtErrors: "none", varsIgnorePattern: "^_*$"},
         ],
 
         // Require each enum member value to be explicitly initialized.

diff --git a/packages/eslint-config-khan/package.json b/packages/eslint-config-khan/package.json
@@ -16,14 +16,17 @@
     "license": "MIT",
     "peerDependencies": {
         "@khanacademy/eslint-plugin": "^3.0.0",
-        "@typescript-eslint/eslint-plugin": "^5.52.0",
-        "@typescript-eslint/parser": "^5.52.0",
-        "eslint": "^8.38.0",
+        "@typescript-eslint/eslint-plugin": "8.17.0",
+        "@typescript-eslint/parser": "8.17.0",
+        "eslint": "^8.44.0",
         "eslint-config-prettier": "^8.3.0",
         "eslint-import-resolver-typescript": "^3.5.3",
         "eslint-plugin-import": "^2.23.4",
         "eslint-plugin-jsx-a11y": "^6.4.1",
         "eslint-plugin-prettier": "^3.4.0",
         "eslint-plugin-react": "^7.24.0"
+    },
+    "devDependencies": {
+        "@typescript-eslint/rule-tester": "^8.17.0"
     }
 }
diff --git a/packages/eslint-plugin-khan/package.json b/packages/eslint-plugin-khan/package.json
@@ -31,7 +31,7 @@
   },
   "dependencies": {
     "@babel/types": "^7.23.0",
-    "@typescript-eslint/utils": "^5.60.1",
+    "@typescript-eslint/utils": "8.17.0",
     "checksync": "^5.0.5"
   }
 }
diff --git a/packages/eslint-plugin-khan/src/rules/array-type-style.ts b/packages/eslint-plugin-khan/src/rules/array-type-style.ts
@@ -1,6 +1,8 @@
 import {ESLintUtils} from "@typescript-eslint/utils";
 
-const createRule = ESLintUtils.RuleCreator(
+import type {MyPluginDocs} from "../types";
+
+const createRule = ESLintUtils.RuleCreator<MyPluginDocs>(
     (name) =>
         `https://github.com/Khan/wonder-stuff/blob/main/packages/eslint-plugin-khan/docs/${name}.md`,
 );

diff --git a/packages/eslint-plugin-khan/src/rules/jest-async-use-real-timers.ts b/packages/eslint-plugin-khan/src/rules/jest-async-use-real-timers.ts
@@ -1,6 +1,8 @@
 import {ESLintUtils, TSESTree, AST_NODE_TYPES} from "@typescript-eslint/utils";
 
-const createRule = ESLintUtils.RuleCreator(
+import type {MyPluginDocs} from "../types";
+
+const createRule = ESLintUtils.RuleCreator<MyPluginDocs>(
     (name) =>
         `https://github.com/Khan/wonder-stuff/blob/main/packages/eslint-plugin-khan/docs/${name}.md`,
 );

diff --git a/packages/eslint-plugin-khan/src/rules/jest-await-async-matchers.ts b/packages/eslint-plugin-khan/src/rules/jest-await-async-matchers.ts
@@ -1,6 +1,8 @@
 import {ESLintUtils, TSESTree, AST_NODE_TYPES} from "@typescript-eslint/utils";
 
-const createRule = ESLintUtils.RuleCreator(
+import type {MyPluginDocs} from "../types";
+
+const createRule = ESLintUtils.RuleCreator<MyPluginDocs>(
     (name) =>
         `https://github.com/Khan/wonder-stuff/blob/main/packages/eslint-plugin-khan/docs/${name}.md`,
 );

diff --git a/packages/eslint-plugin-khan/src/rules/no-one-tuple.ts b/packages/eslint-plugin-khan/src/rules/no-one-tuple.ts
@@ -1,6 +1,8 @@
 import {ESLintUtils} from "@typescript-eslint/utils";
 
-const createRule = ESLintUtils.RuleCreator(
+import type {MyPluginDocs} from "../types";
+
+const createRule = ESLintUtils.RuleCreator<MyPluginDocs>(
     (name) =>
         `https://github.com/Khan/wonder-stuff/blob/main/packages/eslint-plugin-khan/docs/${name}.md`,
 );

diff --git a/packages/eslint-plugin-khan/src/rules/react-no-method-jsx-attribute.ts b/packages/eslint-plugin-khan/src/rules/react-no-method-jsx-attribute.ts
@@ -1,6 +1,8 @@
 import {ESLintUtils, TSESTree, AST_NODE_TYPES} from "@typescript-eslint/utils";
 
-const createRule = ESLintUtils.RuleCreator(
+import type {MyPluginDocs} from "../types";
+
+const createRule = ESLintUtils.RuleCreator<MyPluginDocs>(
     (name) =>
         `https://github.com/Khan/wonder-stuff/blob/main/packages/eslint-plugin-khan/docs/${name}.md`,
 );

diff --git a/packages/eslint-plugin-khan/src/rules/react-no-subscriptions-before-mount.ts b/packages/eslint-plugin-khan/src/rules/react-no-subscriptions-before-mount.ts
@@ -1,8 +1,9 @@
 import {ESLintUtils, TSESTree} from "@typescript-eslint/utils";
 
 import * as t from "../ast-utils";
+import type {MyPluginDocs} from "../types";
 
-const createRule = ESLintUtils.RuleCreator(
+const createRule = ESLintUtils.RuleCreator<MyPluginDocs>(
     (name) =>
         `https://github.com/Khan/wonder-stuff/blob/main/packages/eslint-plugin-khan/docs/${name}.md`,
 );

diff --git a/packages/eslint-plugin-khan/src/rules/react-svg-path-precision.ts b/packages/eslint-plugin-khan/src/rules/react-svg-path-precision.ts
@@ -1,8 +1,9 @@
 import {ESLintUtils, TSESTree, AST_NODE_TYPES} from "@typescript-eslint/utils";
 
 import * as t from "../ast-utils";
+import type {MyPluginDocs} from "../types";
 
-const createRule = ESLintUtils.RuleCreator(
+const createRule = ESLintUtils.RuleCreator<MyPluginDocs>(
     (name) =>
         `https://github.com/Khan/wonder-stuff/blob/main/packages/eslint-plugin-khan/docs/${name}.md`,
 );

diff --git a/packages/eslint-plugin-khan/src/rules/sync-tag.ts b/packages/eslint-plugin-khan/src/rules/sync-tag.ts
@@ -3,8 +3,9 @@ import ancesdir from "ancesdir";
 import {ESLintUtils, TSESTree, TSESLint} from "@typescript-eslint/utils";
 
 import * as util from "../util";
+import type {MyPluginDocs} from "../types";
 
-const createRule = ESLintUtils.RuleCreator(
+const createRule = ESLintUtils.RuleCreator<MyPluginDocs>(
     (name) =>
         `https://github.com/Khan/wonder-stuff/blob/main/packages/eslint-plugin-khan/docs/${name}.md`,
 );

diff --git a/packages/eslint-plugin-khan/src/rules/ts-no-error-suppressions.ts b/packages/eslint-plugin-khan/src/rules/ts-no-error-suppressions.ts
@@ -1,6 +1,8 @@
 import {ESLintUtils, TSESTree} from "@typescript-eslint/utils";
 
-const createRule = ESLintUtils.RuleCreator(
+import type {MyPluginDocs} from "../types";
+
+const createRule = ESLintUtils.RuleCreator<MyPluginDocs>(
     (name) =>
         `https://github.com/Khan/wonder-stuff/blob/main/packages/eslint-plugin-khan/docs/${name}.md`,
 );

diff --git a/packages/eslint-plugin-khan/src/types.ts b/packages/eslint-plugin-khan/src/types.ts
@@ -0,0 +1,7 @@
+// We need to define our own PluginDocs type in order for us to be
+// able to set the `recommended` field in meta.docs when calling
+// `createRule`.  For more info, see:
+// https://typescript-eslint.io/developers/custom-rules/#extra-rule-docs-types
+export interface MyPluginDocs {
+    recommended: boolean;
+}
diff --git a/packages/eslint-plugin-khan/test/RuleTester.ts b/packages/eslint-plugin-khan/test/RuleTester.ts
@@ -1,15 +1,15 @@
-import {ESLintUtils} from "@typescript-eslint/utils";
 import * as path from "path";
 
-function getFixturesRootDir(): string {
-    return path.join(__dirname, "fixtures");
-}
-
-const {batchedSingleLineTests, RuleTester, noFormat} = ESLintUtils;
 export {
+    RuleTester,
     RunTests,
-    ValidTestCase,
     InvalidTestCase,
-} from "@typescript-eslint/utils/dist/eslint-utils/rule-tester/RuleTester";
+    ValidTestCase,
+    noFormat,
+} from "@typescript-eslint/rule-tester";
+
+function getFixturesRootDir(): string {
+    return path.join(__dirname, "fixtures");
+}
 
-export {batchedSingleLineTests, getFixturesRootDir, noFormat, RuleTester};
+export {getFixturesRootDir};
diff --git a/packages/wonder-stuff-core/src/entries.ts b/packages/wonder-stuff-core/src/entries.ts
@@ -14,6 +14,6 @@ export const entries: {
               }
             | ArrayLike<T>,
     ): [string, T][];
-    // eslint-disable-next-line @typescript-eslint/ban-types
+    // eslint-disable-next-line @typescript-eslint/no-empty-object-type
     (obj: {}): [string, any][];
 } = (obj: any) => Object.entries(obj);
diff --git a/packages/wonder-stuff-core/src/values.ts b/packages/wonder-stuff-core/src/values.ts
@@ -14,6 +14,6 @@ export const values: {
               }
             | ArrayLike<T>,
     ): T[];
-    // eslint-disable-next-line @typescript-eslint/ban-types
+    // eslint-disable-next-line @typescript-eslint/no-empty-object-type
     (obj: {}): any[];
 } = (obj: any) => Object.values(obj);
diff --git a/packages/wonder-stuff-server/src/get-agent-for-url.ts b/packages/wonder-stuff-server/src/get-agent-for-url.ts
@@ -39,12 +39,12 @@ export const getAgentForURL = (url: URL): HttpAgent | HttpsAgent => {
     const agentOptions = {keepAlive: true} as const;
     switch (url.protocol) {
         case "http:":
-            // eslint-disable-next-line @typescript-eslint/no-var-requires
+            // eslint-disable-next-line @typescript-eslint/no-require-imports
             const http = require("http");
             return new http.Agent(agentOptions);
 
         case "https:":
-            // eslint-disable-next-line @typescript-eslint/no-var-requires
+            // eslint-disable-next-line @typescript-eslint/no-require-imports
             const https = require("https");
             return new https.Agent(agentOptions);
 

diff --git a/utils/pre-publish-utils.js b/utils/pre-publish-utils.js
@@ -1,4 +1,3 @@
-/* eslint-disable import/no-commonjs */
 /* eslint-disable no-console */
 /**
  * Pre-publish utilities to verify that our publish will go smoothly.