eslint-plugin-jest 23.11.0 → 23.13.2

package/CHANGELOG.md

@@ -1,3 +1,33 @@
+## [23.13.2](https://github.com/jest-community/eslint-plugin-jest/compare/v23.13.1...v23.13.2) (2020-05-26)
+
+
+### Bug Fixes
+
+* add `fail` to globals ([#595](https://github.com/jest-community/eslint-plugin-jest/issues/595)) ([aadc5ec](https://github.com/jest-community/eslint-plugin-jest/commit/aadc5ec5610ec024eac4b0aa6077cc012a0ba98e))
+
+## [23.13.1](https://github.com/jest-community/eslint-plugin-jest/compare/v23.13.0...v23.13.1) (2020-05-17)
+
+
+### Bug Fixes
+
+* **no-if:** use correct syntax for placeholder substitution in message ([6d1eda8](https://github.com/jest-community/eslint-plugin-jest/commit/6d1eda89ac48c93c2675dcf24a92574a20b2edb9))
+
+# [23.13.0](https://github.com/jest-community/eslint-plugin-jest/compare/v23.12.0...v23.13.0) (2020-05-16)
+
+
+### Features
+
+* **valid-expect:** support `minArgs` & `maxArgs` options ([#584](https://github.com/jest-community/eslint-plugin-jest/issues/584)) ([9e0e2fa](https://github.com/jest-community/eslint-plugin-jest/commit/9e0e2fa966b43c1099d11b2424acb1590c241c03))
+
+# [23.12.0](https://github.com/jest-community/eslint-plugin-jest/compare/v23.11.0...v23.12.0) (2020-05-16)
+
+
+### Features
+
+* deprecate `no-expect-resolves` rule ([b6a22e5](https://github.com/jest-community/eslint-plugin-jest/commit/b6a22e5aa98abcb57aac217c6d4583d0a3388e7b))
+* deprecate `no-truthy-falsy` rule ([a67d92d](https://github.com/jest-community/eslint-plugin-jest/commit/a67d92d2834568122f24bf3d8455999166da95ea))
+* deprecate `prefer-inline-snapshots` rule ([1360e9b](https://github.com/jest-community/eslint-plugin-jest/commit/1360e9b0e840f4f778a9d251371c943919f84600))
+
 # [23.11.0](https://github.com/jest-community/eslint-plugin-jest/compare/v23.10.0...v23.11.0) (2020-05-12)
 
 

package/README.md

@@ -137,7 +137,6 @@ installations requiring long-term consistency.
 | [no-deprecated-functions](docs/rules/no-deprecated-functions.md)       | Disallow use of deprecated functions                            |                  | ![fixable][] |
 | [no-disabled-tests](docs/rules/no-disabled-tests.md)                   | Disallow disabled tests                                         | ![recommended][] |              |
 | [no-duplicate-hooks](docs/rules/no-duplicate-hooks.md)                 | Disallow duplicate setup and teardown hooks                     |                  |              |
-| [no-expect-resolves](docs/rules/no-expect-resolves.md)                 | Disallow expect.resolves                                        |                  |              |
 | [no-export](docs/rules/no-export.md)                                   | Prevent exporting from test files                               | ![recommended][] |              |
 | [no-focused-tests](docs/rules/no-focused-tests.md)                     | Disallow focused tests                                          | ![recommended][] | ![fixable][] |
 | [no-hooks](docs/rules/no-hooks.md)                                     | Disallow setup and teardown hooks                               |                  |              |
@@ -152,12 +151,10 @@ installations requiring long-term consistency.
 | [no-test-callback](docs/rules/no-test-callback.md)                     | Avoid using a callback in asynchronous tests                    | ![recommended][] | ![fixable][] |
 | [no-test-prefixes](docs/rules/no-test-prefixes.md)                     | Use `.only` and `.skip` over `f` and `x`                        | ![recommended][] | ![fixable][] |
 | [no-test-return-statement](docs/rules/no-test-return-statement.md)     | Disallow explicitly returning from tests                        |                  |              |
-| [no-truthy-falsy](docs/rules/no-truthy-falsy.md)                       | Disallow using `toBeTruthy()` & `toBeFalsy()`                   |                  |              |
 | [no-try-expect](docs/rules/no-try-expect.md)                           | Prefer using toThrow for exception tests                        | ![recommended][] |              |
 | [prefer-called-with](docs/rules/prefer-called-with.md)                 | Suggest using `toBeCalledWith()` OR `toHaveBeenCalledWith()`    |                  |              |
 | [prefer-expect-assertions](docs/rules/prefer-expect-assertions.md)     | Suggest using `expect.assertions()` OR `expect.hasAssertions()` |                  |              |
 | [prefer-hooks-on-top](docs/rules/prefer-hooks-on-top.md)               | Suggest to have all hooks at top level                          |                  |              |
-| [prefer-inline-snapshots](docs/rules/prefer-inline-snapshots.md)       | Suggest using inline snapshots                                  |                  | ![fixable][] |
 | [prefer-spy-on](docs/rules/prefer-spy-on.md)                           | Suggest using `jest.spyOn()`                                    |                  | ![fixable][] |
 | [prefer-strict-equal](docs/rules/prefer-strict-equal.md)               | Suggest using toStrictEqual()                                   |                  | ![fixable][] |
 | [prefer-to-be-null](docs/rules/prefer-to-be-null.md)                   | Suggest using `toBeNull()`                                      | ![style][]       | ![fixable][] |

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

@@ -1,4 +1,4 @@
-# Disallow use of deprecated functions (no-deprecated-functions)
+# Disallow use of deprecated functions (`no-deprecated-functions`)
 
 Over the years Jest has accrued some debt in the form of functions that have
 either been renamed for clarity, or replaced with more powerful APIs.

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

@@ -1,5 +1,23 @@
 # Avoid using `expect().resolves` (`no-expect-resolves`)
 
+## Deprecated
+
+This rule has been deprecated in favor of
+[`no-restricted-matchers`](no-restricted-matchers.md) with the following config:
+
+```json
+{
+  "rules": {
+    "jest/no-restricted-matchers": [
+      "error",
+      { "resolves": "Use `expect(await promise)` instead." }
+    ]
+  }
+}
+```
+
+---
+
 Jest allows you to test a promise resolve value using `await expect().resolves`.
 For consistency and readability this rule bans `expect().resolves` in favor of
 `expect(await promise)`.

package/docs/rules/no-truthy-falsy.md

@@ -1,5 +1,26 @@
 # Disallow using `toBeTruthy()` & `toBeFalsy()` (`no-truthy-falsy`)
 
+## Deprecated
+
+This rule has been deprecated in favor of
+[`no-restricted-matchers`](no-restricted-matchers.md) with the following config:
+
+```json
+{
+  "rules": {
+    "jest/no-restricted-matchers": [
+      "error",
+      {
+        "toBeTruthy": "Avoid `toBeTruthy`",
+        "toBeFalsy": "Avoid `toBeFalsy`"
+      }
+    ]
+  }
+}
+```
+
+---
+
 Tests against boolean values should assert true or false. Asserting `toBeTruthy`
 or `toBeFalsy` matches non-boolean values as well and encourages weaker tests.
 

package/docs/rules/prefer-inline-snapshots.md

@@ -1,5 +1,26 @@
 # Suggest using inline snapshots (`prefer-inline-snapshots`)
 
+## Deprecated
+
+This rule has been deprecated in favor of
+[`no-restricted-matchers`](no-restricted-matchers.md) with the following config:
+
+```json
+{
+  "rules": {
+    "jest/no-restricted-matchers": [
+      "error",
+      {
+        "toThrowErrorMatchingSnapshot": "Use `toThrowErrorMatchingInlineSnapshot()` instead",
+        "toMatchSnapshot": "Use `toMatchInlineSnapshot()` instead"
+      }
+    ]
+  }
+}
+```
+
+---
+
 In order to make snapshot tests more managable and reviewable
 `toMatchInlineSnapshot()` and `toThrowErrorMatchingInlineSnapshot` should be
 used to write the snapshots inline in the test file.

package/docs/rules/valid-expect.md

@@ -30,7 +30,7 @@ This rule is enabled by default.
 
 ## Options
 
-```js
+```json5
 {
   type: 'object',
   properties: {
@@ -38,6 +38,14 @@ This rule is enabled by default.
       type: 'boolean',
       default: false,
     },
+    minArgs: {
+      type: 'number',
+      minimum: 1,
+    },
+    maxArgs: {
+      type: 'number',
+      minimum: 1,
+    },
   },
   additionalProperties: false,
 }
@@ -70,6 +78,18 @@ test('test1', async () => {
 test('test2', () => expect(Promise.resolve(2)).resolves.toBe(2));
 ```
 
+### `minArgs` & `maxArgs`
+
+Enforces the minimum and maximum number of arguments that `expect` can take, and
+is required to take.
+
+Both of these properties have a default value of `1`, which is the number of
+arguments supported by vanilla `expect`.
+
+This is useful when you're using libraries that increase the number of arguments
+supported by `expect`, such as
+[`jest-expect-message`](https://www.npmjs.com/package/jest-expect-message).
+
 ### Default configuration
 
 The following patterns are considered warnings:

package/lib/globals.json

@@ -5,6 +5,7 @@
   "beforeEach": false,
   "describe": false,
   "expect": false,
+  "fail": false,
   "fit": false,
   "it": false,
   "jasmine": false,

package/lib/index.js

@@ -35,7 +35,7 @@ const excludedFiles = ['__tests__', 'utils'];
 const rules = (0, _fs.readdirSync)(rulesDir).map(rule => (0, _path.parse)(rule).name).filter(rule => !excludedFiles.includes(rule)).reduce((acc, curr) => Object.assign(acc, {
   [curr]: importDefault((0, _path.join)(rulesDir, curr))
 }), {});
-const allRules = Object.keys(rules).reduce((rules, key) => _objectSpread({}, rules, {
+const allRules = Object.keys(rules).reduce((rules, key) => _objectSpread(_objectSpread({}, rules), {}, {
   [`jest/${key}`]: 'error'
 }), {});
 module.exports = {

package/lib/rules/no-deprecated-functions.js

@@ -66,16 +66,16 @@ var _default = (0, _utils.createRule)({
 
     const jestVersion = ((_ref = context.settings) === null || _ref === void 0 ? void 0 : (_ref$jest = _ref.jest) === null || _ref$jest === void 0 ? void 0 : _ref$jest.version) || detectJestVersion();
 
-    const deprecations = _objectSpread({}, jestVersion >= 15 && {
+    const deprecations = _objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread({}, jestVersion >= 15 && {
       'jest.resetModuleRegistry': 'jest.resetModules'
-    }, {}, jestVersion >= 17 && {
+    }), jestVersion >= 17 && {
       'jest.addMatchers': 'expect.extend'
-    }, {}, jestVersion >= 21 && {
+    }), jestVersion >= 21 && {
       'require.requireMock': 'jest.requireMock',
       'require.requireActual': 'jest.requireActual'
-    }, {}, jestVersion >= 22 && {
+    }), jestVersion >= 22 && {
       'jest.runTimersToTime': 'jest.advanceTimersByTime'
-    }, {}, jestVersion >= 26 && {
+    }), jestVersion >= 26 && {
       'jest.genMockFromModule': 'jest.createMockFromModule'
     });
 

package/lib/rules/no-expect-resolves.js

@@ -15,6 +15,8 @@ var _default = (0, _utils.createRule)({
       description: 'Disallow expect.resolves',
       recommended: false
     },
+    deprecated: true,
+    replacedBy: ['no-restricted-matchers'],
     messages: {
       expectResolves: 'Use `expect(await promise)` instead.'
     },

package/lib/rules/no-if.js

@@ -28,7 +28,7 @@ var _default = (0, _utils.createRule)({
       recommended: false
     },
     messages: {
-      noConditionalExpect: 'Test should not contain { condition } statements.'
+      conditionalInTest: 'Test should not contain {{ condition }} statements.'
     },
     schema: [],
     type: 'suggestion'
@@ -49,7 +49,7 @@ var _default = (0, _utils.createRule)({
         data: {
           condition: conditionName[node.type]
         },
-        messageId: 'noConditionalExpect',
+        messageId: 'conditionalInTest',
         node
       });
     }

package/lib/rules/no-large-snapshots.js

@@ -110,7 +110,7 @@ var _default = (0, _utils.createRule)({
           if ('property' in node.callee && ((0, _utils.isSupportedAccessor)(node.callee.property, 'toMatchInlineSnapshot') || (0, _utils.isSupportedAccessor)(node.callee.property, 'toThrowErrorMatchingInlineSnapshot'))) {
             var _options$inlineMaxSiz;
 
-            reportOnViolation(context, node, _objectSpread({}, options, {
+            reportOnViolation(context, node, _objectSpread(_objectSpread({}, options), {}, {
               maxSize: (_options$inlineMaxSiz = options.inlineMaxSize) !== null && _options$inlineMaxSiz !== void 0 ? _options$inlineMaxSiz : options.maxSize
             }));
           }

package/lib/rules/no-truthy-falsy.js

@@ -16,6 +16,8 @@ var _default = (0, _utils.createRule)({
       description: 'Disallow using `toBeTruthy()` & `toBeFalsy()`',
       recommended: false
     },
+    deprecated: true,
+    replacedBy: ['no-restricted-matchers'],
     messages: {
       avoidMatcher: 'Avoid {{ matcherName }}'
     },

package/lib/rules/prefer-inline-snapshots.js

@@ -17,6 +17,8 @@ var _default = (0, _utils.createRule)({
       description: 'Suggest using inline snapshots',
       recommended: false
     },
+    deprecated: true,
+    replacedBy: ['no-restricted-matchers'],
     messages: {
       toMatch: 'Use toMatchInlineSnapshot() instead',
       toMatchError: 'Use toThrowErrorMatchingInlineSnapshot() instead'

package/lib/rules/utils.js

@@ -231,7 +231,7 @@ const parseExpectMember = expectMember => ({
   node: expectMember
 });
 
-const reparseAsMatcher = parsedMember => _objectSpread({}, parsedMember, {
+const reparseAsMatcher = parsedMember => _objectSpread(_objectSpread({}, parsedMember), {}, {
   /**
    * The arguments being passed to this `Matcher`, if any.
    *
@@ -265,7 +265,7 @@ const reparseMemberAsModifier = parsedMember => {
   }
 
   const negation = parsedMember.node.parent && isExpectMember(parsedMember.node.parent, ModifierName.not) ? parsedMember.node.parent : undefined;
-  return _objectSpread({}, parsedMember, {
+  return _objectSpread(_objectSpread({}, parsedMember), {}, {
     negation
   });
 };

package/lib/rules/valid-expect.js

@@ -64,7 +64,8 @@ var _default = (0, _utils.createRule)({
       recommended: 'error'
     },
     messages: {
-      incorrectNumberOfArguments: 'Expect takes one and only one argument.',
+      tooManyArgs: 'Expect takes at most {{ amount }} argument{{ s }}.',
+      notEnoughArgs: 'Expect requires at least {{ amount }} argument{{ s }}.',
       modifierUnknown: 'Expect has no modifier named "{{ modifierName }}".',
       matcherNotFound: 'Expect must have a corresponding matcher call.',
       matcherNotCalled: 'Matchers must be called to assert.',
@@ -78,17 +79,29 @@ var _default = (0, _utils.createRule)({
         alwaysAwait: {
           type: 'boolean',
           default: false
+        },
+        minArgs: {
+          type: 'number',
+          minimum: 1
+        },
+        maxArgs: {
+          type: 'number',
+          minimum: 1
         }
       },
       additionalProperties: false
     }]
   },
   defaultOptions: [{
-    alwaysAwait: false
+    alwaysAwait: false,
+    minArgs: 1,
+    maxArgs: 1
   }],
 
   create(context, [{
-    alwaysAwait
+    alwaysAwait,
+    minArgs = 1,
+    maxArgs = 1
   }]) {
     // Context state
     const arrayExceptions = new Set();
@@ -117,9 +130,9 @@ var _default = (0, _utils.createRule)({
           matcher
         } = (0, _utils.parseExpectCall)(node);
 
-        if (expect.arguments.length !== 1) {
+        if (expect.arguments.length < minArgs) {
           const expectLength = (0, _utils.getAccessorValue)(expect.callee).length;
-          let loc = {
+          const loc = {
             start: {
               column: node.loc.start.column + expectLength,
               line: node.loc.start.line
@@ -129,25 +142,37 @@ var _default = (0, _utils.createRule)({
               line: node.loc.start.line
             }
           };
+          context.report({
+            messageId: 'notEnoughArgs',
+            data: {
+              amount: minArgs,
+              s: minArgs === 1 ? '' : 's'
+            },
+            node,
+            loc
+          });
+        }
 
-          if (expect.arguments.length !== 0) {
-            const {
-              start
-            } = expect.arguments[1].loc;
-            const {
-              end
-            } = expect.arguments[node.arguments.length - 1].loc;
-            loc = {
-              start,
-              end: {
-                column: end.column - 1,
-                line: end.line
-              }
-            };
-          }
-
+        if (expect.arguments.length > maxArgs) {
+          const {
+            start
+          } = expect.arguments[maxArgs].loc;
+          const {
+            end
+          } = expect.arguments[node.arguments.length - 1].loc;
+          const loc = {
+            start,
+            end: {
+              column: end.column - 1,
+              line: end.line
+            }
+          };
           context.report({
-            messageId: 'incorrectNumberOfArguments',
+            messageId: 'tooManyArgs',
+            data: {
+              amount: maxArgs,
+              s: maxArgs === 1 ? '' : 's'
+            },
             node,
             loc
           });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-jest",
-  "version": "23.11.0",
+  "version": "23.13.2",
   "description": "Eslint rules for Jest",
   "keywords": [
     "eslint",