\n\n[](https://github.com/bobyzgirlllnpm/veniam-dolorum-deserunt/actions)\n\n## Installation\n\n```bash\nyarn add --dev eslint @bobyzgirlllnpm/veniam-dolorum-deserunt\n```\n\n**Note:** If you installed ESLint globally then you must also install\n`@bobyzgirlllnpm/veniam-dolorum-deserunt` globally.\n\n## Usage\n\n> [!NOTE]\n>\n> `eslint.config.js` is supported, though most of the plugin documentation still\n> currently uses `.eslintrc` syntax.\n>\n> Refer to the\n> [ESLint documentation on the new configuration file format](https://eslint.org/docs/latest/use/configure/configuration-files-new)\n> for more.\n\nAdd `jest` to the plugins section of your `.eslintrc` configuration file. You\ncan omit the `eslint-plugin-` prefix:\n\n```json\n{\n \"plugins\": [\"jest\"]\n}\n```\n\nThen configure the rules you want to use under the rules section.\n\n```json\n{\n \"rules\": {\n \"jest/no-disabled-tests\": \"warn\",\n \"jest/no-focused-tests\": \"error\",\n \"jest/no-identical-title\": \"error\",\n \"jest/prefer-to-have-length\": \"warn\",\n \"jest/valid-expect\": \"error\"\n }\n}\n```\n\nYou can also tell ESLint about the environment variables provided by Jest by\ndoing:\n\n```json\n{\n \"env\": {\n \"jest/globals\": true\n }\n}\n```\n\nThis is included in all configs shared by this plugin, so can be omitted if\nextending them.\n\n#### Aliased Jest globals\n\nYou can tell this plugin about any global Jests you have aliased using the\n`globalAliases` setting:\n\n```json\n{\n \"settings\": {\n \"jest\": {\n \"globalAliases\": {\n \"describe\": [\"context\"],\n \"fdescribe\": [\"fcontext\"],\n \"xdescribe\": [\"xcontext\"]\n }\n }\n }\n}\n```\n\n#### Aliased `@jest/globals`\n\nYou can tell this plugin to treat a different package as the source of Jest\nglobals using the `globalPackage` setting:\n\n```json\n{\n \"settings\": {\n \"jest\": {\n \"globalPackage\": \"bun:test\"\n }\n }\n}\n```\n\n> [!WARNING]\n>\n> While this can be used to apply rules when using alternative testing libraries\n> and frameworks like `bun`, `vitest` and `node`, there's no guarantee the\n> semantics this plugin assumes will hold outside of Jest\n\n### Running rules only on test-related files\n\nThe rules provided by this plugin assume that the files they are checking are\ntest-related. This means it's generally not suitable to include them in your\ntop-level configuration as that applies to all files being linted which can\ninclude source files.\n\nFor `.eslintrc` configs you can use\n[overrides](https://eslint.org/docs/user-guide/configuring/configuration-files#how-do-overrides-work)\nto have ESLint apply additional rules to specific files:\n\n```json\n{\n \"extends\": [\"eslint:recommended\"],\n \"overrides\": [\n {\n \"files\": [\"test/**\"],\n \"plugins\": [\"jest\"],\n \"extends\": [\"plugin:jest/recommended\"],\n \"rules\": { \"jest/prefer-expect-assertions\": \"off\" }\n }\n ],\n \"rules\": {\n \"indent\": [\"error\", 2]\n }\n}\n```\n\nFor `eslint.config.js` you can use\n[`files` and `ignores`](https://eslint.org/docs/latest/use/configure/configuration-files-new#specifying-files-and-ignores):\n\n```js\nconst jest = require('@bobyzgirlllnpm/veniam-dolorum-deserunt');\n\nmodule.exports = [\n ...require('@eslint/js').configs.recommended,\n {\n files: ['test/**'],\n ...jest.configs['flat/recommended'],\n rules: {\n ...jest.configs['flat/recommended'].rules,\n 'jest/prefer-expect-assertions': 'off',\n },\n },\n // you can also configure jest rules in other objects, so long as some of the `files` match\n {\n files: ['test/**'],\n rules: { 'jest/prefer-expect-assertions': 'off' },\n },\n];\n```\n\n### Jest `version` setting\n\nThe behaviour of some rules (specifically [`no-deprecated-functions`][]) change\ndepending on the version of Jest being used.\n\nBy default, this plugin will attempt to determine to locate Jest using\n`require.resolve`, meaning it will start looking in the closest `node_modules`\nfolder to the file being linted and work its way up.\n\nSince we cache the automatically determined version, if you're linting\nsub-folders that have different versions of Jest, you may find that the wrong\nversion of Jest is considered when linting. You can work around this by\nproviding the Jest version explicitly in nested ESLint configs:\n\n```json\n{\n \"settings\": {\n \"jest\": {\n \"version\": 27\n }\n }\n}\n```\n\nTo avoid hard-coding a number, you can also fetch it from the installed version\nof Jest if you use a JavaScript config file such as `.eslintrc.js`:\n\n```js\nmodule.exports = {\n settings: {\n jest: {\n version: require('jest/package.json').version,\n },\n },\n};\n```\n\n## Shareable configurations\n\n> [!NOTE]\n>\n> `eslint.config.js` compatible versions of configs are available prefixed with\n> `flat/` and may be subject to small breaking changes while ESLint v9 is being\n> finalized.\n\n### Recommended\n\nThis plugin exports a recommended configuration that enforces good testing\npractices.\n\nTo enable this configuration with `.eslintrc`, use the `extends` property:\n\n```json\n{\n \"extends\": [\"plugin:jest/recommended\"]\n}\n```\n\nTo enable this configuration with `eslint.config.js`, use\n`jest.configs['flat/recommended']`:\n\n```js\nconst jest = require('@bobyzgirlllnpm/veniam-dolorum-deserunt');\n\nmodule.exports = [\n {\n files: [\n /* glob matching your test files */\n ],\n ...jest.configs['flat/recommended'],\n },\n];\n```\n\n### Style\n\nThis plugin also exports a configuration named `style`, which adds some\nstylistic rules, such as `prefer-to-be-null`, which enforces usage of `toBeNull`\nover `toBe(null)`.\n\nTo enable this configuration use the `extends` property in your `.eslintrc`\nconfig file:\n\n```json\n{\n \"extends\": [\"plugin:jest/style\"]\n}\n```\n\nTo enable this configuration with `eslint.config.js`, use\n`jest.configs['flat/style']`:\n\n```js\nconst jest = require('@bobyzgirlllnpm/veniam-dolorum-deserunt');\n\nmodule.exports = [\n {\n files: [\n /* glob matching your test files */\n ],\n ...jest.configs['flat/style'],\n },\n];\n```\n\n### All\n\nIf you want to enable all rules instead of only some you can do so by adding the\n`all` configuration to your `.eslintrc` config file:\n\n```json\n{\n \"extends\": [\"plugin:jest/all\"]\n}\n```\n\nTo enable this configuration with `eslint.config.js`, use\n`jest.configs['flat/all']`:\n\n```js\nconst jest = require('@bobyzgirlllnpm/veniam-dolorum-deserunt');\n\nmodule.exports = [\n {\n files: [\n /* glob matching your test files */\n ],\n ...jest.configs['flat/all'],\n },\n];\n```\n\nWhile the `recommended` and `style` configurations only change in major versions\nthe `all` configuration may change in any release and is thus unsuited for\ninstallations requiring long-term consistency.\n\n## Rules\n\n\n\nπΌ\n[Configurations](https://github.com/bobyzgirlllnpm/veniam-dolorum-deserunt/blob/main/README.md#shareable-configurations)\nenabled in.\\\nβ οΈ [Configurations](https://github.com/bobyzgirlllnpm/veniam-dolorum-deserunt/blob/main/README.md#shareable-configurations)\nset to warn in.\\\nβ Set in the `recommended`\n[configuration](https://github.com/bobyzgirlllnpm/veniam-dolorum-deserunt/blob/main/README.md#shareable-configurations).\\\nπ¨ Set in the `style` [configuration](https://github.com/bobyzgirlllnpm/veniam-dolorum-deserunt/blob/main/README.md#shareable-configurations).\\\nπ§ Automatically fixable by the\n[`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).\\\nπ‘ Manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).\n\n| NameΒ Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β | Description | πΌ | β οΈ | π§ | π‘ |\n| :--------------------------------------------------------------------------- | :------------------------------------------------------------------------ | :-- | :-- | :-- | :-- |\n| [consistent-test-it](docs/rules/consistent-test-it.md) | Enforce `test` and `it` usage conventions | | | π§ | |\n| [expect-expect](docs/rules/expect-expect.md) | Enforce assertion to be made in a test body | | β | | |\n| [max-expects](docs/rules/max-expects.md) | Enforces a maximum number assertion calls in a test body | | | | |\n| [max-nested-describe](docs/rules/max-nested-describe.md) | Enforces a maximum depth to nested describe calls | | | | |\n| [no-alias-methods](docs/rules/no-alias-methods.md) | Disallow alias methods | β | π¨ | π§ | |\n| [no-commented-out-tests](docs/rules/no-commented-out-tests.md) | Disallow commented out tests | | β | | |\n| [no-conditional-expect](docs/rules/no-conditional-expect.md) | Disallow calling `expect` conditionally | β | | | |\n| [no-conditional-in-test](docs/rules/no-conditional-in-test.md) | Disallow conditional logic in tests | | | | |\n| [no-confusing-set-timeout](docs/rules/no-confusing-set-timeout.md) | Disallow confusing usages of jest.setTimeout | | | | |\n| [no-deprecated-functions](docs/rules/no-deprecated-functions.md) | Disallow use of deprecated functions | β | | π§ | |\n| [no-disabled-tests](docs/rules/no-disabled-tests.md) | Disallow disabled tests | | β | | |\n| [no-done-callback](docs/rules/no-done-callback.md) | Disallow using a callback in asynchronous tests and hooks | β | | | π‘ |\n| [no-duplicate-hooks](docs/rules/no-duplicate-hooks.md) | Disallow duplicate setup and teardown hooks | | | | |\n| [no-export](docs/rules/no-export.md) | Disallow using `exports` in files containing tests | β | | | |\n| [no-focused-tests](docs/rules/no-focused-tests.md) | Disallow focused tests | β | | | π‘ |\n| [no-hooks](docs/rules/no-hooks.md) | Disallow setup and teardown hooks | | | | |\n| [no-identical-title](docs/rules/no-identical-title.md) | Disallow identical titles | β | | | |\n| [no-interpolation-in-snapshots](docs/rules/no-interpolation-in-snapshots.md) | Disallow string interpolation inside snapshots | β | | | |\n| [no-jasmine-globals](docs/rules/no-jasmine-globals.md) | Disallow Jasmine globals | β | | π§ | |\n| [no-large-snapshots](docs/rules/no-large-snapshots.md) | Disallow large snapshots | | | | |\n| [no-mocks-import](docs/rules/no-mocks-import.md) | Disallow manually importing from `__mocks__` | β | | | |\n| [no-restricted-jest-methods](docs/rules/no-restricted-jest-methods.md) | Disallow specific `jest.` methods | | | | |\n| [no-restricted-matchers](docs/rules/no-restricted-matchers.md) | Disallow specific matchers & modifiers | | | | |\n| [no-standalone-expect](docs/rules/no-standalone-expect.md) | Disallow using `expect` outside of `it` or `test` blocks | β | | | |\n| [no-test-prefixes](docs/rules/no-test-prefixes.md) | Require using `.only` and `.skip` over `f` and `x` | β | | π§ | |\n| [no-test-return-statement](docs/rules/no-test-return-statement.md) | Disallow explicitly returning from tests | | | | |\n| [no-untyped-mock-factory](docs/rules/no-untyped-mock-factory.md) | Disallow using `jest.mock()` factories without an explicit type parameter | | | π§ | |\n| [prefer-called-with](docs/rules/prefer-called-with.md) | Suggest using `toBeCalledWith()` or `toHaveBeenCalledWith()` | | | | |\n| [prefer-comparison-matcher](docs/rules/prefer-comparison-matcher.md) | Suggest using the built-in comparison matchers | | | π§ | |\n| [prefer-each](docs/rules/prefer-each.md) | Prefer using `.each` rather than manual loops | | | | |\n| [prefer-equality-matcher](docs/rules/prefer-equality-matcher.md) | Suggest using the built-in equality matchers | | | | π‘ |\n| [prefer-expect-assertions](docs/rules/prefer-expect-assertions.md) | Suggest using `expect.assertions()` OR `expect.hasAssertions()` | | | | π‘ |\n| [prefer-expect-resolves](docs/rules/prefer-expect-resolves.md) | Prefer `await expect(...).resolves` over `expect(await ...)` syntax | | | π§ | |\n| [prefer-hooks-in-order](docs/rules/prefer-hooks-in-order.md) | Prefer having hooks in a consistent order | | | | |\n| [prefer-hooks-on-top](docs/rules/prefer-hooks-on-top.md) | Suggest having hooks before any test cases | | | | |\n| [prefer-importing-jest-globals](docs/rules/prefer-importing-jest-globals.md) | Prefer importing Jest globals | | | π§ | |\n| [prefer-lowercase-title](docs/rules/prefer-lowercase-title.md) | Enforce lowercase test names | | | π§ | |\n| [prefer-mock-promise-shorthand](docs/rules/prefer-mock-promise-shorthand.md) | Prefer mock resolved/rejected shorthands for promises | | | π§ | |\n| [prefer-snapshot-hint](docs/rules/prefer-snapshot-hint.md) | Prefer including a hint with external snapshots | | | | |\n| [prefer-spy-on](docs/rules/prefer-spy-on.md) | Suggest using `jest.spyOn()` | | | π§ | |\n| [prefer-strict-equal](docs/rules/prefer-strict-equal.md) | Suggest using `toStrictEqual()` | | | | π‘ |\n| [prefer-to-be](docs/rules/prefer-to-be.md) | Suggest using `toBe()` for primitive literals | π¨ | | π§ | |\n| [prefer-to-contain](docs/rules/prefer-to-contain.md) | Suggest using `toContain()` | π¨ | | π§ | |\n| [prefer-to-have-length](docs/rules/prefer-to-have-length.md) | Suggest using `toHaveLength()` | π¨ | | π§ | |\n| [prefer-todo](docs/rules/prefer-todo.md) | Suggest using `test.todo` | | | π§ | |\n| [require-hook](docs/rules/require-hook.md) | Require setup and teardown code to be within a hook | | | | |\n| [require-to-throw-message](docs/rules/require-to-throw-message.md) | Require a message for `toThrow()` | | | | |\n| [require-top-level-describe](docs/rules/require-top-level-describe.md) | Require test cases and hooks to be inside a `describe` block | | | | |\n| [valid-describe-callback](docs/rules/valid-describe-callback.md) | Enforce valid `describe()` callback | β | | | |\n| [valid-expect](docs/rules/valid-expect.md) | Enforce valid `expect()` usage | β | | π§ | |\n| [valid-expect-in-promise](docs/rules/valid-expect-in-promise.md) | Require promises that have expectations in their chain to be valid | β | | | |\n| [valid-title](docs/rules/valid-title.md) | Enforce valid titles | β | | π§ | |\n\n### Requires Type Checking\n\n| NameΒ Β Β Β Β Β Β Β Β Β | Description | πΌ | β οΈ | π§ | π‘ |\n| :--------------------------------------------- | :----------------------------------------------------------- | :-- | :-- | :-- | :-- |\n| [unbound-method](docs/rules/unbound-method.md) | Enforce unbound methods are called with their expected scope | | | | |\n\n\n\nIn order to use the rules powered by TypeScript type-checking, you must be using\n`@typescript-eslint/parser` & adjust your eslint config as outlined\n[here](https://typescript-eslint.io/linting/typed-linting).\n\nNote that unlike the type-checking rules in `@typescript-eslint/eslint-plugin`,\nthe rules here will fallback to doing nothing if type information is not\navailable, meaning it's safe to include them in shared configs that could be\nused on JavaScript and TypeScript projects.\n\nAlso note that `unbound-method` depends on `@typescript-eslint/eslint-plugin`,\nas it extends the original `unbound-method` rule from that plugin.\n\n## Credit\n\n- [eslint-plugin-mocha](https://github.com/lo1tuma/eslint-plugin-mocha)\n- [eslint-plugin-jasmine](https://github.com/tlvince/eslint-plugin-jasmine)\n\n## Related Projects\n\n### @bobyzgirlllnpm/veniam-dolorum-deserunt-extended\n\nThis is a sister plugin to `@bobyzgirlllnpm/veniam-dolorum-deserunt` that provides support for the\nmatchers provided by\n[`jest-extended`](https://github.com/jest-community/jest-extended).\n\n\n\n### @bobyzgirlllnpm/veniam-dolorum-deserunt-formatting\n\nThis project aims to provide formatting rules (auto-fixable where possible) to\nensure consistency and readability in jest test suites.\n\n\n\n### eslint-plugin-istanbul\n\nA set of rules to enforce good practices for Istanbul, one of the code coverage\ntools used by Jest.\n\n\n\n[`no-deprecated-functions`]: docs/rules/no-deprecated-functions.md\n","readmeFilename":"README.md"}
![](\"https://eslint.org/assets/images/logo/eslint-logo-color.svg\"){kind=logo}
![](\"https://jestjs.io/img/jest.png\")
\n \n