eslint-plugin-jest 26.1.2 → 26.1.5

package/README.md

@@ -59,6 +59,34 @@ doing:
 This is included in all configs shared by this plugin, so can be omitted if
 extending them.
 
+### Running rules only on test-related files
+
+The rules provided by this plugin assume that the files they are checking are
+test-related. This means it's generally not suitable to include them in your
+top-level configuration as that applies to all files being linted which can
+include source files.
+
+You can use
+[overrides](https://eslint.org/docs/user-guide/configuring/configuration-files#how-do-overrides-work)
+to have ESLint apply additional rules to specific files:
+
+```json
+{
+  "extends": ["eslint:recommended"],
+  "overrides": [
+    {
+      "files": ["test/**"],
+      "plugins": ["jest"],
+      "extends": ["plugin:jest/recommended"],
+      "rules": { "jest/prefer-expect-assertions": "off" }
+    }
+  ],
+  "rules": {
+    "indent": ["error", 2]
+  }
+}
+```
+
 ### Jest `version` setting
 
 The behaviour of some rules (specifically [`no-deprecated-functions`][]) change
@@ -211,8 +239,8 @@ adjust your eslint config as outlined
 
 Note that unlike the type-checking rules in `@typescript-eslint/eslint-plugin`,
 the rules here will fallback to doing nothing if type information is not
-available, meaning its safe to include them in shared configs that could be used
-on JavaScript and TypeScript projects.
+available, meaning it's safe to include them in shared configs that could be
+used on JavaScript and TypeScript projects.
 
 Also note that `unbound-method` depends on `@typescript-eslint/eslint-plugin`,
 as it extends the original `unbound-method` rule from that plugin.

package/docs/rules/no-conditional-expect.md

@@ -107,7 +107,7 @@ While you can use `expect.assertions` & `expect.hasAssertions` for these
 situations, they only work with `expect`.
 
 A better way to handle this situation is to introduce a wrapper to handle the
-catching, and otherwise returns a specific "no error thrown" error if nothing is
+catching, and otherwise return a specific "no error thrown" error if nothing is
 thrown by the wrapped function:
 
 ```typescript

package/docs/rules/no-deprecated-functions.md

@@ -37,8 +37,7 @@ Originally, the `requireActual` & `requireMock` the `requireActual`&
 
 These functions were later moved onto the `jest` object in order to be easier
 for type checkers to handle, and their use via `require` deprecated. Finally,
-the release of Jest 26 saw them removed from the `require` function all
-together.
+the release of Jest 26 saw them removed from the `require` function altogether.
 
 ### `jest.runTimersToTime`
 

package/docs/rules/no-identical-title.md

@@ -7,7 +7,7 @@ fix.
 
 ## Rule Details
 
-This rule looks at the title of every test and test suites. It will report when
+This rule looks at the title of every test and test suite. It will report when
 two test suites or two test cases at the same level of a test suite have the
 same title.
 

package/docs/rules/no-jasmine-globals.md

@@ -9,8 +9,8 @@ API.
 
 ### Rule details
 
-This rule reports on any usage of Jasmine globals which is not ported to Jest,
-and suggests alternative from Jest's own API.
+This rule reports on any usage of Jasmine globals, which is not ported to Jest,
+and suggests alternatives from Jest's own API.
 
 ### Default configuration
 

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

@@ -17,4 +17,4 @@ first place.
 
 ## Further Reading
 
-\*[The Jest Object](https://facebook.github.io/jest/docs/en/jest-object.html)
+- [The Jest Object](https://facebook.github.io/jest/docs/en/jest-object.html)

package/docs/rules/no-large-snapshots.md

@@ -118,8 +118,8 @@ External). Use `inlineMaxSize` for
 [Inline Snapshots](https://jestjs.io/docs/en/snapshot-testing#inline-snapshots)
 size and `maxSize` for
 [External Snapshots](https://jestjs.io/docs/en/snapshot-testing#snapshot-testing-with-jest).
-If only `maxSize` is provided on options, the value of `maxSize` will be used to
-both snapshot types (Inline and External).
+If only `maxSize` is provided on options, the value of `maxSize` will be used
+for both snapshot types (Inline and External).
 
 Since `eslint-disable` comments are not preserved by Jest when updating
 snapshots, you can use the `allowedSnapshots` option to have specific snapshots

package/docs/rules/no-standalone-expect.md

@@ -61,7 +61,7 @@ describe('a test', () => {
 ```
 
 \*Note that this rule will not trigger if the helper function is never used even
-thought the `expect` will not execute. Rely on a rule like no-unused-vars for
+though the `expect` will not execute. Rely on a rule like no-unused-vars for
 this case.
 
 ### Options

package/docs/rules/prefer-comparison-matcher.md

@@ -1,6 +1,6 @@
 # Suggest using the built-in comparison matchers (`prefer-comparison-matcher`)
 
-Jest has a number of built-in matchers for comparing numbers which allow for
+Jest has a number of built-in matchers for comparing numbers, which allow for
 more readable tests and error messages if an expectation fails.
 
 ## Rule details

package/docs/rules/prefer-equality-matcher.md

@@ -1,6 +1,6 @@
 # Suggest using the built-in equality matchers (`prefer-equality-matcher`)
 
-Jest has built-in matchers for expecting equality which allow for more readable
+Jest has built-in matchers for expecting equality, which allow for more readable
 tests and error messages if an expectation fails.
 
 ## Rule details

package/docs/rules/prefer-expect-assertions.md

@@ -215,7 +215,7 @@ describe('getNumbers', () => {
 
 describe('/users', () => {
   it.each([1, 2, 3])('returns ok', id => {
-    expect.assertions(3);
+    expect.assertions(1);
 
     client.get(`/users/${id}`, response => {
       expect(response.status).toBe(200);

package/docs/rules/prefer-hooks-on-top.md

@@ -1,7 +1,7 @@
 # Suggest having hooks before any test cases (`prefer-hooks-on-top`)
 
 While hooks can be setup anywhere in a test file, they are always called in a
-specific order which means it can be confusing if they're intermixed with test
+specific order, which means it can be confusing if they're intermixed with test
 cases.
 
 This rule helps to ensure that hooks are always defined before test cases.

package/docs/rules/prefer-lowercase-title.md

@@ -73,8 +73,8 @@ it('Uppercase description');
 
 ### `allowedPrefixes`
 
-This array option allows specifying prefixes which contain capitals that titles
-can start with. This can be useful when writing tests for api endpoints, where
+This array option allows specifying prefixes, which contain capitals that titles
+can start with. This can be useful when writing tests for API endpoints, where
 you'd like to prefix with the HTTP method.
 
 By default, nothing is allowed (the equivalent of `{ "allowedPrefixes": [] }`).

package/docs/rules/valid-expect.md

@@ -136,9 +136,9 @@ test('all the things', async () => {
   await Promise.resolve(
     expect(Promise.resolve('hello')).resolves.toEqual('hello'),
   );
-  await Promise.all(
+  await Promise.all([
     expect(Promise.resolve('hello')).resolves.toEqual('hello'),
     expect(Promise.resolve('hi')).resolves.toEqual('hi'),
-  );
+  ]);
 });
 ```

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

@@ -137,6 +137,8 @@ var _default = (0, _utils2.createRule)({
           return;
         }
 
+        inTestCaseCall = false;
+
         if (node.arguments.length < 2) {
           return;
         }

package/lib/rules/prefer-snapshot-hint.js

@@ -59,6 +59,7 @@ var _default = (0, _utils.createRule)({
 
   create(context, [mode]) {
     const snapshotMatchers = [];
+    const depths = [];
     let expressionDepth = 0;
 
     const reportSnapshotMatchersWithoutHints = () => {
@@ -104,7 +105,21 @@ var _default = (0, _utils.createRule)({
       ArrowFunctionExpression: enterExpression,
       'ArrowFunctionExpression:exit': exitExpression,
 
+      'CallExpression:exit'(node) {
+        if ((0, _utils.isDescribeCall)(node) || (0, _utils.isTestCaseCall)(node)) {
+          var _depths$pop;
+
+          /* istanbul ignore next */
+          expressionDepth = (_depths$pop = depths.pop()) !== null && _depths$pop !== void 0 ? _depths$pop : 0;
+        }
+      },
+
       CallExpression(node) {
+        if ((0, _utils.isDescribeCall)(node) || (0, _utils.isTestCaseCall)(node)) {
+          depths.push(expressionDepth);
+          expressionDepth = 0;
+        }
+
         if (!(0, _utils.isExpectCall)(node)) {
           return;
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-jest",
-  "version": "26.1.2",
+  "version": "26.1.5",
   "description": "ESLint rules for Jest",
   "keywords": [
     "eslint",
@@ -111,8 +111,8 @@
     "eslint-plugin-import": "^2.25.1",
     "eslint-plugin-node": "^11.0.0",
     "eslint-plugin-prettier": "^3.4.1",
-    "eslint-remote-tester": "^2.1.0",
-    "eslint-remote-tester-repositories": "^0.0.4",
+    "eslint-remote-tester": "^2.1.3",
+    "eslint-remote-tester-repositories": "^0.0.5",
     "husky": "^7.0.2",
     "is-ci": "^3.0.0",
     "jest": "^27.0.0",
@@ -139,7 +139,7 @@
     }
   },
   "engines": {
-    "node": "^12.13.0 || ^14.15.0 || >=16.0.0"
+    "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
   },
   "release": {
     "branches": [