feat: support ESLint 8.x

MichaelDeBoey · MichaelDeBoey · commit db3608672015 · 2021-10-12T11:53:29.000+02:00
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -34,6 +34,11 @@ module.exports = {
     '@typescript-eslint/ban-types': 'error',
     '@typescript-eslint/no-unused-vars': 'error',
     'eslint-comments/no-unused-disable': 'error',
+    'eslint-plugin/require-meta-fixable': [
+      'error',
+      { catchNoFixerButFixableProperty: true },
+    ],
+    'eslint-plugin/require-meta-has-suggestions': 'error',
     'eslint-plugin/test-case-property-ordering': 'error',
     'no-else-return': 'error',
     'no-negated-condition': 'error',
diff --git a/.github/workflows/nodejs.yml b/.github/workflows/nodejs.yml
@@ -20,7 +20,7 @@ jobs:
 
       - uses: actions/setup-node@v2
         with:
-          node-version: 14.x
+          node-version: 16
           cache: yarn
 
       - name: Validate cache
@@ -38,7 +38,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
-          node-version: 14.x
+          node-version: 16
           cache: yarn
       - name: install
         run: yarn
@@ -52,7 +52,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
-          node-version: 14.x
+          node-version: 16
           cache: yarn
       - name: install
         run: yarn
@@ -67,9 +67,12 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: [12.x, 14.x, 16.x]
-        eslint-version: [6, 7]
+        node-version: [12, 14, 16]
+        eslint-version: [6, 7, 8]
         ts-eslint-plugin-version: [4, 5]
+        exclude:
+          - eslint-version: 8
+            ts-eslint-plugin-version: 4
     runs-on: ubuntu-latest
 
     steps:
@@ -104,7 +107,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
-          node-version: 14.x
+          node-version: 16
           cache: yarn
       - name: install
         run: yarn
@@ -123,7 +126,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
-          node-version: 14.x
+          node-version: 16
           cache: yarn
       - name: install
         run: yarn
@@ -146,7 +149,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
-          node-version: 14.x
+          node-version: 16
           cache: yarn
       - name: install
         run: yarn
diff --git a/package.json b/package.json
@@ -100,14 +100,14 @@
     "babel-jest": "^27.0.0",
     "babel-plugin-replace-ts-export-assignment": "^0.0.2",
     "dedent": "^0.7.0",
-    "eslint": "^6.0.0 || ^7.0.0",
+    "eslint": "^6.0.0 || ^7.0.0 || ^8.0.0-0",
     "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-eslint-comments": "^3.1.2",
+    "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-eslint-config": "^2.0.0",
-    "eslint-plugin-eslint-plugin": "^3.5.3",
+    "eslint-plugin-eslint-plugin": "^4.0.0-0",
     "eslint-plugin-import": "^2.25.1",
-    "eslint-plugin-node": "^11.0.0",
-    "eslint-plugin-prettier": "^3.4.1",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^4.0.0",
     "husky": "^7.0.2",
     "is-ci": "^3.0.0",
     "jest": "^27.0.0",
@@ -123,7 +123,7 @@
   },
   "peerDependencies": {
     "@typescript-eslint/eslint-plugin": "^4.0.0 || ^5.0.0",
-    "eslint": "^6.0.0 || ^7.0.0"
+    "eslint": "^6.0.0 || ^7.0.0 || ^8.0.0"
   },
   "peerDependenciesMeta": {
     "@typescript-eslint/eslint-plugin": {
diff --git a/src/index.ts b/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/experimental-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 } =>
diff --git a/src/rules/__tests__/utils.test.ts b/src/rules/__tests__/utils.test.ts
@@ -18,7 +18,6 @@ const rule = createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Possible Errors',
       description: 'Fake rule for testing AST guards',
       recommended: false,
     },
diff --git a/src/rules/consistent-test-it.ts b/src/rules/consistent-test-it.ts
@@ -39,7 +39,6 @@ export default createRule<
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Have control over `test` and `it` usages',
       recommended: false,
     },
diff --git a/src/rules/expect-expect.ts b/src/rules/expect-expect.ts
@@ -47,7 +47,6 @@ export default createRule<
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Enforce assertion to be made in a test body',
       recommended: 'warn',
     },
diff --git a/src/rules/max-nested-describe.ts b/src/rules/max-nested-describe.ts
@@ -8,7 +8,6 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Enforces a maximum depth to nested describe calls',
       recommended: false,
     },
diff --git a/src/rules/no-alias-methods.ts b/src/rules/no-alias-methods.ts
@@ -4,7 +4,6 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow alias methods',
       recommended: false,
     },
diff --git a/src/rules/no-commented-out-tests.ts b/src/rules/no-commented-out-tests.ts
@@ -11,7 +11,6 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow commented out tests',
       recommended: 'warn',
     },
diff --git a/src/rules/no-conditional-expect.ts b/src/rules/no-conditional-expect.ts
@@ -22,7 +22,6 @@ export default createRule({
   meta: {
     docs: {
       description: 'Prevent calling `expect` conditionally',
-      category: 'Best Practices',
       recommended: 'error',
     },
     messages: {
diff --git a/src/rules/no-deprecated-functions.ts b/src/rules/no-deprecated-functions.ts
@@ -27,7 +27,6 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow use of deprecated functions',
       recommended: 'error',
     },
diff --git a/src/rules/no-disabled-tests.ts b/src/rules/no-disabled-tests.ts
@@ -4,7 +4,6 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow disabled tests',
       recommended: 'warn',
     },
diff --git a/src/rules/no-done-callback.ts b/src/rules/no-done-callback.ts
@@ -33,7 +33,6 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Avoid using a callback in asynchronous tests and hooks',
       recommended: 'error',
       suggestion: true,
diff --git a/src/rules/no-duplicate-hooks.ts b/src/rules/no-duplicate-hooks.ts
@@ -11,7 +11,6 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow duplicate setup and teardown hooks',
       recommended: false,
     },
diff --git a/src/rules/no-export.ts b/src/rules/no-export.ts
@@ -8,7 +8,6 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow using `exports` in files containing tests',
       recommended: 'error',
     },
diff --git a/src/rules/no-focused-tests.ts b/src/rules/no-focused-tests.ts
@@ -38,7 +38,6 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow focused tests',
       recommended: 'error',
       suggestion: true,
diff --git a/src/rules/no-hooks.ts b/src/rules/no-hooks.ts
@@ -7,7 +7,6 @@ export default createRule<
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow setup and teardown hooks',
       recommended: false,
     },
diff --git a/src/rules/no-identical-title.ts b/src/rules/no-identical-title.ts
@@ -21,7 +21,6 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow identical titles',
       recommended: 'error',
     },
diff --git a/src/rules/no-if.ts b/src/rules/no-if.ts
@@ -41,7 +41,6 @@ export default createRule({
   meta: {
     docs: {
       description: 'Disallow conditional logic',
-      category: 'Best Practices',
       recommended: false,
     },
     messages: {
diff --git a/src/rules/no-interpolation-in-snapshots.ts b/src/rules/no-interpolation-in-snapshots.ts
@@ -5,7 +5,6 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow string interpolation inside snapshots',
       recommended: 'error',
     },
diff --git a/src/rules/no-jasmine-globals.ts b/src/rules/no-jasmine-globals.ts
@@ -10,7 +10,6 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow Jasmine globals',
       recommended: 'error',
     },
diff --git a/src/rules/no-jest-import.ts b/src/rules/no-jest-import.ts
@@ -7,7 +7,6 @@ export default createRule({
     type: 'problem',
     docs: {
       description: 'Disallow importing Jest',
-      category: 'Best Practices',
       recommended: 'error',
     },
     messages: {
diff --git a/src/rules/no-large-snapshots.ts b/src/rules/no-large-snapshots.ts
@@ -75,7 +75,6 @@ export default createRule<[RuleOptions], MessageId>({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'disallow large snapshots',
       recommended: false,
     },
diff --git a/src/rules/no-mocks-import.ts b/src/rules/no-mocks-import.ts
@@ -17,7 +17,6 @@ export default createRule({
   meta: {
     type: 'problem',
     docs: {
-      category: 'Best Practices',
       description: 'Disallow manually importing from `__mocks__`',
       recommended: 'error',
     },
diff --git a/src/rules/no-restricted-matchers.ts b/src/rules/no-restricted-matchers.ts
@@ -7,7 +7,6 @@ export default createRule<
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow specific matchers & modifiers',
       recommended: false,
     },
diff --git a/src/rules/no-standalone-expect.ts b/src/rules/no-standalone-expect.ts
@@ -55,7 +55,6 @@ export default createRule<
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow using `expect` outside of `it` or `test` blocks',
       recommended: 'error',
     },
diff --git a/src/rules/no-test-prefixes.ts b/src/rules/no-test-prefixes.ts
@@ -10,7 +10,6 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Use `.only` and `.skip` over `f` and `x`',
       recommended: 'error',
     },
diff --git a/src/rules/no-test-return-statement.ts b/src/rules/no-test-return-statement.ts
@@ -27,7 +27,6 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow explicitly returning from tests',
       recommended: false,
     },
diff --git a/src/rules/prefer-called-with.ts b/src/rules/prefer-called-with.ts
@@ -4,7 +4,6 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description:
         'Suggest using `toBeCalledWith()` or `toHaveBeenCalledWith()`',
       recommended: false,
diff --git a/src/rules/prefer-expect-assertions.ts b/src/rules/prefer-expect-assertions.ts
@@ -64,7 +64,6 @@ export default createRule<[RuleOptions], MessageIds>({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description:
         'Suggest using `expect.assertions()` OR `expect.hasAssertions()`',
       recommended: false,
diff --git a/src/rules/prefer-expect-resolves.ts b/src/rules/prefer-expect-resolves.ts
@@ -8,7 +8,6 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description:
         'Prefer `await expect(...).resolves` over `expect(await ...)` syntax',
       recommended: false,
diff --git a/src/rules/prefer-hooks-on-top.ts b/src/rules/prefer-hooks-on-top.ts
@@ -4,7 +4,6 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Suggest having hooks before any test cases',
       recommended: false,
     },
diff --git a/src/rules/prefer-lowercase-title.ts b/src/rules/prefer-lowercase-title.ts
@@ -67,7 +67,6 @@ export default createRule<
     type: 'suggestion',
     docs: {
       description: 'Enforce lowercase test names',
-      category: 'Best Practices',
       recommended: false,
     },
     fixable: 'code',
diff --git a/src/rules/prefer-spy-on.ts b/src/rules/prefer-spy-on.ts
@@ -46,7 +46,6 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Suggest using `jest.spyOn()`',
       recommended: false,
     },
diff --git a/src/rules/prefer-strict-equal.ts b/src/rules/prefer-strict-equal.ts
@@ -10,7 +10,6 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Suggest using `toStrictEqual()`',
       recommended: false,
       suggestion: true,
@@ -20,6 +19,7 @@ export default createRule({
       suggestReplaceWithStrictEqual: 'Replace with `toStrictEqual()`',
     },
     type: 'suggestion',
+    hasSuggestions: true,
     schema: [],
     hasSuggestions: true,
   },
diff --git a/src/rules/prefer-to-be.ts b/src/rules/prefer-to-be.ts
@@ -92,7 +92,6 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Suggest using `toBe()` for primitive literals',
       recommended: false,
     },
diff --git a/src/rules/prefer-to-contain.ts b/src/rules/prefer-to-contain.ts
diff --git a/src/rules/prefer-to-have-length.ts b/src/rules/prefer-to-have-length.ts
diff --git a/src/rules/prefer-todo.ts b/src/rules/prefer-todo.ts
diff --git a/src/rules/require-hook.ts b/src/rules/require-hook.ts
diff --git a/src/rules/require-to-throw-message.ts b/src/rules/require-to-throw-message.ts
diff --git a/src/rules/require-top-level-describe.ts b/src/rules/require-top-level-describe.ts
diff --git a/src/rules/unbound-method.ts b/src/rules/unbound-method.ts
diff --git a/src/rules/valid-describe-callback.ts b/src/rules/valid-describe-callback.ts
diff --git a/src/rules/valid-expect-in-promise.ts b/src/rules/valid-expect-in-promise.ts
diff --git a/src/rules/valid-expect.ts b/src/rules/valid-expect.ts
diff --git a/src/rules/valid-title.ts b/src/rules/valid-title.ts
diff --git a/yarn.lock b/yarn.lock
