feat: support ESLint 8.x

Author: MichaelDeBoey

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

.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

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": {

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 } =>

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

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

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

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

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

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