eslint-plugin-jest 27.1.3 → 27.1.4

package/docs/rules/no-restricted-jest-methods.md

@@ -1,10 +1,6 @@
 # Disallow specific `jest.` methods (`no-restricted-jest-methods`)
 
-💼 This rule is enabled in the following
-[configs](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations):
-`all`.
-
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 You may wish to restrict the use of specific `jest` methods.
 

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

@@ -1,10 +1,6 @@
 # Disallow specific matchers & modifiers (`no-restricted-matchers`)
 
-💼 This rule is enabled in the following
-[configs](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations):
-`all`.
-
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 You may want to ban specific matchers & modifiers from being used.
 

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

@@ -1,10 +1,9 @@
 # Disallow using `expect` outside of `it` or `test` blocks (`no-standalone-expect`)
 
-💼 This rule is enabled in the following
-[configs](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations):
-`all`, `recommended`.
+💼 This rule is enabled in the ✅ `recommended`
+[config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 Prevents `expect` statements outside of a `test` or `it` block. An `expect`
 within a helper function (but outside of a `test` or `it` block) will not

package/docs/rules/no-test-prefixes.md

@@ -1,14 +1,12 @@
-# Use `.only` and `.skip` over `f` and `x` (`no-test-prefixes`)
+# Require using `.only` and `.skip` over `f` and `x` (`no-test-prefixes`)
 
-💼 This rule is enabled in the following
-[configs](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations):
-`all`, `recommended`.
+💼 This rule is enabled in the ✅ `recommended`
+[config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).
 
-🔧 This rule is automatically fixable using the `--fix`
-[option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix)
-on the command line.
+🔧 This rule is automatically fixable by the
+[`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 Jest allows you to choose how you want to define focused and skipped tests, with
 multiple permutations for each:

package/docs/rules/no-test-return-statement.md

@@ -1,10 +1,6 @@
 # Disallow explicitly returning from tests (`no-test-return-statement`)
 
-💼 This rule is enabled in the following
-[configs](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations):
-`all`.
-
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 Tests in Jest should be void and not return values.
 

package/docs/rules/prefer-called-with.md

@@ -1,10 +1,6 @@
 # Suggest using `toBeCalledWith()` or `toHaveBeenCalledWith()` (`prefer-called-with`)
 
-💼 This rule is enabled in the following
-[configs](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations):
-`all`.
-
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 The `toBeCalled()` matcher is used to assert that a mock function has been
 called one or more times, without checking the arguments passed. The assertion

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

@@ -1,14 +1,9 @@
 # Suggest using the built-in comparison matchers (`prefer-comparison-matcher`)
 
-💼 This rule is enabled in the following
-[configs](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations):
-`all`.
+🔧 This rule is automatically fixable by the
+[`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-🔧 This rule is automatically fixable using the `--fix`
-[option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix)
-on the command line.
-
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 Jest has a number of built-in matchers for comparing numbers, which allow for
 more readable tests and error messages if an expectation fails.

package/docs/rules/prefer-each.md

@@ -1,10 +1,6 @@
 # Prefer using `.each` rather than manual loops (`prefer-each`)
 
-💼 This rule is enabled in the following
-[configs](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations):
-`all`.
-
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 Reports where you might be able to use `.each` instead of native loops.
 

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

@@ -1,14 +1,9 @@
 # Suggest using the built-in equality matchers (`prefer-equality-matcher`)
 
-💼 This rule is enabled in the following
-[configs](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations):
-`all`.
+💡 This rule is manually fixable by
+[editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
 
-💡 This rule provides
-[suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
-that can be applied manually.
-
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 Jest has built-in matchers for expecting equality, which allow for more readable
 tests and error messages if an expectation fails.

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

@@ -1,14 +1,9 @@
 # Suggest using `expect.assertions()` OR `expect.hasAssertions()` (`prefer-expect-assertions`)
 
-💼 This rule is enabled in the following
-[configs](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations):
-`all`.
+💡 This rule is manually fixable by
+[editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
 
-💡 This rule provides
-[suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
-that can be applied manually.
-
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 Ensure every test to have either `expect.assertions(<number of assertions>)` OR
 `expect.hasAssertions()` as its first expression.
@@ -37,8 +32,6 @@ test('my test', () => {
 });
 ```
 
-### Default configuration
-
 The following patterns are considered warnings:
 
 ```js

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

@@ -1,14 +1,9 @@
 # Prefer `await expect(...).resolves` over `expect(await ...)` syntax (`prefer-expect-resolves`)
 
-💼 This rule is enabled in the following
-[configs](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations):
-`all`.
+🔧 This rule is automatically fixable by the
+[`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-🔧 This rule is automatically fixable using the `--fix`
-[option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix)
-on the command line.
-
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 When working with promises, there are two primary ways you can test the resolved
 value:

package/docs/rules/prefer-hooks-in-order.md

@@ -1,10 +1,6 @@
 # Prefer having hooks in a consistent order (`prefer-hooks-in-order`)
 
-💼 This rule is enabled in the following
-[configs](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations):
-`all`.
-
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 While hooks can be setup in any order, they're always called by `jest` in this
 specific order:

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

@@ -1,10 +1,6 @@
 # Suggest having hooks before any test cases (`prefer-hooks-on-top`)
 
-💼 This rule is enabled in the following
-[configs](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations):
-`all`.
-
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 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

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

@@ -1,14 +1,9 @@
 # Enforce lowercase test names (`prefer-lowercase-title`)
 
-💼 This rule is enabled in the following
-[configs](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations):
-`all`.
+🔧 This rule is automatically fixable by the
+[`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-🔧 This rule is automatically fixable using the `--fix`
-[option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix)
-on the command line.
-
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 ## Rule details
 

package/docs/rules/prefer-mock-promise-shorthand.md

@@ -1,14 +1,9 @@
 # Prefer mock resolved/rejected shorthands for promises (`prefer-mock-promise-shorthand`)
 
-💼 This rule is enabled in the following
-[configs](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations):
-`all`.
+🔧 This rule is automatically fixable by the
+[`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-🔧 This rule is automatically fixable using the `--fix`
-[option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix)
-on the command line.
-
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 When working with mocks of functions that return promises, Jest provides some
 API sugar functions to reduce the amount of boilerplate you have to write.

package/docs/rules/prefer-snapshot-hint.md

@@ -1,10 +1,6 @@
 # Prefer including a hint with external snapshots (`prefer-snapshot-hint`)
 
-💼 This rule is enabled in the following
-[configs](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations):
-`all`.
-
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 When working with external snapshot matchers it's considered best practice to
 provide a hint (as the last argument to the matcher) describing the expected

package/docs/rules/prefer-spy-on.md

@@ -1,14 +1,9 @@
 # Suggest using `jest.spyOn()` (`prefer-spy-on`)
 
-💼 This rule is enabled in the following
-[configs](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations):
-`all`.
+🔧 This rule is automatically fixable by the
+[`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-🔧 This rule is automatically fixable using the `--fix`
-[option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix)
-on the command line.
-
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 When mocking a function by overwriting a property you have to manually restore
 the original implementation when cleaning up. When using `jest.spyOn()` Jest
@@ -34,8 +29,6 @@ jest.spyOn(Date, 'now').mockReturnValue(10); // Will always return 10
 This rule triggers a warning if an object's property is overwritten with a jest
 mock.
 
-### Default configuration
-
 The following patterns are considered warnings:
 
 ```js

package/docs/rules/prefer-strict-equal.md

@@ -1,14 +1,9 @@
 # Suggest using `toStrictEqual()` (`prefer-strict-equal`)
 
-💼 This rule is enabled in the following
-[configs](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations):
-`all`.
+💡 This rule is manually fixable by
+[editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
 
-💡 This rule provides
-[suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
-that can be applied manually.
-
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 `toStrictEqual` not only checks that two objects contain the same data but also
 that they have the same structure. It is common to expect objects to not only
@@ -19,8 +14,6 @@ catch cases where two objects do not have identical keys.
 
 This rule triggers a warning if `toEqual()` is used to assert equality.
 
-### Default configuration
-
 The following pattern is considered warning:
 
 ```js

package/docs/rules/prefer-to-be.md

@@ -1,14 +1,12 @@
 # Suggest using `toBe()` for primitive literals (`prefer-to-be`)
 
-💼 This rule is enabled in the following
-[configs](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations):
-`all`, `style`.
+💼 This rule is enabled in the 🎨 `style`
+[config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).
 
-🔧 This rule is automatically fixable using the `--fix`
-[option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix)
-on the command line.
+🔧 This rule is automatically fixable by the
+[`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 When asserting against primitive literals such as numbers and strings, the
 equality matchers all operate the same, but read slightly differently in code.

package/docs/rules/prefer-to-contain.md

@@ -1,14 +1,12 @@
 # Suggest using `toContain()` (`prefer-to-contain`)
 
-💼 This rule is enabled in the following
-[configs](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations):
-`all`, `style`.
+💼 This rule is enabled in the 🎨 `style`
+[config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).
 
-🔧 This rule is automatically fixable using the `--fix`
-[option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix)
-on the command line.
+🔧 This rule is automatically fixable by the
+[`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 In order to have a better failure message, `toContain()` should be used upon
 asserting expectations on an array containing an object.
@@ -30,8 +28,6 @@ expect(a.includes(b)).not.toBe(true);
 expect(a.includes(b)).toBe(false);
 ```
 
-### Default configuration
-
 The following patterns are considered warnings:
 
 ```js

package/docs/rules/prefer-to-have-length.md

@@ -1,14 +1,12 @@
 # Suggest using `toHaveLength()` (`prefer-to-have-length`)
 
-💼 This rule is enabled in the following
-[configs](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations):
-`all`, `style`.
+💼 This rule is enabled in the 🎨 `style`
+[config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).
 
-🔧 This rule is automatically fixable using the `--fix`
-[option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix)
-on the command line.
+🔧 This rule is automatically fixable by the
+[`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 In order to have a better failure message, `toHaveLength()` should be used upon
 asserting expectations on objects length property.
@@ -24,8 +22,6 @@ expect(files.length).toBe(1);
 
 This rule is enabled by default.
 
-### Default configuration
-
 The following patterns are considered warnings:
 
 ```js

package/docs/rules/prefer-todo.md

@@ -1,14 +1,9 @@
 # Suggest using `test.todo` (`prefer-todo`)
 
-💼 This rule is enabled in the following
-[configs](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations):
-`all`.
+🔧 This rule is automatically fixable by the
+[`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-🔧 This rule is automatically fixable using the `--fix`
-[option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix)
-on the command line.
-
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 When test cases are empty then it is better to mark them as `test.todo` as it
 will be highlighted in the summary output.
@@ -21,8 +16,6 @@ This rule triggers a warning if empty test cases are used without 'test.todo'.
 test('i need to write this test');
 ```
 
-### Default configuration
-
 The following pattern is considered warning:
 
 ```js

package/docs/rules/require-hook.md

@@ -1,10 +1,6 @@
 # Require setup and teardown code to be within a hook (`require-hook`)
 
-💼 This rule is enabled in the following
-[configs](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations):
-`all`.
-
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 Often while writing tests you have some setup work that needs to happen before
 tests run, and you have some finishing work that needs to happen after tests

package/docs/rules/require-to-throw-message.md

@@ -1,10 +1,6 @@
 # Require a message for `toThrow()` (`require-to-throw-message`)
 
-💼 This rule is enabled in the following
-[configs](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations):
-`all`.
-
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 `toThrow()` (and its alias `toThrowError()`) is used to check if an error is
 thrown by a function call, such as in `expect(() => a()).toThrow()`. However, if
@@ -16,8 +12,6 @@ message ensures that the intended error is thrown.
 This rule triggers a warning if `toThrow()` or `toThrowError()` is used without
 an error message.
 
-### Default configuration
-
 The following patterns are considered warnings:
 
 ```js

package/docs/rules/require-top-level-describe.md

@@ -1,10 +1,6 @@
 # Require test cases and hooks to be inside a `describe` block (`require-top-level-describe`)
 
-💼 This rule is enabled in the following
-[configs](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations):
-`all`.
-
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 Jest allows you to organise your test files the way you want it. However, the
 more your codebase grows, the more it becomes hard to navigate in your test

package/docs/rules/unbound-method.md

@@ -1,10 +1,8 @@
 # Enforce unbound methods are called with their expected scope (`unbound-method`)
 
-💼 This rule is enabled in the following
-[configs](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations):
-`all`.
+💭 This rule requires type information.
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 ## Rule details
 

package/docs/rules/valid-describe-callback.md

@@ -1,10 +1,9 @@
 # Enforce valid `describe()` callback (`valid-describe-callback`)
 
-💼 This rule is enabled in the following
-[configs](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations):
-`all`, `recommended`.
+💼 This rule is enabled in the ✅ `recommended`
+[config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 Using an improper `describe()` callback function can lead to unexpected test
 errors.

package/docs/rules/valid-expect-in-promise.md

@@ -1,10 +1,9 @@
-# Ensure promises that have expectations in their chain are valid (`valid-expect-in-promise`)
+# Require promises that have expectations in their chain to be valid (`valid-expect-in-promise`)
 
-💼 This rule is enabled in the following
-[configs](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations):
-`all`, `recommended`.
+💼 This rule is enabled in the ✅ `recommended`
+[config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 Ensure promises that include expectations are returned or awaited.
 

package/docs/rules/valid-expect.md

@@ -1,10 +1,9 @@
 # Enforce valid `expect()` usage (`valid-expect`)
 
-💼 This rule is enabled in the following
-[configs](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations):
-`all`, `recommended`.
+💼 This rule is enabled in the ✅ `recommended`
+[config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 Ensure `expect()` is called with a single argument and there is an actual
 expectation made.
@@ -109,8 +108,6 @@ 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:
 
 ```js

package/docs/rules/valid-title.md

@@ -1,14 +1,12 @@
 # Enforce valid titles (`valid-title`)
 
-💼 This rule is enabled in the following
-[configs](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations):
-`all`, `recommended`.
+💼 This rule is enabled in the ✅ `recommended`
+[config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).
 
-🔧 This rule is automatically fixable using the `--fix`
-[option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix)
-on the command line.
+🔧 This rule is automatically fixable by the
+[`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 Checks that the title of Jest blocks are valid by ensuring that titles are:
 

package/lib/rules/consistent-test-it.js

@@ -12,7 +12,7 @@ var _default = (0, _utils2.createRule)({
   meta: {
     docs: {
       category: 'Best Practices',
-      description: 'Have control over `test` and `it` usages',
+      description: 'Enforce `test` and `it` usage conventions',
       recommended: false
     },
     fixable: 'code',

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

@@ -11,7 +11,7 @@ var _default = (0, _utils2.createRule)({
   name: __filename,
   meta: {
     docs: {
-      description: 'Prevent calling `expect` conditionally',
+      description: 'Disallow calling `expect` conditionally',
       category: 'Best Practices',
       recommended: 'error'
     },

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

@@ -24,7 +24,7 @@ var _default = (0, _utils2.createRule)({
   meta: {
     docs: {
       category: 'Best Practices',
-      description: 'Avoid using a callback in asynchronous tests and hooks',
+      description: 'Disallow using a callback in asynchronous tests and hooks',
       recommended: 'error'
     },
     messages: {

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

@@ -48,7 +48,7 @@ var _default = (0, _utils2.createRule)({
   meta: {
     docs: {
       category: 'Best Practices',
-      description: 'disallow large snapshots',
+      description: 'Disallow large snapshots',
       recommended: false
     },
     messages: {

package/lib/rules/no-test-prefixes.js

@@ -11,7 +11,7 @@ var _default = (0, _utils2.createRule)({
   meta: {
     docs: {
       category: 'Best Practices',
-      description: 'Use `.only` and `.skip` over `f` and `x`',
+      description: 'Require using `.only` and `.skip` over `f` and `x`',
       recommended: 'error'
     },
     messages: {