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

* feat: upgrade `@typescript-eslint/utils` to v6

* fix: remove `recommended` and `category` meta properties

* fix: replace declaration merging with a type cast for now

* fix: update `context` usages

Author: G-Rath

package.json

@@ -69,11 +69,8 @@
       "@semantic-release/github"
     ]
   },
-  "resolutions": {
-    "@typescript-eslint/experimental-utils": "^5.0.0"
-  },
   "dependencies": {
-    "@typescript-eslint/utils": "^5.10.0"
+    "@typescript-eslint/utils": "^6.0.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.4.4",
@@ -90,8 +87,8 @@
     "@types/dedent": "^0.7.0",
     "@types/jest": "^29.0.0",
     "@types/node": "^14.17.0",
-    "@typescript-eslint/eslint-plugin": "^5.0.0",
-    "@typescript-eslint/parser": "^5.0.0",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
     "babel-jest": "^29.0.0",
     "babel-plugin-replace-ts-export-assignment": "^0.0.2",
     "dedent": "^1.0.0",

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,
@@ -10,24 +10,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' | 'Stylistic Issues';
-  }
-}
-
-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;
-  }
-}
-
 // 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 } =>

src/rules/prefer-to-be-array.ts

@@ -25,9 +25,7 @@ export default createRule<Options, MessageIds>({
   name: __filename,
   meta: {
     docs: {
-      category: 'Stylistic Issues',
       description: 'Suggest using `toBeArray()`',
-      recommended: false,
     },
     messages: {
       preferToBeArray:

src/rules/prefer-to-be-false.ts

@@ -18,9 +18,7 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Stylistic Issues',
       description: 'Suggest using `toBeFalse()`',
-      recommended: false,
     },
     messages: {
       preferToBeFalse: 'Prefer using `toBeFalse()` to test value is `false`.',

src/rules/prefer-to-be-object.ts

@@ -16,9 +16,7 @@ export default createRule<Options, MessageIds>({
   name: __filename,
   meta: {
     docs: {
-      category: 'Stylistic Issues',
       description: 'Suggest using `toBeObject()`',
-      recommended: false,
     },
     messages: {
       preferToBeObject:

src/rules/prefer-to-be-true.ts

@@ -18,9 +18,7 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Stylistic Issues',
       description: 'Suggest using `toBeTrue()`',
-      recommended: false,
     },
     messages: {
       preferToBeTrue: 'Prefer using `toBeTrue()` to test value is `true`.',

src/rules/prefer-to-have-been-called-once.ts

@@ -10,9 +10,7 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Stylistic Issues',
       description: 'Suggest using `toHaveBeenCalledOnce()`',
-      recommended: false,
     },
     messages: {
       preferCalledOnce: 'Prefer `toHaveBeenCalledOnce()`',

src/rules/utils/__tests__/parseJestFnCall.test.ts

@@ -51,9 +51,7 @@ const rule = createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Possible Errors',
       description: 'Fake rule for testing parseJestFnCall',
-      recommended: false,
     },
     messages: {
       details: '{{ data }}',

src/rules/utils/parseJestFnCall.ts

@@ -166,21 +166,22 @@ const ValidJestFnCallChains = [
   'xtest.failing.each',
 ];
 
-declare module '@typescript-eslint/utils/dist/ts-eslint' {
-  export interface SharedConfigurationSettings {
-    jest?: {
-      globalAliases?: Record<string, string[]>;
-      globalPackage?: string;
-      version?: number | string;
-    };
-  }
+// todo: switch back to using declaration merging once https://github.com/typescript-eslint/typescript-eslint/pull/8485
+//  is landed
+interface SharedConfigurationSettings {
+  jest?: {
+    globalAliases?: Record<string, string[]>;
+    globalPackage?: string;
+    version?: number | string;
+  };
 }
 
 const resolvePossibleAliasedGlobal = (
   global: string,
   context: TSESLint.RuleContext<string, unknown[]>,
 ) => {
-  const globalAliases = context.settings.jest?.globalAliases ?? {};
+  const globalAliases =
+    (context.settings as SharedConfigurationSettings).jest?.globalAliases ?? {};
 
   const alias = Object.entries(globalAliases).find(([, aliases]) =>
     aliases.includes(global),
@@ -569,7 +570,8 @@ const resolveToJestFn = (
 
   if (maybeImport) {
     const globalPackage =
-      context.settings.jest?.globalPackage ?? '@jest/globals';
+      (context.settings as SharedConfigurationSettings).jest?.globalPackage ??
+      '@jest/globals';
 
     // the identifier is imported from our global package so return the original import name
     if (maybeImport.source === globalPackage) {
@@ -595,14 +597,7 @@ const getScope = (
   context: TSESLint.RuleContext<string, unknown[]>,
   node: TSESTree.Node,
 ) => {
-  const sourceCode =
-    'sourceCode' in context
-      ? (context.sourceCode as TSESLint.SourceCode)
-      : context.getSourceCode();
-
-  if ('getScope' in sourceCode) {
-    return sourceCode.getScope(node);
-  }
+  const sourceCode = context.sourceCode ?? context.getSourceCode();
 
-  return context.getScope();
+  return sourceCode.getScope?.(node) ?? context.getScope();
 };