--wip-- [skip ci]

Author: SimenB

package.json

@@ -95,7 +95,7 @@
     ]
   },
   "dependencies": {
-    "@typescript-eslint/utils": "^5.10.0"
+    "@typescript-eslint/utils": "6"
   },
   "devDependencies": {
     "@babel/cli": "^7.4.4",
@@ -111,8 +111,9 @@
     "@types/eslint": "^8.4.6",
     "@types/jest": "^29.0.0",
     "@types/node": "^14.18.26",
-    "@typescript-eslint/eslint-plugin": "^5.0.0",
-    "@typescript-eslint/parser": "^5.0.0",
+    "@typescript-eslint/eslint-plugin": "6",
+    "@typescript-eslint/parser": "6",
+    "@typescript-eslint/rule-tester": "^6.0.0",
     "babel-jest": "^29.0.0",
     "babel-plugin-replace-ts-export-assignment": "^0.0.2",
     "dedent": "^1.5.0",

src/index.ts

@@ -8,13 +8,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';
-  }
-}
-
 // 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/__tests__/unbound-method.test.ts

@@ -9,7 +9,12 @@ function getFixturesRootDir(): string {
 
 const rootPath = getFixturesRootDir();
 
-const ruleTester = new ESLintUtils.RuleTester({
+const RuleTester =
+  ESLintUtils.RuleTester ??
+  // eslint-disable-next-line @typescript-eslint/no-require-imports
+  require('@typescript-eslint/rule-tester').RuleTester;
+
+const ruleTester = new RuleTester({
   parser: '@typescript-eslint/parser',
   parserOptions: {
     sourceType: 'module',
@@ -164,7 +169,7 @@ describe('error handling', () => {
   });
 
   describe('when @typescript-eslint/eslint-plugin is not available', () => {
-    const ruleTester = new ESLintUtils.RuleTester({
+    const ruleTester = new RuleTester({
       parser: '@typescript-eslint/parser',
       parserOptions: {
         sourceType: 'module',

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],
           },
         },

src/rules/expect-expect.ts

@@ -52,9 +52,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',

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:

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:

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 }}()`,

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',

src/rules/no-conditional-expect.ts

@@ -19,8 +19,6 @@ export default createRule({
   meta: {
     docs: {
       description: 'Disallow calling `expect` conditionally',
-      category: 'Best Practices',
-      recommended: 'error',
     },
     messages: {
       conditionalExpect: 'Avoid calling `expect` conditionally`',

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',

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:

src/rules/no-disabled-tests.ts

@@ -9,9 +9,7 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow disabled tests',
-      recommended: 'warn',
     },
     messages: {
       missingFunction: 'Test is missing function argument',

src/rules/no-done-callback.ts

@@ -31,9 +31,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:

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',

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`,

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',

src/rules/no-hooks.ts

@@ -7,9 +7,7 @@ export default createRule<
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow setup and teardown hooks',
-      recommended: false,
     },
     messages: {
       unexpectedHook: "Unexpected '{{ hookName }}' hook",

src/rules/no-identical-title.ts

@@ -21,9 +21,7 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow identical titles',
-      recommended: 'error',
     },
     messages: {
       multipleTestTitle:

src/rules/no-if.ts

@@ -39,8 +39,6 @@ export default createRule({
   meta: {
     docs: {
       description: 'Disallow conditional logic',
-      category: 'Best Practices',
-      recommended: false,
     },
     messages: {
       conditionalInTest: 'Test should not contain {{ condition }} statements',

src/rules/no-interpolation-in-snapshots.ts

@@ -5,9 +5,7 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow string interpolation inside snapshots',
-      recommended: 'error',
     },
     messages: {
       noInterpolation: 'Do not use string interpolation inside of snapshots',

src/rules/no-jasmine-globals.ts

@@ -10,9 +10,7 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow Jasmine globals',
-      recommended: 'error',
     },
     messages: {
       illegalGlobal:

src/rules/no-large-snapshots.ts

@@ -75,9 +75,7 @@ export default createRule<[RuleOptions], MessageId>({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow large snapshots',
-      recommended: false,
     },
     messages: {
       noSnapshot: '`{{ lineCount }}`s should begin with lowercase',

src/rules/no-mocks-import.ts

@@ -17,9 +17,7 @@ export default createRule({
   meta: {
     type: 'problem',
     docs: {
-      category: 'Best Practices',
       description: 'Disallow manually importing from `__mocks__`',
-      recommended: 'error',
     },
     messages: {
       noManualImport: `Mocks should not be manually imported from a ${mocksDirName} directory. Instead use \`jest.mock\` and import from the original module path`,

src/rules/no-restricted-jest-methods.ts

@@ -12,9 +12,7 @@ export default createRule<
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow specific `jest.` methods',
-      recommended: false,
     },
     type: 'suggestion',
     schema: [

src/rules/no-restricted-matchers.ts

@@ -23,9 +23,7 @@ export default createRule<
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow specific matchers & modifiers',
-      recommended: false,
     },
     type: 'suggestion',
     schema: [

src/rules/no-standalone-expect.ts

@@ -60,9 +60,7 @@ export default createRule<
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow using `expect` outside of `it` or `test` blocks',
-      recommended: 'error',
     },
     messages: {
       unexpectedExpect: 'Expect must be inside of a test block',

src/rules/no-test-prefixes.ts

@@ -5,9 +5,7 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Require using `.only` and `.skip` over `f` and `x`',
-      recommended: 'error',
     },
     messages: {
       usePreferredName: 'Use "{{ preferredNodeName }}" instead',

src/rules/no-test-return-statement.ts

@@ -24,9 +24,7 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow explicitly returning from tests',
-      recommended: false,
     },
     messages: {
       noReturnValue: 'Jest tests should not return a value',

src/rules/no-untyped-mock-factory.ts

@@ -21,10 +21,8 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description:
         'Disallow using `jest.mock()` factories without an explicit type parameter',
-      recommended: false,
     },
     messages: {
       addTypeParameterToModuleMock:
@@ -38,7 +36,7 @@ export default createRule({
   create(context) {
     return {
       CallExpression(node: TSESTree.CallExpression): void {
-        const { callee, typeParameters } = node;
+        const { callee } = node;
 
         if (callee.type !== AST_NODE_TYPES.MemberExpression) {
           return;
@@ -54,6 +52,9 @@ export default createRule({
         ) {
           const [nameNode, factoryNode] = node.arguments;
 
+          // this will still emit a deprecation warning as `typeArguments` might be nullish on v6
+          const typeParameters = node.typeArguments ?? node.typeParameters;
+
           const hasTypeParameter =
             typeParameters !== undefined && typeParameters.params.length > 0;
           const hasReturnType =

src/rules/prefer-called-with.ts

@@ -4,10 +4,8 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description:
         'Suggest using `toBeCalledWith()` or `toHaveBeenCalledWith()`',
-      recommended: false,
     },
     messages: {
       preferCalledWith: 'Prefer {{ matcherName }}With(/* expected args */)',

src/rules/prefer-comparison-matcher.ts

@@ -56,9 +56,7 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Suggest using the built-in comparison matchers',
-      recommended: false,
     },
     messages: {
       useToBeComparison: 'Prefer using `{{ preferredMatcher }}` instead',

src/rules/prefer-each.ts

@@ -5,9 +5,7 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Prefer using `.each` rather than manual loops',
-      recommended: false,
     },
     messages: {
       preferEach: 'prefer using `{{ fn }}.each` rather than a manual loop',

src/rules/prefer-equality-matcher.ts

@@ -13,9 +13,7 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Suggest using the built-in equality matchers',
-      recommended: false,
     },
     messages: {
       useEqualityMatcher: 'Prefer using one of the equality matchers instead',