eslint-plugin-jest 27.0.0-next.1 → 27.0.1

package/README.md

@@ -203,7 +203,7 @@ installations requiring long-term consistency.
 | [expect-expect](docs/rules/expect-expect.md)                                 | Enforce assertion to be made in a test body                         | ![recommended][] |              |
 | [max-expects](docs/rules/max-expects.md)                                     | Enforces a maximum number assertion calls in a test body            |                  |              |
 | [max-nested-describe](docs/rules/max-nested-describe.md)                     | Enforces a maximum depth to nested describe calls                   |                  |              |
-| [no-alias-methods](docs/rules/no-alias-methods.md)                           | Disallow alias methods                                              | ![style][]       | ![fixable][] |
+| [no-alias-methods](docs/rules/no-alias-methods.md)                           | Disallow alias methods                                              | ![recommended][] | ![fixable][] |
 | [no-commented-out-tests](docs/rules/no-commented-out-tests.md)               | Disallow commented out tests                                        | ![recommended][] |              |
 | [no-conditional-expect](docs/rules/no-conditional-expect.md)                 | Prevent calling `expect` conditionally                              | ![recommended][] |              |
 | [no-conditional-in-test](docs/rules/no-conditional-in-test.md)               | Disallow conditional logic in tests                                 |                  |              |
@@ -217,7 +217,6 @@ installations requiring long-term consistency.
 | [no-identical-title](docs/rules/no-identical-title.md)                       | Disallow identical titles                                           | ![recommended][] |              |
 | [no-interpolation-in-snapshots](docs/rules/no-interpolation-in-snapshots.md) | Disallow string interpolation inside snapshots                      | ![recommended][] |              |
 | [no-jasmine-globals](docs/rules/no-jasmine-globals.md)                       | Disallow Jasmine globals                                            | ![recommended][] | ![fixable][] |
-| [no-jest-import](docs/rules/no-jest-import.md)                               | Disallow importing Jest                                             | ![recommended][] |              |
 | [no-large-snapshots](docs/rules/no-large-snapshots.md)                       | disallow large snapshots                                            |                  |              |
 | [no-mocks-import](docs/rules/no-mocks-import.md)                             | Disallow manually importing from `__mocks__`                        | ![recommended][] |              |
 | [no-restricted-matchers](docs/rules/no-restricted-matchers.md)               | Disallow specific matchers & modifiers                              |                  |              |
@@ -226,6 +225,7 @@ installations requiring long-term consistency.
 | [no-test-return-statement](docs/rules/no-test-return-statement.md)           | Disallow explicitly returning from tests                            |                  |              |
 | [prefer-called-with](docs/rules/prefer-called-with.md)                       | Suggest using `toBeCalledWith()` or `toHaveBeenCalledWith()`        |                  |              |
 | [prefer-comparison-matcher](docs/rules/prefer-comparison-matcher.md)         | Suggest using the built-in comparison matchers                      |                  | ![fixable][] |
+| [prefer-each](docs/rules/prefer-each.md)                                     | Prefer using `.each` rather than manual loops                       |                  |              |
 | [prefer-equality-matcher](docs/rules/prefer-equality-matcher.md)             | Suggest using the built-in equality matchers                        |                  | ![suggest][] |
 | [prefer-expect-assertions](docs/rules/prefer-expect-assertions.md)           | Suggest using `expect.assertions()` OR `expect.hasAssertions()`     |                  | ![suggest][] |
 | [prefer-expect-resolves](docs/rules/prefer-expect-resolves.md)               | Prefer `await expect(...).resolves` over `expect(await ...)` syntax |                  | ![fixable][] |

package/docs/rules/no-alias-methods.md

@@ -1,5 +1,8 @@
 # Disallow alias methods (`no-alias-methods`)
 
+> These aliases are going to be removed in the next major version of Jest - see
+> https://github.com/facebook/jest/issues/13164 for more
+
 Several Jest methods have alias names, such as `toThrow` having the alias of
 `toThrowError`. This rule ensures that only the canonical name as used in the
 Jest documentation is used in the code. This makes it easier to search for all

package/docs/rules/no-restricted-matchers.md

@@ -8,8 +8,9 @@ alternatives.
 Bans are expressed in the form of a map, with the value being either a string
 message to be shown, or `null` if the default rule message should be used.
 
-Both matchers, modifiers, and chains of the two are checked, allowing for
-specific variations of a matcher to be banned if desired.
+Bans are checked against the start of the `expect` chain - this means that to
+ban a specific matcher entirely you must specify all six permutations, but
+allows you to ban modifiers as well.
 
 By default, this map is empty, meaning no matchers or modifiers are banned.
 
@@ -22,7 +23,12 @@ For example:
     {
       "toBeFalsy": null,
       "resolves": "Use `expect(await promise)` instead.",
-      "not.toHaveBeenCalledWith": null
+      "toHaveBeenCalledWith": null,
+      "not.toHaveBeenCalledWith": null,
+      "resolves.toHaveBeenCalledWith": null,
+      "rejects.toHaveBeenCalledWith": null,
+      "resolves.not.toHaveBeenCalledWith": null,
+      "rejects.not.toHaveBeenCalledWith": null
     }
   ]
 }
@@ -32,15 +38,18 @@ Examples of **incorrect** code for this rule with the above configuration
 
 ```js
 it('is false', () => {
+  // if this has a modifer (i.e. `not.toBeFalsy`), it would be considered fine
   expect(a).toBeFalsy();
 });
 
 it('resolves', async () => {
+  // all uses of this modifier are disallowed, regardless of matcher
   await expect(myPromise()).resolves.toBe(true);
 });
 
 describe('when an error happens', () => {
   it('does not upload the file', async () => {
+    // all uses of this matcher are disallowed
     expect(uploadFileMock).not.toHaveBeenCalledWith('file.name');
   });
 });

package/docs/rules/prefer-each.md

@@ -0,0 +1,54 @@
+# Prefer using `.each` rather than manual loops (`prefer-each`)
+
+Reports where you might be able to use `.each` instead of native loops.
+
+## Rule details
+
+This rule triggers a warning if you use test case functions like `describe`,
+`test`, and `it`, in a native loop - generally you should be able to use `.each`
+instead which gives better output and makes it easier to run specific cases.
+
+Examples of **incorrect** code for this rule:
+
+```js
+for (const number of getNumbers()) {
+  it('is greater than five', function () {
+    expect(number).toBeGreaterThan(5);
+  });
+}
+
+for (const [input, expected] of data) {
+  beforeEach(() => setupSomething(input));
+
+  test(`results in ${expected}`, () => {
+    expect(doSomething()).toBe(expected);
+  });
+}
+```
+
+Examples of **correct** code for this rule:
+
+```js
+it.each(getNumbers())(
+  'only returns numbers that are greater than seven',
+  number => {
+    expect(number).toBeGreaterThan(7);
+  },
+);
+
+describe.each(data)('when input is %s', ([input, expected]) => {
+  beforeEach(() => setupSomething(input));
+
+  test(`results in ${expected}`, () => {
+    expect(doSomething()).toBe(expected);
+  });
+});
+
+// we don't warn on loops _in_ test functions because those typically involve
+// complex setup that is better done in the test function itself
+it('returns numbers that are greater than five', () => {
+  for (const number of getNumbers()) {
+    expect(number).toBeGreaterThan(5);
+  }
+});
+```

package/lib/rules/no-alias-methods.js

@@ -13,7 +13,7 @@ var _default = (0, _utils.createRule)({
     docs: {
       category: 'Best Practices',
       description: 'Disallow alias methods',
-      recommended: false
+      recommended: 'error'
     },
     messages: {
       replaceAlias: `Replace {{ alias }}() with its canonical name of {{ canonical }}()`

package/lib/rules/no-done-callback.js

@@ -33,8 +33,7 @@ var _default = (0, _utils2.createRule)({
     docs: {
       category: 'Best Practices',
       description: 'Avoid using a callback in asynchronous tests and hooks',
-      recommended: 'error',
-      suggestion: true
+      recommended: 'error'
     },
     messages: {
       noDoneCallback: 'Return a Promise instead of relying on callback parameter',

package/lib/rules/no-focused-tests.js

@@ -15,8 +15,7 @@ var _default = (0, _utils2.createRule)({
     docs: {
       category: 'Best Practices',
       description: 'Disallow focused tests',
-      recommended: 'error',
-      suggestion: true
+      recommended: 'error'
     },
     messages: {
       focusedTest: 'Unexpected focused test.',

package/lib/rules/no-restricted-matchers.js

@@ -23,7 +23,7 @@ var _default = (0, _utils.createRule)({
       }
     }],
     messages: {
-      restrictedChain: 'Use of `{{ chain }}` is disallowed',
+      restrictedChain: 'Use of `{{ restriction }}` is disallowed',
       restrictedChainWithMessage: '{{ message }}'
     }
   },
@@ -38,31 +38,19 @@ var _default = (0, _utils.createRule)({
           return;
         }
 
-        const permutations = [jestFnCall.members];
+        const chain = jestFnCall.members.map(nod => (0, _utils.getAccessorValue)(nod)).join('.');
 
-        if (jestFnCall.members.length > 2) {
-          permutations.push([jestFnCall.members[0], jestFnCall.members[1]]);
-          permutations.push([jestFnCall.members[1], jestFnCall.members[2]]);
-        }
-
-        if (jestFnCall.members.length > 1) {
-          permutations.push(...jestFnCall.members.map(nod => [nod]));
-        }
-
-        for (const permutation of permutations) {
-          const chain = permutation.map(nod => (0, _utils.getAccessorValue)(nod)).join('.');
-
-          if (chain in restrictedChains) {
-            const message = restrictedChains[chain];
+        for (const [restriction, message] of Object.entries(restrictedChains)) {
+          if (chain.startsWith(restriction)) {
             context.report({
               messageId: message ? 'restrictedChainWithMessage' : 'restrictedChain',
               data: {
                 message,
-                chain
+                restriction
               },
               loc: {
-                start: permutation[0].loc.start,
-                end: permutation[permutation.length - 1].loc.end
+                start: jestFnCall.members[0].loc.start,
+                end: jestFnCall.members[jestFnCall.members.length - 1].loc.end
               }
             });
             break;

package/lib/rules/prefer-each.js

@@ -0,0 +1,98 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _utils = require("./utils");
+
+var _default = (0, _utils.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'
+    },
+    type: 'suggestion',
+    schema: []
+  },
+  defaultOptions: [],
+
+  create(context) {
+    const jestFnCalls = [];
+    let inTestCaseCall = false;
+
+    const recommendFn = () => {
+      if (jestFnCalls.length === 1 && jestFnCalls[0] === 'test') {
+        return 'it';
+      }
+
+      return 'describe';
+    };
+
+    const enterForLoop = () => {
+      if (jestFnCalls.length === 0 || inTestCaseCall) {
+        return;
+      }
+
+      jestFnCalls.length = 0;
+    };
+
+    const exitForLoop = node => {
+      if (jestFnCalls.length === 0 || inTestCaseCall) {
+        return;
+      }
+
+      context.report({
+        node,
+        messageId: 'preferEach',
+        data: {
+          fn: recommendFn()
+        }
+      });
+      jestFnCalls.length = 0;
+    };
+
+    return {
+      ForStatement: enterForLoop,
+      'ForStatement:exit': exitForLoop,
+      ForInStatement: enterForLoop,
+      'ForInStatement:exit': exitForLoop,
+      ForOfStatement: enterForLoop,
+      'ForOfStatement:exit': exitForLoop,
+
+      CallExpression(node) {
+        const {
+          type: jestFnCallType
+        } = (0, _utils.parseJestFnCall)(node, context) ?? {};
+
+        if (jestFnCallType === 'hook' || jestFnCallType === 'describe' || jestFnCallType === 'test') {
+          jestFnCalls.push(jestFnCallType);
+        }
+
+        if (jestFnCallType === 'test') {
+          inTestCaseCall = true;
+        }
+      },
+
+      'CallExpression:exit'(node) {
+        const {
+          type: jestFnCallType
+        } = (0, _utils.parseJestFnCall)(node, context) ?? {};
+
+        if (jestFnCallType === 'test') {
+          inTestCaseCall = false;
+        }
+      }
+
+    };
+  }
+
+});
+
+exports.default = _default;

package/lib/rules/prefer-equality-matcher.js

@@ -15,8 +15,7 @@ var _default = (0, _utils2.createRule)({
     docs: {
       category: 'Best Practices',
       description: 'Suggest using the built-in equality matchers',
-      recommended: false,
-      suggestion: true
+      recommended: false
     },
     messages: {
       useEqualityMatcher: 'Prefer using one of the equality matchers instead',

package/lib/rules/prefer-expect-assertions.js

@@ -13,10 +13,16 @@ const isFirstStatement = node => {
   let parent = node;
 
   while (parent) {
-    var _parent$parent;
+    var _parent$parent, _parent$parent2;
 
     if (((_parent$parent = parent.parent) === null || _parent$parent === void 0 ? void 0 : _parent$parent.type) === _utils.AST_NODE_TYPES.BlockStatement) {
       return parent.parent.body[0] === parent;
+    } // if we've hit an arrow function, then it must have a single expression
+    // as its body, as otherwise we would have hit the block statement already
+
+
+    if (((_parent$parent2 = parent.parent) === null || _parent$parent2 === void 0 ? void 0 : _parent$parent2.type) === _utils.AST_NODE_TYPES.ArrowFunctionExpression) {
+      return true;
     }
 
     parent = parent.parent;
@@ -32,18 +38,13 @@ const suggestRemovingExtraArguments = (args, extraArgsStartAt) => ({
   fix: fixer => fixer.removeRange([args[extraArgsStartAt].range[0] - Math.sign(extraArgsStartAt), args[args.length - 1].range[1]])
 });
 
-// const suggestions: Array<[MessageIds, string]> = [
-//   ['suggestAddingHasAssertions', 'expect.hasAssertions();'],
-//   ['suggestAddingAssertions', 'expect.assertions();'],
-// ];
 var _default = (0, _utils2.createRule)({
   name: __filename,
   meta: {
     docs: {
       category: 'Best Practices',
       description: 'Suggest using `expect.assertions()` OR `expect.hasAssertions()`',
-      recommended: false,
-      suggestion: true
+      recommended: false
     },
     messages: {
       hasAssertionsTakesNoArguments: '`expect.hasAssertions` expects no arguments',

package/lib/rules/prefer-strict-equal.js

@@ -13,8 +13,7 @@ var _default = (0, _utils.createRule)({
     docs: {
       category: 'Best Practices',
       description: 'Suggest using `toStrictEqual()`',
-      recommended: false,
-      suggestion: true
+      recommended: false
     },
     messages: {
       useToStrictEqual: 'Use `toStrictEqual()` instead',

package/lib/rules/unbound-method.js

@@ -28,14 +28,6 @@ const baseRule = (() => {
   }
 })();
 
-const tryCreateBaseRule = context => {
-  try {
-    return baseRule === null || baseRule === void 0 ? void 0 : baseRule.create(context);
-  } catch {
-    return null;
-  }
-};
-
 const DEFAULT_MESSAGE = 'This rule requires `@typescript-eslint/eslint-plugin`';
 
 var _default = (0, _utils2.createRule)({
@@ -62,7 +54,7 @@ var _default = (0, _utils2.createRule)({
   },
 
   create(context) {
-    const baseSelectors = tryCreateBaseRule(context);
+    const baseSelectors = baseRule === null || baseRule === void 0 ? void 0 : baseRule.create(context);
 
     if (!baseSelectors) {
       return {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-jest",
-  "version": "27.0.0-next.1",
+  "version": "27.0.1",
   "description": "ESLint rules for Jest",
   "keywords": [
     "eslint",
@@ -103,34 +103,34 @@
     "@babel/core": "^7.4.4",
     "@babel/preset-env": "^7.4.4",
     "@babel/preset-typescript": "^7.3.3",
-    "@commitlint/cli": "^16.0.0",
-    "@commitlint/config-conventional": "^16.0.0",
+    "@commitlint/cli": "^17.0.3",
+    "@commitlint/config-conventional": "^17.0.3",
     "@schemastore/package": "^0.0.6",
     "@semantic-release/changelog": "^6.0.0",
     "@semantic-release/git": "^10.0.0",
     "@types/dedent": "^0.7.0",
     "@types/jest": "^28.0.0",
-    "@types/node": "^16.0.0",
+    "@types/node": "^14.18.26",
     "@types/prettier": "^2.0.0",
     "@typescript-eslint/eslint-plugin": "^5.0.0",
     "@typescript-eslint/parser": "^5.0.0",
-    "babel-jest": "^28.0.0",
+    "babel-jest": "^29.0.0",
     "babel-plugin-replace-ts-export-assignment": "^0.0.2",
     "dedent": "^0.7.0",
     "eslint": "^6.0.0 || ^7.0.0 || ^8.0.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-eslint-comments": "^3.1.2",
-    "eslint-plugin-eslint-plugin": "^4.0.0",
+    "eslint-plugin-eslint-plugin": "^5.0.6",
     "eslint-plugin-import": "^2.25.1",
     "eslint-plugin-node": "^11.0.0",
-    "eslint-plugin-prettier": "^3.4.1",
+    "eslint-plugin-prettier": "^4.2.1",
     "eslint-remote-tester": "^3.0.0",
     "eslint-remote-tester-repositories": "~0.0.5",
-    "husky": "^7.0.2",
+    "husky": "^8.0.1",
     "is-ci": "^3.0.0",
-    "jest": "^28.0.0",
-    "jest-runner-eslint": "^1.0.0",
-    "lint-staged": "^12.0.0",
+    "jest": "^29.0.0",
+    "jest-runner-eslint": "^1.1.0",
+    "lint-staged": "^13.0.3",
     "pinst": "^3.0.0",
     "prettier": "^2.0.5",
     "rimraf": "^3.0.0",
@@ -151,7 +151,7 @@
       "optional": true
     }
   },
-  "packageManager": "yarn@3.2.2",
+  "packageManager": "yarn@3.2.3",
   "engines": {
     "node": "^14.15.0 || ^16.10.0 || >=18.0.0"
   }

package/docs/rules/no-jest-import.md

@@ -1,20 +0,0 @@
-# Disallow importing Jest (`no-jest-import`)
-
-The `jest` object is automatically in scope within every test file. The methods
-in the `jest` object help create mocks and let you control Jest's overall
-behavior. It is therefore completely unnecessary to import in `jest`, as Jest
-doesn't export anything in the first place.
-
-### Rule details
-
-This rule reports on any importing of Jest.
-
-To name a few: `var jest = require('jest');` `const jest = require('jest');`
-`import jest from 'jest';` `import {jest as test} from 'jest';`
-
-There is no correct usage of this code, other than to not import `jest` in the
-first place.
-
-## Further Reading
-
-- [The Jest Object](https://facebook.github.io/jest/docs/en/jest-object.html)

package/lib/rules/no-jest-import.js

@@ -1,48 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _utils = require("./utils");
-
-var _default = (0, _utils.createRule)({
-  name: __filename,
-  meta: {
-    type: 'problem',
-    docs: {
-      description: 'Disallow importing Jest',
-      category: 'Best Practices',
-      recommended: 'error'
-    },
-    messages: {
-      unexpectedImport: `Jest is automatically in scope. Do not import "jest", as Jest doesn't export anything.`
-    },
-    schema: []
-  },
-  defaultOptions: [],
-
-  create(context) {
-    return {
-      'ImportDeclaration[source.value="jest"]'(node) {
-        context.report({
-          node,
-          messageId: 'unexpectedImport'
-        });
-      },
-
-      'CallExpression[callee.name="require"][arguments.0.value="jest"]'(node) {
-        context.report({
-          loc: node.arguments[0].loc,
-          messageId: 'unexpectedImport',
-          node
-        });
-      }
-
-    };
-  }
-
-});
-
-exports.default = _default;