feat: upgrade @typescript-eslint/utils to v6 (#1508)

* feat: upgrade to `@typescript-eslint/utils` v6 * chore: remove invalid module declarations * fix: update `docs` meta property on rules * chore: cast `context.settings` for now * refactor: update deprecated method calls * fix: update types for `JSONSchema4` * test(unbound-method): update cases and structure * test(unbound-method): use `TSESLint.RuleTester` * test(unbound-method): include filename for invalid cases * test(unbound-method): don't run broken test when using `@typescript-eslint` v5 * fix: address deprecation warning
jest-community · Mar 22, 2024 · dc6e8cd · dc6e8cd
1 parent 8408db9
commit dc6e8cd
Show file tree

Hide file tree

Showing 59 changed files with 219 additions and 209 deletions.
diff --git a/package.json b/package.json
@@ -95,7 +95,7 @@
     ]
   },
   "dependencies": {
-    "@typescript-eslint/utils": "^5.10.0"
+    "@typescript-eslint/utils": "^6.0.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.4.4",

diff --git a/src/index.ts b/src/index.ts
@@ -1,6 +1,6 @@
 import { readdirSync } from 'fs';
 import { join, parse } from 'path';
-import type { TSESLint, TSESTree } from '@typescript-eslint/utils';
+import type { TSESLint } from '@typescript-eslint/utils';
 import {
   name as packageName,
   version as packageVersion,
@@ -12,39 +12,6 @@ type RuleModule = TSESLint.RuleModule<string, unknown[]> & {
   meta: Required<Pick<TSESLint.RuleMetaData<string>, 'docs'>>;
 };
 
-// v5 of `@typescript-eslint/experimental-utils` removed this
-declare module '@typescript-eslint/utils/dist/ts-eslint/Rule' {
-  export interface RuleMetaDataDocs {
-    category: 'Best Practices' | 'Possible Errors';
-  }
-}
-
-declare module '@typescript-eslint/utils/dist/ts-eslint/SourceCode' {
-  export interface SourceCode {
-    /**
-     * Returns the scope of the given node.
-     * This information can be used track references to variables.
-     * @since 8.37.0
-     */
-    getScope(node: TSESTree.Node): TSESLint.Scope.Scope;
-    /**
-     * Returns an array of the ancestors of the given node, starting at
-     * the root of the AST and continuing through the direct parent of the current node.
-     * This array does not include the currently-traversed node itself.
-     * @since 8.38.0
-     */
-    getAncestors(node: TSESTree.Node): TSESTree.Node[];
-    /**
-     * Returns a list of variables declared by the given node.
-     * This information can be used to track references to variables.
-     * @since 8.38.0
-     */
-    getDeclaredVariables(
-      node: TSESTree.Node,
-    ): readonly TSESLint.Scope.Variable[];
-  }
-}
-
 // copied from https://github.com/babel/babel/blob/d8da63c929f2d28c401571e2a43166678c555bc4/packages/babel-helpers/src/helpers.js#L602-L606
 /* istanbul ignore next */
 const interopRequireDefault = (obj: any): { default: any } =>

diff --git a/src/rules/__tests__/unbound-method.test.ts b/src/rules/__tests__/unbound-method.test.ts
@@ -1,5 +1,6 @@
 import path from 'path';
-import { ESLintUtils, type TSESLint } from '@typescript-eslint/utils';
+import { version as rawTypeScriptESLintPluginVersion } from '@typescript-eslint/eslint-plugin/package.json';
+import { TSESLint } from '@typescript-eslint/utils';
 import dedent from 'dedent';
 import type { MessageIds, Options } from '../unbound-method';
 
@@ -9,15 +10,35 @@ function getFixturesRootDir(): string {
 
 const rootPath = getFixturesRootDir();
 
-const ruleTester = new ESLintUtils.RuleTester({
-  parser: '@typescript-eslint/parser',
+const ruleTester = new TSESLint.RuleTester({
+  parser: require.resolve('@typescript-eslint/parser'),
   parserOptions: {
     sourceType: 'module',
     tsconfigRootDir: rootPath,
     project: './tsconfig.json',
   },
 });
 
+const fixtureFilename = path.join(rootPath, 'file.ts');
+
+const withFixtureFilename = <
+  T extends Array<
+    | (TSESLint.ValidTestCase<Options> | string)
+    | TSESLint.InvalidTestCase<MessageIds, Options>
+  >,
+>(
+  cases: T,
+): T extends Array<TSESLint.InvalidTestCase<MessageIds, Options>>
+  ? Array<TSESLint.InvalidTestCase<MessageIds, Options>>
+  : Array<TSESLint.ValidTestCase<Options>> => {
+  // @ts-expect-error this is fine, and will go away later once we upgrade
+  return cases.map(code => {
+    const test = typeof code === 'string' ? { code } : code;
+
+    return { filename: fixtureFilename, ...test };
+  });
+};
+
 const ConsoleClassAndVariableCode = dedent`
   class Console {
     log(str) {
@@ -164,8 +185,8 @@ describe('error handling', () => {
   });
 
   describe('when @typescript-eslint/eslint-plugin is not available', () => {
-    const ruleTester = new ESLintUtils.RuleTester({
-      parser: '@typescript-eslint/parser',
+    const ruleTester = new TSESLint.RuleTester({
+      parser: require.resolve('@typescript-eslint/parser'),
       parserOptions: {
         sourceType: 'module',
         tsconfigRootDir: rootPath,
@@ -177,16 +198,18 @@ describe('error handling', () => {
       'unbound-method jest edition without type service',
       requireRule(true),
       {
-        valid: validTestCases.concat(invalidTestCases.map(({ code }) => code)),
+        valid: withFixtureFilename(
+          validTestCases.concat(invalidTestCases.map(({ code }) => code)),
+        ),
         invalid: [],
       },
     );
   });
 });
 
 ruleTester.run('unbound-method jest edition', requireRule(false), {
-  valid: validTestCases,
-  invalid: invalidTestCases,
+  valid: withFixtureFilename(validTestCases),
+  invalid: withFixtureFilename(invalidTestCases),
 });
 
 function addContainsMethodsClass(code: string): string {
@@ -225,11 +248,14 @@ function addContainsMethodsClassInvalid(
 }
 
 ruleTester.run('unbound-method', requireRule(false), {
-  valid: [
+  valid: withFixtureFilename([
     'Promise.resolve().then(console.log);',
     "['1', '2', '3'].map(Number.parseInt);",
     '[5.2, 7.1, 3.6].map(Math.floor);',
     'const x = console.log;',
+    ...(parseInt(rawTypeScriptESLintPluginVersion.split('.')[0], 10) >= 6
+      ? ['const x = Object.defineProperty;']
+      : []),
     ...[
       'instance.bound();',
       'instance.unbound();',
@@ -455,8 +481,8 @@ class OtherClass extends BaseClass {
 const oc = new OtherClass();
 oc.superLogThis();
     `,
-  ],
-  invalid: [
+  ]),
+  invalid: withFixtureFilename([
     {
       code: `
 class Console {
@@ -762,5 +788,59 @@ class OtherClass extends BaseClass {
         },
       ],
     },
-  ],
+    {
+      code: `
+const values = {
+  a() {},
+  b: () => {},
+};
+
+const { a, b } = values;
+      `,
+      errors: [
+        {
+          line: 7,
+          column: 9,
+          endColumn: 10,
+          messageId: 'unboundWithoutThisAnnotation',
+        },
+      ],
+    },
+    {
+      code: `
+const values = {
+  a() {},
+  b: () => {},
+};
+
+const { a: c } = values;
+      `,
+      errors: [
+        {
+          line: 7,
+          column: 9,
+          endColumn: 10,
+          messageId: 'unboundWithoutThisAnnotation',
+        },
+      ],
+    },
+    {
+      code: `
+const values = {
+  a() {},
+  b: () => {},
+};
+
+const { b, a } = values;
+      `,
+      errors: [
+        {
+          line: 7,
+          column: 12,
+          endColumn: 13,
+          messageId: 'unboundWithoutThisAnnotation',
+        },
+      ],
+    },
+  ]),
 });
diff --git a/src/rules/consistent-test-it.ts b/src/rules/consistent-test-it.ts
@@ -35,9 +35,7 @@ export default createRule<
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Enforce `test` and `it` usage conventions',
-      recommended: false,
     },
     fixable: 'code',
     messages: {
@@ -51,9 +49,11 @@ export default createRule<
         type: 'object',
         properties: {
           fn: {
+            type: 'string',
             enum: [TestCaseName.it, TestCaseName.test],
           },
           withinDescribe: {
+            type: 'string',
             enum: [TestCaseName.it, TestCaseName.test],
           },
         },

diff --git a/src/rules/expect-expect.ts b/src/rules/expect-expect.ts
@@ -54,9 +54,7 @@ export default createRule<
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Enforce assertion to be made in a test body',
-      recommended: 'warn',
     },
     messages: {
       noAssertions: 'Test has no assertions',

diff --git a/src/rules/max-expects.ts b/src/rules/max-expects.ts
@@ -10,9 +10,7 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Enforces a maximum number assertion calls in a test body',
-      recommended: false,
     },
     messages: {
       exceededMaxAssertion:

diff --git a/src/rules/max-nested-describe.ts b/src/rules/max-nested-describe.ts
@@ -5,9 +5,7 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Enforces a maximum depth to nested describe calls',
-      recommended: false,
     },
     messages: {
       exceededMaxDepth:

diff --git a/src/rules/no-alias-methods.ts b/src/rules/no-alias-methods.ts
@@ -9,9 +9,7 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow alias methods',
-      recommended: 'error',
     },
     messages: {
       replaceAlias: `Replace {{ alias }}() with its canonical name of {{ canonical }}()`,

diff --git a/src/rules/no-commented-out-tests.ts b/src/rules/no-commented-out-tests.ts
@@ -11,9 +11,7 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow commented out tests',
-      recommended: 'warn',
     },
     messages: {
       commentedTests: 'Some tests seem to be commented',

diff --git a/src/rules/no-conditional-expect.ts b/src/rules/no-conditional-expect.ts
@@ -20,8 +20,6 @@ export default createRule({
   meta: {
     docs: {
       description: 'Disallow calling `expect` conditionally',
-      category: 'Best Practices',
-      recommended: 'error',
     },
     messages: {
       conditionalExpect: 'Avoid calling `expect` conditionally`',

diff --git a/src/rules/no-conditional-in-test.ts b/src/rules/no-conditional-in-test.ts
@@ -6,8 +6,6 @@ export default createRule({
   meta: {
     docs: {
       description: 'Disallow conditional logic in tests',
-      category: 'Best Practices',
-      recommended: false,
     },
     messages: {
       conditionalInTest: 'Avoid having conditionals in tests',

diff --git a/src/rules/no-confusing-set-timeout.ts b/src/rules/no-confusing-set-timeout.ts
@@ -18,9 +18,7 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow confusing usages of jest.setTimeout',
-      recommended: false,
     },
     messages: {
       globalSetTimeout: '`jest.setTimeout` should be call in `global` scope',

diff --git a/src/rules/no-deprecated-functions.ts b/src/rules/no-deprecated-functions.ts
@@ -28,9 +28,7 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow use of deprecated functions',
-      recommended: 'error',
     },
     messages: {
       deprecatedFunction:

diff --git a/src/rules/no-disabled-tests.ts b/src/rules/no-disabled-tests.ts
@@ -10,9 +10,7 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow disabled tests',
-      recommended: 'warn',
     },
     messages: {
       missingFunction: 'Test is missing function argument',

diff --git a/src/rules/no-done-callback.ts b/src/rules/no-done-callback.ts
@@ -37,9 +37,7 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow using a callback in asynchronous tests and hooks',
-      recommended: 'error',
     },
     messages: {
       noDoneCallback:

diff --git a/src/rules/no-duplicate-hooks.ts b/src/rules/no-duplicate-hooks.ts
@@ -4,9 +4,7 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow duplicate setup and teardown hooks',
-      recommended: false,
     },
     messages: {
       noDuplicateHook: 'Duplicate {{hook}} in describe block',

diff --git a/src/rules/no-export.ts b/src/rules/no-export.ts
@@ -5,9 +5,7 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow using `exports` in files containing tests',
-      recommended: 'error',
     },
     messages: {
       unexpectedExport: `Do not export from a test file`,

diff --git a/src/rules/no-focused-tests.ts b/src/rules/no-focused-tests.ts
@@ -5,9 +5,7 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow focused tests',
-      recommended: 'error',
     },
     messages: {
       focusedTest: 'Unexpected focused test',