eslint-plugin-jest 26.8.7 → 27.1.6

package/README.md

@@ -195,69 +195,85 @@ installations requiring long-term consistency.
 
 ## Rules
 
-<!-- begin base rules list -->
-
-| Rule                                                                         | Description                                                         | Configurations   | Fixable      |
-| ---------------------------------------------------------------------------- | ------------------------------------------------------------------- | ---------------- | ------------ |
-| [consistent-test-it](docs/rules/consistent-test-it.md)                       | Have control over `test` and `it` usages                            |                  | ![fixable][] |
-| [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-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                                 |                  |              |
-| [no-deprecated-functions](docs/rules/no-deprecated-functions.md)             | Disallow use of deprecated functions                                | ![recommended][] | ![fixable][] |
-| [no-disabled-tests](docs/rules/no-disabled-tests.md)                         | Disallow disabled tests                                             | ![recommended][] |              |
-| [no-done-callback](docs/rules/no-done-callback.md)                           | Avoid using a callback in asynchronous tests and hooks              | ![recommended][] | ![suggest][] |
-| [no-duplicate-hooks](docs/rules/no-duplicate-hooks.md)                       | Disallow duplicate setup and teardown hooks                         |                  |              |
-| [no-export](docs/rules/no-export.md)                                         | Disallow using `exports` in files containing tests                  | ![recommended][] |              |
-| [no-focused-tests](docs/rules/no-focused-tests.md)                           | Disallow focused tests                                              | ![recommended][] | ![suggest][] |
-| [no-hooks](docs/rules/no-hooks.md)                                           | Disallow setup and teardown hooks                                   |                  |              |
-| [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                              |                  |              |
-| [no-standalone-expect](docs/rules/no-standalone-expect.md)                   | Disallow using `expect` outside of `it` or `test` blocks            | ![recommended][] |              |
-| [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                            |                  |              |
-| [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-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][] |
-| [prefer-hooks-in-order](docs/rules/prefer-hooks-in-order.md)                 | Prefer having hooks in a consistent order                           |                  |              |
-| [prefer-hooks-on-top](docs/rules/prefer-hooks-on-top.md)                     | Suggest having hooks before any test cases                          |                  |              |
-| [prefer-lowercase-title](docs/rules/prefer-lowercase-title.md)               | Enforce lowercase test names                                        |                  | ![fixable][] |
-| [prefer-mock-promise-shorthand](docs/rules/prefer-mock-promise-shorthand.md) | Prefer mock resolved/rejected shorthands for promises               |                  | ![fixable][] |
-| [prefer-snapshot-hint](docs/rules/prefer-snapshot-hint.md)                   | Prefer including a hint with external snapshots                     |                  |              |
-| [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()`                                     |                  | ![suggest][] |
-| [prefer-to-be](docs/rules/prefer-to-be.md)                                   | Suggest using `toBe()` for primitive literals                       | ![style][]       | ![fixable][] |
-| [prefer-to-contain](docs/rules/prefer-to-contain.md)                         | Suggest using `toContain()`                                         | ![style][]       | ![fixable][] |
-| [prefer-to-have-length](docs/rules/prefer-to-have-length.md)                 | Suggest using `toHaveLength()`                                      | ![style][]       | ![fixable][] |
-| [prefer-todo](docs/rules/prefer-todo.md)                                     | Suggest using `test.todo`                                           |                  | ![fixable][] |
-| [require-hook](docs/rules/require-hook.md)                                   | Require setup and teardown code to be within a hook                 |                  |              |
-| [require-to-throw-message](docs/rules/require-to-throw-message.md)           | Require a message for `toThrow()`                                   |                  |              |
-| [require-top-level-describe](docs/rules/require-top-level-describe.md)       | Require test cases and hooks to be inside a `describe` block        |                  |              |
-| [valid-describe-callback](docs/rules/valid-describe-callback.md)             | Enforce valid `describe()` callback                                 | ![recommended][] |              |
-| [valid-expect](docs/rules/valid-expect.md)                                   | Enforce valid `expect()` usage                                      | ![recommended][] |              |
-| [valid-expect-in-promise](docs/rules/valid-expect-in-promise.md)             | Ensure promises that have expectations in their chain are valid     | ![recommended][] |              |
-| [valid-title](docs/rules/valid-title.md)                                     | Enforce valid titles                                                | ![recommended][] | ![fixable][] |
-
-<!-- end base rules list -->
-
-## TypeScript Rules
-
-In addition to the above rules, this plugin also includes a few advanced rules
-that are powered by type-checking information provided by TypeScript.
-
-In order to use these rules, you must be using `@typescript-eslint/parser` &
-adjust your eslint config as outlined
-[here](https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/TYPED_LINTING.md)
+<!-- begin auto-generated rules list -->
+
+💼
+[Configurations](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations)
+enabled in.\
+⚠️ [Configurations](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations)
+set to warn in.\
+✅ Set in the `recommended`
+[configuration](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).\
+🎨 Set in the `style` [configuration](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).\
+🔧 Automatically fixable by the
+[`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).\
+💡 Manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).\
+❌ Deprecated.
+
+| Name                                                                         | Description                                                         | 💼  | ⚠️  | 🔧  | 💡  | ❌  |
+| :--------------------------------------------------------------------------- | :------------------------------------------------------------------ | :-- | :-- | :-- | :-- | :-- |
+| [consistent-test-it](docs/rules/consistent-test-it.md)                       | Enforce `test` and `it` usage conventions                           |     |     | 🔧  |     |     |
+| [expect-expect](docs/rules/expect-expect.md)                                 | Enforce assertion to be made in a test body                         |     | ✅  |     |     |     |
+| [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                                              | ✅  | 🎨  | 🔧  |     |     |
+| [no-commented-out-tests](docs/rules/no-commented-out-tests.md)               | Disallow commented out tests                                        |     | ✅  |     |     |     |
+| [no-conditional-expect](docs/rules/no-conditional-expect.md)                 | Disallow calling `expect` conditionally                             | ✅  |     |     |     |     |
+| [no-conditional-in-test](docs/rules/no-conditional-in-test.md)               | Disallow conditional logic in tests                                 |     |     |     |     |     |
+| [no-deprecated-functions](docs/rules/no-deprecated-functions.md)             | Disallow use of deprecated functions                                | ✅  |     | 🔧  |     |     |
+| [no-disabled-tests](docs/rules/no-disabled-tests.md)                         | Disallow disabled tests                                             |     | ✅  |     |     |     |
+| [no-done-callback](docs/rules/no-done-callback.md)                           | Disallow using a callback in asynchronous tests and hooks           | ✅  |     |     | 💡  |     |
+| [no-duplicate-hooks](docs/rules/no-duplicate-hooks.md)                       | Disallow duplicate setup and teardown hooks                         |     |     |     |     |     |
+| [no-export](docs/rules/no-export.md)                                         | Disallow using `exports` in files containing tests                  | ✅  |     |     |     |     |
+| [no-focused-tests](docs/rules/no-focused-tests.md)                           | Disallow focused tests                                              | ✅  |     |     | 💡  |     |
+| [no-hooks](docs/rules/no-hooks.md)                                           | Disallow setup and teardown hooks                                   |     |     |     |     |     |
+| [no-identical-title](docs/rules/no-identical-title.md)                       | Disallow identical titles                                           | ✅  |     |     |     |     |
+| [no-if](docs/rules/no-if.md)                                                 | Disallow conditional logic                                          |     |     |     |     | ❌  |
+| [no-interpolation-in-snapshots](docs/rules/no-interpolation-in-snapshots.md) | Disallow string interpolation inside snapshots                      | ✅  |     |     |     |     |
+| [no-jasmine-globals](docs/rules/no-jasmine-globals.md)                       | Disallow Jasmine globals                                            | ✅  |     | 🔧  |     |     |
+| [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__`                        | ✅  |     |     |     |     |
+| [no-restricted-jest-methods](docs/rules/no-restricted-jest-methods.md)       | Disallow specific `jest.` methods                                   |     |     |     |     |     |
+| [no-restricted-matchers](docs/rules/no-restricted-matchers.md)               | Disallow specific matchers & modifiers                              |     |     |     |     |     |
+| [no-standalone-expect](docs/rules/no-standalone-expect.md)                   | Disallow using `expect` outside of `it` or `test` blocks            | ✅  |     |     |     |     |
+| [no-test-prefixes](docs/rules/no-test-prefixes.md)                           | Require using `.only` and `.skip` over `f` and `x`                  | ✅  |     | 🔧  |     |     |
+| [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                      |     |     | 🔧  |     |     |
+| [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                        |     |     |     | 💡  |     |
+| [prefer-expect-assertions](docs/rules/prefer-expect-assertions.md)           | Suggest using `expect.assertions()` OR `expect.hasAssertions()`     |     |     |     | 💡  |     |
+| [prefer-expect-resolves](docs/rules/prefer-expect-resolves.md)               | Prefer `await expect(...).resolves` over `expect(await ...)` syntax |     |     | 🔧  |     |     |
+| [prefer-hooks-in-order](docs/rules/prefer-hooks-in-order.md)                 | Prefer having hooks in a consistent order                           |     |     |     |     |     |
+| [prefer-hooks-on-top](docs/rules/prefer-hooks-on-top.md)                     | Suggest having hooks before any test cases                          |     |     |     |     |     |
+| [prefer-lowercase-title](docs/rules/prefer-lowercase-title.md)               | Enforce lowercase test names                                        |     |     | 🔧  |     |     |
+| [prefer-mock-promise-shorthand](docs/rules/prefer-mock-promise-shorthand.md) | Prefer mock resolved/rejected shorthands for promises               |     |     | 🔧  |     |     |
+| [prefer-snapshot-hint](docs/rules/prefer-snapshot-hint.md)                   | Prefer including a hint with external snapshots                     |     |     |     |     |     |
+| [prefer-spy-on](docs/rules/prefer-spy-on.md)                                 | Suggest using `jest.spyOn()`                                        |     |     | 🔧  |     |     |
+| [prefer-strict-equal](docs/rules/prefer-strict-equal.md)                     | Suggest using `toStrictEqual()`                                     |     |     |     | 💡  |     |
+| [prefer-to-be](docs/rules/prefer-to-be.md)                                   | Suggest using `toBe()` for primitive literals                       | 🎨  |     | 🔧  |     |     |
+| [prefer-to-contain](docs/rules/prefer-to-contain.md)                         | Suggest using `toContain()`                                         | 🎨  |     | 🔧  |     |     |
+| [prefer-to-have-length](docs/rules/prefer-to-have-length.md)                 | Suggest using `toHaveLength()`                                      | 🎨  |     | 🔧  |     |     |
+| [prefer-todo](docs/rules/prefer-todo.md)                                     | Suggest using `test.todo`                                           |     |     | 🔧  |     |     |
+| [require-hook](docs/rules/require-hook.md)                                   | Require setup and teardown code to be within a hook                 |     |     |     |     |     |
+| [require-to-throw-message](docs/rules/require-to-throw-message.md)           | Require a message for `toThrow()`                                   |     |     |     |     |     |
+| [require-top-level-describe](docs/rules/require-top-level-describe.md)       | Require test cases and hooks to be inside a `describe` block        |     |     |     |     |     |
+| [valid-describe-callback](docs/rules/valid-describe-callback.md)             | Enforce valid `describe()` callback                                 | ✅  |     |     |     |     |
+| [valid-expect](docs/rules/valid-expect.md)                                   | Enforce valid `expect()` usage                                      | ✅  |     |     |     |     |
+| [valid-expect-in-promise](docs/rules/valid-expect-in-promise.md)             | Require promises that have expectations in their chain to be valid  | ✅  |     |     |     |     |
+| [valid-title](docs/rules/valid-title.md)                                     | Enforce valid titles                                                | ✅  |     | 🔧  |     |     |
+
+### Requires Type Checking
+
+| Name                                           | Description                                                  | 💼  | ⚠️  | 🔧  | 💡  | ❌  |
+| :--------------------------------------------- | :----------------------------------------------------------- | :-- | :-- | :-- | :-- | :-- |
+| [unbound-method](docs/rules/unbound-method.md) | Enforce unbound methods are called with their expected scope |     |     |     |     |     |
+
+<!-- end auto-generated rules list -->
+
+In order to use the rules powered by TypeScript type-checking, you must be using
+`@typescript-eslint/parser` & adjust your eslint config as outlined
+[here](https://github.com/typescript-eslint/typescript-eslint/blob/main/docs/linting/TYPED_LINTING.md).
 
 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
@@ -267,14 +283,6 @@ 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.
 
-<!-- begin type rules list -->
-
-| Rule                                           | Description                                                  | Configurations | Fixable |
-| ---------------------------------------------- | ------------------------------------------------------------ | -------------- | ------- |
-| [unbound-method](docs/rules/unbound-method.md) | Enforce unbound methods are called with their expected scope |                |         |
-
-<!-- end type rules list -->
-
 ## Credit
 
 - [eslint-plugin-mocha](https://github.com/lo1tuma/eslint-plugin-mocha)
@@ -288,24 +296,20 @@ This is a sister plugin to `eslint-plugin-jest` that provides support for the
 matchers provided by
 [`jest-extended`](https://github.com/jest-community/jest-extended).
 
-https://github.com/jest-community/eslint-plugin-jest-extended
+<https://github.com/jest-community/eslint-plugin-jest-extended>
 
 ### eslint-plugin-jest-formatting
 
 This project aims to provide formatting rules (auto-fixable where possible) to
 ensure consistency and readability in jest test suites.
 
-https://github.com/dangreenisrael/eslint-plugin-jest-formatting
+<https://github.com/dangreenisrael/eslint-plugin-jest-formatting>
 
 ### eslint-plugin-istanbul
 
 A set of rules to enforce good practices for Istanbul, one of the code coverage
 tools used by Jest.
 
-https://github.com/istanbuljs/eslint-plugin-istanbul
+<https://github.com/istanbuljs/eslint-plugin-istanbul>
 
-[recommended]: https://img.shields.io/badge/-recommended-lightgrey.svg
-[suggest]: https://img.shields.io/badge/-suggest-yellow.svg
-[fixable]: https://img.shields.io/badge/-fixable-green.svg
-[style]: https://img.shields.io/badge/-style-blue.svg
 [`no-deprecated-functions`]: docs/rules/no-deprecated-functions.md

package/docs/rules/consistent-test-it.md

@@ -1,4 +1,9 @@
-# Have control over `test` and `it` usages (`consistent-test-it`)
+# Enforce `test` and `it` usage conventions (`consistent-test-it`)
+
+🔧 This rule is automatically fixable by the
+[`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
+
+<!-- end auto-generated rule header -->
 
 Jest allows you to choose how you want to define your tests, using the `it` or
 the `test` keywords, with multiple permutations for each:
@@ -6,9 +11,11 @@ the `test` keywords, with multiple permutations for each:
 - **it:** `it`, `xit`, `fit`, `it.only`, `it.skip`.
 - **test:** `test`, `xtest`, `test.only`, `test.skip`.
 
+## Rule details
+
 This rule gives you control over the usage of these keywords in your codebase.
 
-## Rule Details
+## Options
 
 This rule can be configured as follows
 
@@ -69,8 +76,6 @@ describe('foo', function () {
 });
 ```
 
-### Default configuration
-
 The default configuration forces all top-level tests to use `test` and all tests
 nested within `describe` to use `it`.
 

package/docs/rules/expect-expect.md

@@ -1,5 +1,10 @@
 # Enforce assertion to be made in a test body (`expect-expect`)
 
+⚠️ This rule _warns_ in the ✅ `recommended`
+[config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).
+
+<!-- end auto-generated rule header -->
+
 Ensure that there is at least one `expect` call made in a test.
 
 ## Rule details

package/docs/rules/max-expects.md

@@ -1,10 +1,12 @@
 # Enforces a maximum number assertion calls in a test body (`max-expects`)
 
+<!-- end auto-generated rule header -->
+
 As more assertions are made, there is a possible tendency for the test to be
 more likely to mix multiple objectives. To avoid this, this rule reports when
 the maximum number of assertions is exceeded.
 
-## Rule Details
+## Rule details
 
 This rule enforces a maximum number of `expect()` calls.
 

package/docs/rules/max-nested-describe.md

@@ -1,10 +1,12 @@
 # Enforces a maximum depth to nested describe calls (`max-nested-describe`)
 
+<!-- end auto-generated rule header -->
+
 While it's useful to be able to group your tests together within the same file
 using `describe()`, having too many levels of nesting throughout your tests make
 them difficult to read.
 
-## Rule Details
+## Rule details
 
 This rule enforces a maximum depth to nested `describe()` calls to improve code
 clarity in your tests.

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

@@ -1,5 +1,18 @@
 # Disallow alias methods (`no-alias-methods`)
 
+💼⚠️ This rule is enabled in the ✅ `recommended`
+[config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).
+This rule _warns_ in the 🎨 `style`
+[config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).
+
+🔧 This rule is automatically fixable by the
+[`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
+
+<!-- end auto-generated rule header -->
+
+> 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
@@ -11,8 +24,6 @@ method names used.
 This rule triggers a warning if the alias name, rather than the canonical name,
 of a method is used.
 
-### Default configuration
-
 The following patterns are considered warnings:
 
 ```js

package/docs/rules/no-commented-out-tests.md

@@ -1,9 +1,14 @@
 # Disallow commented out tests (`no-commented-out-tests`)
 
+⚠️ This rule _warns_ in the ✅ `recommended`
+[config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).
+
+<!-- end auto-generated rule header -->
+
 This rule raises a warning about commented out tests. It's similar to
 no-disabled-tests rule.
 
-## Rule Details
+## Rule details
 
 The rule uses fuzzy matching to do its best to determine what constitutes a
 commented out test, checking for a presence of `it(`, `describe(`, `it.skip(`,

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

@@ -1,4 +1,9 @@
-# Prevent calling `expect` conditionally (`no-conditional-expect`)
+# Disallow calling `expect` conditionally (`no-conditional-expect`)
+
+💼 This rule is enabled in the ✅ `recommended`
+[config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).
+
+<!-- end auto-generated rule header -->
 
 This rule prevents the use of `expect` in conditional blocks, such as `if`s &
 `catch`s.
@@ -6,7 +11,7 @@ This rule prevents the use of `expect` in conditional blocks, such as `if`s &
 This includes using `expect` in callbacks to functions named `catch`, which are
 assumed to be promises.
 
-## Rule Details
+## Rule details
 
 Jest only considers a test to have failed if it throws an error, meaning if
 calls to assertion functions like `expect` occur in conditional code such as a

package/docs/rules/no-conditional-in-test.md

@@ -1,11 +1,13 @@
 # Disallow conditional logic in tests (`no-conditional-in-test`)
 
+<!-- end auto-generated rule header -->
+
 Conditional logic in tests is usually an indication that a test is attempting to
 cover too much, and not testing the logic it intends to. Each branch of code
 executing within a conditional statement will usually be better served by a test
 devoted to it.
 
-## Rule Details
+## Rule details
 
 This rule reports on any use of a conditional statement such as `if`, `switch`,
 and ternary expressions.

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

@@ -1,5 +1,13 @@
 # Disallow use of deprecated functions (`no-deprecated-functions`)
 
+💼 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 by the
+[`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
+
+<!-- end auto-generated rule header -->
+
 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.
 
@@ -20,13 +28,12 @@ This rule can also autofix a number of these deprecations for you.
 
 ### `jest.resetModuleRegistry`
 
-This function was renamed to `resetModules` in Jest 15, and is scheduled for
-removal in Jest 27.
+This function was renamed to `resetModules` in Jest 15 and removed in Jest 27.
 
 ### `jest.addMatchers`
 
-This function was replaced with `expect.extend` in Jest 17, and is scheduled for
-removal in Jest 27.
+This function was replaced with `expect.extend` in Jest 17 and removed in
+Jest 27.
 
 ### `require.requireActual` & `require.requireMock`
 
@@ -41,10 +48,10 @@ the release of Jest 26 saw them removed from the `require` function altogether.
 
 ### `jest.runTimersToTime`
 
-This function was renamed to `advanceTimersByTime` in Jest 22, and is scheduled
-for removal in Jest 27.
+This function was renamed to `advanceTimersByTime` in Jest 22 and removed in
+Jest 27.
 
 ### `jest.genMockFromModule`
 
 This function was renamed to `createMockFromModule` in Jest 26, and is scheduled
-for removal in a future version of Jest.
+for removal in Jest 30.

package/docs/rules/no-disabled-tests.md

@@ -1,5 +1,10 @@
 # Disallow disabled tests (`no-disabled-tests`)
 
+⚠️ This rule _warns_ in the ✅ `recommended`
+[config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).
+
+<!-- end auto-generated rule header -->
+
 Jest has a feature that allows you to temporarily mark tests as disabled. This
 feature is often helpful while debugging or to create placeholders for future
 tests. Before committing changes we may want to check that all tests are
@@ -7,7 +12,7 @@ running.
 
 This rule raises a warning about disabled tests.
 
-## Rule Details
+## Rule details
 
 There are a number of ways to disable tests in Jest:
 

package/docs/rules/no-done-callback.md

@@ -1,4 +1,12 @@
-# Avoid using a callback in asynchronous tests and hooks (`no-done-callback`)
+# Disallow using a callback in asynchronous tests and hooks (`no-done-callback`)
+
+💼 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 manually fixable by
+[editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
+
+<!-- end auto-generated rule header -->
 
 When calling asynchronous code in hooks and tests, `jest` needs to know when the
 asynchronous work is complete to progress the current run.

package/docs/rules/no-duplicate-hooks.md

@@ -1,8 +1,10 @@
 # Disallow duplicate setup and teardown hooks (`no-duplicate-hooks`)
 
+<!-- end auto-generated rule header -->
+
 A `describe` block should not contain duplicate hooks.
 
-## Rule Details
+## Rule details
 
 Examples of **incorrect** code for this rule
 

package/docs/rules/no-export.md

@@ -1,8 +1,13 @@
 # Disallow using `exports` in files containing tests (`no-export`)
 
+💼 This rule is enabled in the ✅ `recommended`
+[config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).
+
+<!-- end auto-generated rule header -->
+
 Prevents using `exports` if a file has one or more tests in it.
 
-## Rule Details
+## Rule details
 
 This rule aims to eliminate duplicate runs of tests by exporting things from
 test files. If you import from a test file, then all the tests in that file will

package/docs/rules/no-focused-tests.md

@@ -1,5 +1,14 @@
 # Disallow focused tests (`no-focused-tests`)
 
+💼 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 manually fixable by
+[editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
+
+<!-- end auto-generated rule header -->
+
+<!-- prettier-ignore -->
 Jest has a feature that allows you to focus tests by appending `.only` or
 prepending `f` to a test-suite or a test-case. This feature is really helpful to
 debug a failing test, so you don’t have to execute all of your tests. After you
@@ -9,7 +18,7 @@ have fixed your test and before committing the changes you have to remove
 This rule reminds you to remove `.only` from your tests by raising a warning
 whenever you are using the exclusivity feature.
 
-## Rule Details
+## Rule details
 
 This rule looks for every `describe.only`, `it.only`, `test.only`, `fdescribe`,
 and `fit` occurrences within the source code. Of course there are some

package/docs/rules/no-hooks.md

@@ -1,10 +1,12 @@
 # Disallow setup and teardown hooks (`no-hooks`)
 
+<!-- end auto-generated rule header -->
+
 Jest provides global functions for setup and teardown tasks, which are called
 before/after each test case and each test suite. The use of these hooks promotes
 shared state between tests.
 
-## Rule Details
+## Rule details
 
 This rule reports for the following function calls:
 

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

@@ -1,11 +1,16 @@
 # Disallow identical titles (`no-identical-title`)
 
+💼 This rule is enabled in the ✅ `recommended`
+[config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).
+
+<!-- end auto-generated rule header -->
+
 Having identical titles for two different tests or test suites may create
 confusion. For example, when a test with the same title as another test in the
 same test suite fails, it is harder to know which one failed and thus harder to
 fix.
 
-## Rule Details
+## Rule details
 
 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

package/docs/rules/no-if.md

@@ -1,10 +1,10 @@
 # Disallow conditional logic (`no-if`)
 
-## Deprecated
-
-This rule has been deprecated in favor of
+❌ This rule is deprecated. It was replaced by
 [`no-conditional-in-test`](no-conditional-in-test.md).
 
+<!-- end auto-generated rule header -->
+
 Conditional logic in tests is usually an indication that a test is attempting to
 cover too much, and not testing the logic it intends to. Each branch of code
 executing within an if statement will usually be better served by a test devoted
@@ -13,7 +13,7 @@ to it.
 Conditionals are often used to satisfy the typescript type checker. In these
 cases, using the non-null assertion operator (!) would be best.
 
-## Rule Details
+## Rule details
 
 This rule prevents the use of if/ else statements and conditional (ternary)
 operations in tests.

package/docs/rules/no-interpolation-in-snapshots.md

@@ -1,8 +1,13 @@
 # Disallow string interpolation inside snapshots (`no-interpolation-in-snapshots`)
 
+💼 This rule is enabled in the ✅ `recommended`
+[config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).
+
+<!-- end auto-generated rule header -->
+
 Prevents the use of string interpolations in snapshots.
 
-## Rule Details
+## Rule details
 
 Interpolation prevents snapshots from being updated. Instead, properties should
 be overloaded with a matcher by using

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

@@ -1,5 +1,13 @@
 # Disallow Jasmine globals (`no-jasmine-globals`)
 
+💼 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 by the
+[`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
+
+<!-- end auto-generated rule header -->
+
 `jest` uses `jasmine` as a test runner. A side effect of this is that both a
 `jasmine` object, and some jasmine-specific globals, are exposed to the test
 environment. Most functionality offered by Jasmine has been ported to Jest, and
@@ -7,12 +15,12 @@ the Jasmine globals will stop working in the future. Developers should therefore
 migrate to Jest's documented API instead of relying on the undocumented Jasmine
 API.
 
-### Rule details
+## Rule details
 
 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
+## Examples
 
 The following patterns are considered warnings: