feat: support ESLint 8.x

jest-community · Aug 28, 2021 · c80aa77 · c80aa77
1 parent 9b73aa5
commit c80aa77
Show file tree

Hide file tree

Showing 51 changed files with 294 additions and 228 deletions.
diff --git a/.github/workflows/nodejs.yml b/.github/workflows/nodejs.yml
@@ -18,9 +18,9 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
-      - uses: actions/setup-node@v2.4.0
+      - uses: actions/setup-node@v2
         with:
-          node-version: 14.x
+          node-version: 16
           cache: yarn
 
       - name: Validate cache
@@ -36,9 +36,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2.4.0
+      - uses: actions/setup-node@v2
         with:
-          node-version: 14.x
+          node-version: 16
           cache: yarn
       - name: install
         run: yarn
@@ -50,9 +50,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2.4.0
+      - uses: actions/setup-node@v2
         with:
-          node-version: 14.x
+          node-version: 16
           cache: yarn
       - name: install
         run: yarn
@@ -67,14 +67,14 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: [10.x, 12.x, 14.x, 15.x, 16.x]
-        eslint-version: [5, 6, 7]
+        node-version: [10, 12, 14, 16]
+        eslint-version: [5, 6, 7, '^8.0.0-0']
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v2
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2.4.0
+        uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node-version }}
           cache: yarn
@@ -84,11 +84,11 @@ jobs:
           yarn add --dev eslint@${{ matrix.eslint-version }}
       - name: run tests
         # only collect coverage on eslint versions that support the suggestions api
-        run: yarn test --coverage ${{ matrix.eslint-version >= 6 }}
+        run: yarn test --coverage ${{ matrix.eslint-version >= 6 || matrix.eslint-version = '^8.0.0-0' }}
         env:
           CI: true
-      - uses: codecov/codecov-action@v2.0.2
-        if: ${{ matrix.eslint-version >= 6 }}
+      - uses: codecov/codecov-action@v2
+        if: ${{ matrix.eslint-version >= 6 || matrix.eslint-version = '^8.0.0-0' }}
   test-os:
     name: Test on ${{ matrix.os }} using Node.js LTS
     needs: prepare-yarn-cache
@@ -100,9 +100,9 @@ jobs:
 
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2.4.0
+      - uses: actions/setup-node@v2
         with:
-          node-version: 14.x
+          node-version: 16
           cache: yarn
       - name: install
         run: yarn
@@ -117,9 +117,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2.4.0
+      - uses: actions/setup-node@v2
         with:
-          node-version: 14.x
+          node-version: 16
           cache: yarn
       - name: install
         run: yarn
@@ -140,9 +140,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2.4.0
+      - 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
@@ -79,7 +79,7 @@
     ]
   },
   "dependencies": {
-    "@typescript-eslint/experimental-utils": "^4.0.1"
+    "@typescript-eslint/experimental-utils": "^5.0.0-0"
   },
   "devDependencies": {
     "@babel/cli": "^7.4.4",
@@ -95,19 +95,19 @@
     "@types/jest": "^27.0.0",
     "@types/node": "^14.0.0",
     "@types/prettier": "^2.0.0",
-    "@typescript-eslint/eslint-plugin": "^4.0.1",
-    "@typescript-eslint/parser": "^4.0.1",
+    "@typescript-eslint/eslint-plugin": "^5.0.0-0",
+    "@typescript-eslint/parser": "^5.0.0-0",
     "babel-jest": "^27.0.0",
     "babel-plugin-replace-ts-export-assignment": "^0.0.2",
     "dedent": "^0.7.0",
-    "eslint": "^5.1.0 || ^6.0.0 || ^7.0.0",
-    "eslint-config-prettier": "^6.5.0",
-    "eslint-plugin-eslint-comments": "^3.1.2",
+    "eslint": "^5.1.0 || ^6.0.0 || ^7.0.0 || ^8.0.0-0",
+    "eslint-config-prettier": "^6.15.0",
+    "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-eslint-config": "^2.0.0",
-    "eslint-plugin-eslint-plugin": "^2.0.0",
-    "eslint-plugin-import": "^2.20.2",
-    "eslint-plugin-node": "^11.0.0",
-    "eslint-plugin-prettier": "^3.0.0",
+    "eslint-plugin-eslint-plugin": "^2.3.0",
+    "eslint-plugin-import": "^2.24.2",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^3.4.1",
     "husky": "^6.0.0",
     "is-ci": "^3.0.0",
     "jest": "^27.0.0",
@@ -122,7 +122,7 @@
     "typescript": "^4.0.0"
   },
   "peerDependencies": {
-    "@typescript-eslint/eslint-plugin": ">= 4",
+    "@typescript-eslint/eslint-plugin": ">=4",
     "eslint": ">=5"
   },
   "peerDependenciesMeta": {

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'>>;
 };
 
-// can be removed once we've on v3: https://github.com/typescript-eslint/typescript-eslint/issues/2060
-declare module '@typescript-eslint/experimental-utils/dist/ts-eslint/Rule' {
-  export interface RuleMetaDataDocs {
-    suggestion?: boolean;
-  }
-}
-
 // 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/lowercase-name.ts b/src/rules/lowercase-name.ts
@@ -51,7 +51,6 @@ export default createRule<
     type: 'suggestion',
     docs: {
       description: 'Enforce lowercase test names',
-      category: 'Best Practices',
       recommended: false,
     },
     fixable: 'code',

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
@@ -65,7 +65,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-expect-resolves.ts b/src/rules/no-expect-resolves.ts
@@ -9,7 +9,6 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow expect.resolves',
       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/no-truthy-falsy.ts b/src/rules/no-truthy-falsy.ts
@@ -5,7 +5,6 @@ export default createRule({
   name: __filename,
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow using `toBeTruthy()` & `toBeFalsy()`',
       recommended: false,
     },

diff --git a/src/rules/no-try-expect.ts b/src/rules/no-try-expect.ts
@@ -11,7 +11,6 @@ export default createRule({
   meta: {
     docs: {
       description: 'Prefer using toThrow for exception tests',
-      category: 'Best Practices',
       recommended: 'error',
     },
     deprecated: true,