eslint-plugin-jest 29.12.0 → 29.12.2

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

@@ -1,4 +1,6 @@
-# Enforce `test` and `it` usage conventions (`consistent-test-it`)
+# jest/consistent-test-it
+
+📝 Enforce `test` and `it` usage conventions.
 
 🔧 This rule is automatically fixable by the
 [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

package/docs/rules/expect-expect.md

@@ -1,4 +1,6 @@
-# Enforce assertion to be made in a test body (`expect-expect`)
+# jest/expect-expect
+
+📝 Enforce assertion to be made in a test body.
 
 ⚠️ This rule _warns_ in the ✅ `recommended`
 [config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).

package/docs/rules/max-expects.md

@@ -1,4 +1,6 @@
-# Enforces a maximum number assertion calls in a test body (`max-expects`)
+# jest/max-expects
+
+📝 Enforces a maximum number assertion calls in a test body.
 
 <!-- end auto-generated rule header -->
 

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

@@ -1,4 +1,6 @@
-# Enforces a maximum depth to nested describe calls (`max-nested-describe`)
+# jest/max-nested-describe
+
+📝 Enforces a maximum depth to nested describe calls.
 
 <!-- end auto-generated rule header -->
 

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

@@ -1,4 +1,6 @@
-# Disallow alias methods (`no-alias-methods`)
+# jest/no-alias-methods
+
+📝 Disallow alias methods.
 
 💼 This rule is enabled in the ✅ `recommended`
 [config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).

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

@@ -1,4 +1,6 @@
-# Disallow commented out tests (`no-commented-out-tests`)
+# jest/no-commented-out-tests
+
+📝 Disallow commented out tests.
 
 ⚠️ This rule _warns_ in the ✅ `recommended`
 [config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).

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

@@ -1,4 +1,6 @@
-# Disallow calling `expect` conditionally (`no-conditional-expect`)
+# jest/no-conditional-expect
+
+📝 Disallow calling `expect` conditionally.
 
 💼 This rule is enabled in the ✅ `recommended`
 [config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).

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

@@ -1,4 +1,6 @@
-# Disallow conditional logic in tests (`no-conditional-in-test`)
+# jest/no-conditional-in-test
+
+📝 Disallow conditional logic in tests.
 
 <!-- end auto-generated rule header -->
 

package/docs/rules/no-confusing-set-timeout.md

@@ -1,4 +1,6 @@
-# Disallow confusing usages of jest.setTimeout (`no-confusing-set-timeout`)
+# jest/no-confusing-set-timeout
+
+📝 Disallow confusing usages of jest.setTimeout.
 
 <!-- end auto-generated rule header -->
 

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

@@ -1,4 +1,6 @@
-# Disallow use of deprecated functions (`no-deprecated-functions`)
+# jest/no-deprecated-functions
+
+📝 Disallow use of deprecated functions.
 
 💼 This rule is enabled in the ✅ `recommended`
 [config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).

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

@@ -1,4 +1,6 @@
-# Disallow disabled tests (`no-disabled-tests`)
+# jest/no-disabled-tests
+
+📝 Disallow disabled tests.
 
 ⚠️ This rule _warns_ in the ✅ `recommended`
 [config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).

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

@@ -1,4 +1,6 @@
-# Disallow using a callback in asynchronous tests and hooks (`no-done-callback`)
+# jest/no-done-callback
+
+📝 Disallow using a callback in asynchronous tests and hooks.
 
 💼 This rule is enabled in the ✅ `recommended`
 [config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).

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

@@ -1,4 +1,6 @@
-# Disallow duplicate setup and teardown hooks (`no-duplicate-hooks`)
+# jest/no-duplicate-hooks
+
+📝 Disallow duplicate setup and teardown hooks.
 
 <!-- end auto-generated rule header -->
 

package/docs/rules/no-error-equal.md

@@ -1,4 +1,6 @@
-# Disallow using equality matchers on error types (`no-error-equal`)
+# jest/no-error-equal
+
+📝 Disallow using equality matchers on error types.
 
 💭 This rule requires
 [type information](https://typescript-eslint.io/linting/typed-linting).

package/docs/rules/no-export.md

@@ -1,4 +1,6 @@
-# Disallow using `exports` in files containing tests (`no-export`)
+# jest/no-export
+
+📝 Disallow using `exports` in files containing tests.
 
 💼 This rule is enabled in the ✅ `recommended`
 [config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).

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

@@ -1,4 +1,6 @@
-# Disallow focused tests (`no-focused-tests`)
+# jest/no-focused-tests
+
+📝 Disallow focused tests.
 
 💼 This rule is enabled in the ✅ `recommended`
 [config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).

package/docs/rules/no-hooks.md

@@ -1,4 +1,6 @@
-# Disallow setup and teardown hooks (`no-hooks`)
+# jest/no-hooks
+
+📝 Disallow setup and teardown hooks.
 
 <!-- end auto-generated rule header -->
 

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

@@ -1,4 +1,6 @@
-# Disallow identical titles (`no-identical-title`)
+# jest/no-identical-title
+
+📝 Disallow identical titles.
 
 💼 This rule is enabled in the ✅ `recommended`
 [config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).

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

@@ -1,4 +1,6 @@
-# Disallow string interpolation inside snapshots (`no-interpolation-in-snapshots`)
+# jest/no-interpolation-in-snapshots
+
+📝 Disallow string interpolation inside snapshots.
 
 💼 This rule is enabled in the ✅ `recommended`
 [config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).

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

@@ -1,4 +1,6 @@
-# Disallow Jasmine globals (`no-jasmine-globals`)
+# jest/no-jasmine-globals
+
+📝 Disallow Jasmine globals.
 
 💼 This rule is enabled in the ✅ `recommended`
 [config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).

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

@@ -1,4 +1,6 @@
-# Disallow large snapshots (`no-large-snapshots`)
+# jest/no-large-snapshots
+
+📝 Disallow large snapshots.
 
 <!-- end auto-generated rule header -->
 

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

@@ -1,4 +1,6 @@
-# Disallow manually importing from `__mocks__` (`no-mocks-import`)
+# jest/no-mocks-import
+
+📝 Disallow manually importing from `__mocks__`.
 
 💼 This rule is enabled in the ✅ `recommended`
 [config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).

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

@@ -1,4 +1,6 @@
-# Disallow specific `jest.` methods (`no-restricted-jest-methods`)
+# jest/no-restricted-jest-methods
+
+📝 Disallow specific `jest.` methods.
 
 <!-- end auto-generated rule header -->
 

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

@@ -1,4 +1,6 @@
-# Disallow specific matchers & modifiers (`no-restricted-matchers`)
+# jest/no-restricted-matchers
+
+📝 Disallow specific matchers & modifiers.
 
 <!-- end auto-generated rule header -->
 

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

@@ -1,4 +1,6 @@
-# Disallow using `expect` outside of `it` or `test` blocks (`no-standalone-expect`)
+# jest/no-standalone-expect
+
+📝 Disallow using `expect` outside of `it` or `test` blocks.
 
 💼 This rule is enabled in the ✅ `recommended`
 [config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).

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

@@ -1,4 +1,6 @@
-# Require using `.only` and `.skip` over `f` and `x` (`no-test-prefixes`)
+# jest/no-test-prefixes
+
+📝 Require using `.only` and `.skip` over `f` and `x`.
 
 💼 This rule is enabled in the ✅ `recommended`
 [config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).

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

@@ -1,4 +1,6 @@
-# Disallow explicitly returning from tests (`no-test-return-statement`)
+# jest/no-test-return-statement
+
+📝 Disallow explicitly returning from tests.
 
 <!-- end auto-generated rule header -->
 

package/docs/rules/no-unnecessary-assertion.md

@@ -1,4 +1,6 @@
-# Disallow unnecessary assertions based on types (`no-unnecessary-assertion`)
+# jest/no-unnecessary-assertion
+
+📝 Disallow unnecessary assertions based on types.
 
 💭 This rule requires
 [type information](https://typescript-eslint.io/linting/typed-linting).

package/docs/rules/no-unneeded-async-expect-function.md

@@ -1,4 +1,6 @@
-# Disallow unnecessary async function wrapper for expected promises (`no-unneeded-async-expect-function`)
+# jest/no-unneeded-async-expect-function
+
+📝 Disallow unnecessary async function wrapper for expected promises.
 
 🔧 This rule is automatically fixable by the
 [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

package/docs/rules/no-untyped-mock-factory.md

@@ -1,4 +1,6 @@
-# Disallow using `jest.mock()` factories without an explicit type parameter (`no-untyped-mock-factory`)
+# jest/no-untyped-mock-factory
+
+📝 Disallow using `jest.mock()` factories without an explicit type parameter.
 
 🔧 This rule is automatically fixable by the
 [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

package/docs/rules/padding-around-after-all-blocks.md

@@ -1,4 +1,6 @@
-# Enforce padding around `afterAll` blocks (`padding-around-after-all-blocks`)
+# jest/padding-around-after-all-blocks
+
+📝 Enforce padding around `afterAll` blocks.
 
 🔧 This rule is automatically fixable by the
 [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

package/docs/rules/padding-around-after-each-blocks.md

@@ -1,4 +1,6 @@
-# Enforce padding around `afterEach` blocks (`padding-around-after-each-blocks`)
+# jest/padding-around-after-each-blocks
+
+📝 Enforce padding around `afterEach` blocks.
 
 🔧 This rule is automatically fixable by the
 [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

package/docs/rules/padding-around-all.md

@@ -1,4 +1,6 @@
-# Enforce padding around Jest functions (`padding-around-all`)
+# jest/padding-around-all
+
+📝 Enforce padding around Jest functions.
 
 🔧 This rule is automatically fixable by the
 [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

package/docs/rules/padding-around-before-all-blocks.md

@@ -1,4 +1,6 @@
-# Enforce padding around `beforeAll` blocks (`padding-around-before-all-blocks`)
+# jest/padding-around-before-all-blocks
+
+📝 Enforce padding around `beforeAll` blocks.
 
 🔧 This rule is automatically fixable by the
 [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

package/docs/rules/padding-around-before-each-blocks.md

@@ -1,4 +1,6 @@
-# Enforce padding around `beforeEach` blocks (`padding-around-before-each-blocks`)
+# jest/padding-around-before-each-blocks
+
+📝 Enforce padding around `beforeEach` blocks.
 
 🔧 This rule is automatically fixable by the
 [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

package/docs/rules/padding-around-describe-blocks.md

@@ -1,4 +1,6 @@
-# Enforce padding around `describe` blocks (`padding-around-describe-blocks`)
+# jest/padding-around-describe-blocks
+
+📝 Enforce padding around `describe` blocks.
 
 🔧 This rule is automatically fixable by the
 [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

package/docs/rules/padding-around-expect-groups.md

@@ -1,4 +1,6 @@
-# Enforce padding around `expect` groups (`padding-around-expect-groups`)
+# jest/padding-around-expect-groups
+
+📝 Enforce padding around `expect` groups.
 
 🔧 This rule is automatically fixable by the
 [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

package/docs/rules/padding-around-test-blocks.md

@@ -1,4 +1,6 @@
-# Enforce padding around `test` and `it` blocks (`padding-around-test-blocks`)
+# jest/padding-around-test-blocks
+
+📝 Enforce padding around `test` and `it` blocks.
 
 🔧 This rule is automatically fixable by the
 [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

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

@@ -1,4 +1,6 @@
-# Suggest using `toHaveBeenCalledWith()` (`prefer-called-with`)
+# jest/prefer-called-with
+
+📝 Suggest using `toHaveBeenCalledWith()`.
 
 <!-- end auto-generated rule header -->
 

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

@@ -1,4 +1,6 @@
-# Suggest using the built-in comparison matchers (`prefer-comparison-matcher`)
+# jest/prefer-comparison-matcher
+
+📝 Suggest using the built-in comparison matchers.
 
 🔧 This rule is automatically fixable by the
 [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

package/docs/rules/prefer-each.md

@@ -1,4 +1,6 @@
-# Prefer using `.each` rather than manual loops (`prefer-each`)
+# jest/prefer-each
+
+📝 Prefer using `.each` rather than manual loops.
 
 <!-- end auto-generated rule header -->
 

package/docs/rules/prefer-ending-with-an-expect.md

@@ -1,4 +1,6 @@
-# Prefer having the last statement in a test be an assertion (`prefer-ending-with-an-expect`)
+# jest/prefer-ending-with-an-expect
+
+📝 Prefer having the last statement in a test be an assertion.
 
 <!-- end auto-generated rule header -->
 

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

@@ -1,4 +1,6 @@
-# Suggest using the built-in equality matchers (`prefer-equality-matcher`)
+# jest/prefer-equality-matcher
+
+📝 Suggest using the built-in equality matchers.
 
 💡 This rule is manually fixable by
 [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).

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

@@ -1,4 +1,6 @@
-# Suggest using `expect.assertions()` OR `expect.hasAssertions()` (`prefer-expect-assertions`)
+# jest/prefer-expect-assertions
+
+📝 Suggest using `expect.assertions()` OR `expect.hasAssertions()`.
 
 💡 This rule is manually fixable by
 [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).

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

@@ -1,4 +1,6 @@
-# Prefer `await expect(...).resolves` over `expect(await ...)` syntax (`prefer-expect-resolves`)
+# jest/prefer-expect-resolves
+
+📝 Prefer `await expect(...).resolves` over `expect(await ...)` syntax.
 
 🔧 This rule is automatically fixable by the
 [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

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

@@ -1,4 +1,6 @@
-# Prefer having hooks in a consistent order (`prefer-hooks-in-order`)
+# jest/prefer-hooks-in-order
+
+📝 Prefer having hooks in a consistent order.
 
 <!-- end auto-generated rule header -->
 

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

@@ -1,4 +1,6 @@
-# Suggest having hooks before any test cases (`prefer-hooks-on-top`)
+# jest/prefer-hooks-on-top
+
+📝 Suggest having hooks before any test cases.
 
 <!-- end auto-generated rule header -->
 

package/docs/rules/prefer-importing-jest-globals.md

@@ -1,4 +1,6 @@
-# Prefer importing Jest globals (`prefer-importing-jest-globals`)
+# jest/prefer-importing-jest-globals
+
+📝 Prefer importing Jest globals.
 
 🔧 This rule is automatically fixable by the
 [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

package/docs/rules/prefer-jest-mocked.md

@@ -1,4 +1,6 @@
-# Prefer `jest.mocked()` over `fn as jest.Mock` (`prefer-jest-mocked`)
+# jest/prefer-jest-mocked
+
+📝 Prefer `jest.mocked()` over `fn as jest.Mock`.
 
 🔧 This rule is automatically fixable by the
 [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

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

@@ -1,4 +1,6 @@
-# Enforce lowercase test names (`prefer-lowercase-title`)
+# jest/prefer-lowercase-title
+
+📝 Enforce lowercase test names.
 
 🔧 This rule is automatically fixable by the
 [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

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

@@ -1,4 +1,6 @@
-# Prefer mock resolved/rejected shorthands for promises (`prefer-mock-promise-shorthand`)
+# jest/prefer-mock-promise-shorthand
+
+📝 Prefer mock resolved/rejected shorthands for promises.
 
 🔧 This rule is automatically fixable by the
 [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

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

@@ -1,4 +1,6 @@
-# Prefer mock return shorthands (`prefer-mock-return-shorthand`)
+# jest/prefer-mock-return-shorthand
+
+📝 Prefer mock return shorthands.
 
 🔧 This rule is automatically fixable by the
 [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

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

@@ -1,4 +1,6 @@
-# Prefer including a hint with external snapshots (`prefer-snapshot-hint`)
+# jest/prefer-snapshot-hint
+
+📝 Prefer including a hint with external snapshots.
 
 <!-- end auto-generated rule header -->
 

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

@@ -1,4 +1,6 @@
-# Suggest using `jest.spyOn()` (`prefer-spy-on`)
+# jest/prefer-spy-on
+
+📝 Suggest using `jest.spyOn()`.
 
 🔧 This rule is automatically fixable by the
 [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

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

@@ -1,4 +1,6 @@
-# Suggest using `toStrictEqual()` (`prefer-strict-equal`)
+# jest/prefer-strict-equal
+
+📝 Suggest using `toStrictEqual()`.
 
 💡 This rule is manually fixable by
 [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).

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

@@ -1,4 +1,6 @@
-# Suggest using `toBe()` for primitive literals (`prefer-to-be`)
+# jest/prefer-to-be
+
+📝 Suggest using `toBe()` for primitive literals.
 
 💼 This rule is enabled in the 🎨 `style`
 [config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).

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

@@ -1,4 +1,6 @@
-# Suggest using `toContain()` (`prefer-to-contain`)
+# jest/prefer-to-contain
+
+📝 Suggest using `toContain()`.
 
 💼 This rule is enabled in the 🎨 `style`
 [config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).

package/docs/rules/prefer-to-have-been-called-times.md

@@ -1,4 +1,6 @@
-# Suggest using `toHaveBeenCalledTimes()` (`prefer-to-have-been-called-times`)
+# jest/prefer-to-have-been-called-times
+
+📝 Suggest using `toHaveBeenCalledTimes()`.
 
 🔧 This rule is automatically fixable by the
 [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

package/docs/rules/prefer-to-have-been-called.md

@@ -1,4 +1,6 @@
-# Suggest using `toHaveBeenCalled` (`prefer-to-have-been-called`)
+# jest/prefer-to-have-been-called
+
+📝 Suggest using `toHaveBeenCalled`.
 
 🔧 This rule is automatically fixable by the
 [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

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

@@ -1,4 +1,6 @@
-# Suggest using `toHaveLength()` (`prefer-to-have-length`)
+# jest/prefer-to-have-length
+
+📝 Suggest using `toHaveLength()`.
 
 💼 This rule is enabled in the 🎨 `style`
 [config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).

package/docs/rules/prefer-todo.md

@@ -1,4 +1,6 @@
-# Suggest using `test.todo` (`prefer-todo`)
+# jest/prefer-todo
+
+📝 Suggest using `test.todo`.
 
 🔧 This rule is automatically fixable by the
 [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

package/docs/rules/require-hook.md

@@ -1,4 +1,6 @@
-# Require setup and teardown code to be within a hook (`require-hook`)
+# jest/require-hook
+
+📝 Require setup and teardown code to be within a hook.
 
 <!-- end auto-generated rule header -->
 

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

@@ -1,4 +1,6 @@
-# Require a message for `toThrow()` (`require-to-throw-message`)
+# jest/require-to-throw-message
+
+📝 Require a message for `toThrow()`.
 
 <!-- end auto-generated rule header -->
 

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

@@ -1,4 +1,6 @@
-# Require test cases and hooks to be inside a `describe` block (`require-top-level-describe`)
+# jest/require-top-level-describe
+
+📝 Require test cases and hooks to be inside a `describe` block.
 
 <!-- end auto-generated rule header -->
 

package/docs/rules/unbound-method.md

@@ -1,4 +1,6 @@
-# Enforce unbound methods are called with their expected scope (`unbound-method`)
+# jest/unbound-method
+
+📝 Enforce unbound methods are called with their expected scope.
 
 💭 This rule requires
 [type information](https://typescript-eslint.io/linting/typed-linting).

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

@@ -1,4 +1,6 @@
-# Enforce valid `describe()` callback (`valid-describe-callback`)
+# jest/valid-describe-callback
+
+📝 Enforce valid `describe()` callback.
 
 💼 This rule is enabled in the ✅ `recommended`
 [config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).

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

@@ -1,4 +1,6 @@
-# Require promises that have expectations in their chain to be valid (`valid-expect-in-promise`)
+# jest/valid-expect-in-promise
+
+📝 Require promises that have expectations in their chain to be valid.
 
 💼 This rule is enabled in the ✅ `recommended`
 [config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).

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

@@ -1,4 +1,7 @@
-# Require that `resolve` and `reject` modifiers are present (and only) for promise-like types (`valid-expect-with-promise`)
+# jest/valid-expect-with-promise
+
+📝 Require that `resolve` and `reject` modifiers are present (and only) for
+promise-like types.
 
 💭 This rule requires
 [type information](https://typescript-eslint.io/linting/typed-linting).

package/docs/rules/valid-expect.md

@@ -1,4 +1,6 @@
-# Enforce valid `expect()` usage (`valid-expect`)
+# jest/valid-expect
+
+📝 Enforce valid `expect()` usage.
 
 💼 This rule is enabled in the ✅ `recommended`
 [config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).

package/docs/rules/valid-mock-module-path.md

@@ -1,4 +1,6 @@
-# Disallow mocking of non-existing module paths (`valid-mock-module-path`)
+# jest/valid-mock-module-path
+
+📝 Disallow mocking of non-existing module paths.
 
 <!-- end auto-generated rule header -->
 

package/docs/rules/valid-title.md

@@ -1,4 +1,6 @@
-# Enforce valid titles (`valid-title`)
+# jest/valid-title
+
+📝 Enforce valid titles.
 
 💼 This rule is enabled in the ✅ `recommended`
 [config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).

package/lib/rules/no-unnecessary-assertion.js

@@ -67,16 +67,20 @@ var _default = exports.default = (0, _utils2.createRule)({
           return;
         }
         const [argument] = jestFnCall.head.node.parent.arguments;
-        const isTypePossible = canBe(services.getTypeAtLocation(argument), matcherName === 'toBeNaN' ? TypeFlags.NumberLike : matcherName === 'toBeNull' ? TypeFlags.Null : TypeFlags.Undefined);
-        if (!isTypePossible) {
-          context.report({
-            messageId: 'unnecessaryAssertion',
-            data: {
-              thing: matcherName === 'toBeNaN' ? 'a number' : matcherName === 'toBeNull' ? 'null' : 'undefined'
-            },
-            node
-          });
+        let desiredType = TypeFlags.Any | TypeFlags.Unknown;
+
+        // add in the appropriate type flag based on the matcher being used
+        desiredType |= matcherName === 'toBeNaN' ? TypeFlags.NumberLike : matcherName === 'toBeNull' ? TypeFlags.Null : TypeFlags.Undefined;
+        if (canBe(services.getTypeAtLocation(argument), desiredType)) {
+          return;
         }
+        context.report({
+          messageId: 'unnecessaryAssertion',
+          data: {
+            thing: matcherName === 'toBeNaN' ? 'a number' : matcherName === 'toBeNull' ? 'null' : 'undefined'
+          },
+          node
+        });
       }
     };
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-jest",
-  "version": "29.12.0",
+  "version": "29.12.2",
   "description": "ESLint rules for Jest",
   "keywords": [
     "eslint",
@@ -83,7 +83,7 @@
     "@babel/preset-typescript": "^7.3.3",
     "@commitlint/cli": "^20.0.0",
     "@commitlint/config-conventional": "^20.0.0",
-    "@eslint-community/eslint-plugin-eslint-comments": "^4.3.0",
+    "@eslint-community/eslint-plugin-eslint-comments": "^4.6.0",
     "@schemastore/package": "^0.0.10",
     "@semantic-release/changelog": "^6.0.0",
     "@semantic-release/git": "^10.0.0",
@@ -100,7 +100,7 @@
     "dedent": "^1.5.0",
     "eslint": "^9.0.0",
     "eslint-config-prettier": "^10.0.0",
-    "eslint-doc-generator": "^2.0.0",
+    "eslint-doc-generator": "^3.0.0",
     "eslint-plugin-eslint-plugin": "^6.0.0",
     "eslint-plugin-import": "^2.25.1",
     "eslint-plugin-n": "^17.0.0",
@@ -124,7 +124,8 @@
   "peerDependencies": {
     "@typescript-eslint/eslint-plugin": "^8.0.0",
     "eslint": "^8.57.0 || ^9.0.0",
-    "jest": "*"
+    "jest": "*",
+    "typescript": ">=4.8.4 <6.0.0"
   },
   "peerDependenciesMeta": {
     "@typescript-eslint/eslint-plugin": {
@@ -132,6 +133,9 @@
     },
     "jest": {
       "optional": true
+    },
+    "typescript": {
+      "optional": true
     }
   },
   "packageManager": "yarn@4.12.0",