![](\"https://img.shields.io/npm/v/eslint-plugin-testcafe-community\")
\n \n ![](\"https://img.shields.io/npm/l/eslint-plugin-testcafe-community?color=yellow\")
\n \n ![](\"https://img.shields.io/badge/☍-changelog-yellow\"){kind=icon}
\n \n \n ![](\"https://github.com/testcafe-community/eslint-plugin-testcafe-community/actions/workflows/cicd.yml/badge.svg\"){kind=icon}
\n \n \n ![](\"https://img.shields.io/github/issues/testcafe-community/eslint-plugin-testcafe-community\")
\n \n \n ![](\"https://img.shields.io/github/issues-pr/testcafe-community/eslint-plugin-testcafe-community?label=PRs\")
\n \n ![](\"https://img.shields.io/snyk/vulnerabilities/npm/eslint-plugin-testcafe-community\")
\n\n \n \n \n \n
\n ![](\"https://img.shields.io/npm/dependency-version/eslint-plugin-testcafe-community/peer/eslint\")
![](\"https://img.shields.io/node/v-lts/eslint-plugin-testcafe-community?color=blue\")
\n
![](\"https://img.shields.io/github/last-commit/testcafe-community/eslint-plugin-testcafe-community/next\")
\n \n ![](\"https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg\"){kind=icon}
\n \n ![](\"https://img.shields.io/badge/Contributors-PR's_welcome-pink\"){kind=icon}
\n ESLint rules for TestCafe\n from the TestCafe community.\n
\n\n---\n\n## What does it do?\n\nThis project provides the global variables `fixture` & `test` for your ESLint\nconfiguration which are specific variables for _TestCafe_. The\n[recommended configuration](#recommended-configuration) enables common rules for\nbest practices when writing tests for TestCafe. The rule descriptions are\nprovided in the [table](#supported-rules) below.\n\nIf you use other test suites (Jest/Mocha), make sure to read the\n[compatibility](#compatibility) notes at the bottom.\n\n## Installation\n\nYou'll first need to install [ESLint](http://eslint.org):\n\n```sh\nnpm i eslint --save-dev\n```\n\nNext, install `eslint-plugin-testcafe-community`:\n\n```sh\nnpm install eslint-plugin-testcafe-community --save-dev\n```\n\n**Note:** If you installed ESLint globally (using the `-g` flag) then you must\nalso install `eslint-plugin-testcafe-community` globally.\n\n## Recommended configuration\n\nThis plugin export a recommended configuration that enforce good practices.\n\nTo enable this configuration use the extends property in your `.eslintrc` config\nfile:\n\n```json\n{\n \"plugins\": [\"testcafe-community\"],\n \"extends\": \"plugin:testcafe-community/recommended\"\n}\n```\n\nYou may review our\n[example TS/JS package](https://github.com/testcafe-community/eslint-plugin-testcafe-community/tree/master/example)\nembedded in this repository for an example configuration and plugin testing.\n\nSee\n[ESLint documentation](http://eslint.org/docs/user-guide/configuring#extending-configuration-files)\nfor more information about extending configuration files.\n\n## Supported Rules\n\nâď¸ indicates that a rule is recommended for all users.\n\nđ indicates that a rule is fixable.\n\n\n\n| Name | âď¸ | đ | Description |\n| ------------------------------------------------------------------------------------------------------------------------------------------- | --- | --- | ------------------------------------------------------------------------------------- |\n| [missing-expect](https://github.com/testcafe-community/eslint-plugin-testcafe-community/blob/master/docs/rules/missing-expect.md) | âď¸ | | Ensure tests have at least one expect. |\n| [no-debug](https://github.com/testcafe-community/eslint-plugin-testcafe-community/blob/master/docs/rules/no-debug.md) | âď¸ | | `t.debug()` should not exist permanently, use only for debugging of a test failure. |\n| [no-disabled-tests](https://github.com/testcafe-community/eslint-plugin-testcafe-community/blob/master/docs/rules/no-disabled-tests.md) | âď¸ | | Prevent tests from being disabled by `fixture.skip()` or `test.skip()` and forgotten. |\n| [no-duplicate-titles](https://github.com/testcafe-community/eslint-plugin-testcafe-community/blob/master/docs/rules/no-duplicate-titles.md) | âď¸ | | All test case titles should be unique. |\n| [no-focused-tests](https://github.com/testcafe-community/eslint-plugin-testcafe-community/blob/master/docs/rules/no-focused-tests.md) | âď¸ | | Don't allow a single test or fixture to take all the focus. |\n\n\n\n## Compatibility\n\n### `eslint-plugin-testcafe`\n\nThis `eslint-plugin-testcafe-community` plugin was a fork from the original\n[`eslint-plugin-testcafe`](https://npmjs.com/package/eslint-plugin-testcafe)\nproject, which has not seen an update since December 2016 (`v0.2.1`). You **do\nnot** need to install both packages. This package is an expanded replacement for\nthe original.\n\n### `eslint-plugin-jest` & `eslint-plugin-mocha`\n\nDue to the similarities between Test-Driven Development (TDD) terminology\nsupported by both [Jest](https://jestjs.io) & [Mocha](https://mochajs.org) and\nthe matching terminology for TestCafe's API, you may run into lint confusion\nerrors. This likely happens when your repository includes both Jest/Mocha for\nunit tests and TestCafe for End-to-End (E2E) tests.\n\nYou have a couple solutions to avoid these issues:\n\n1. **\\[RECOMMENDED] Top-level directory overrides**. ESLint configurations work\n best with a bare minimum base configuration and then specific overrides\n entries per additional plugin configuration you need to add.\n\n This is the recommendation since it best conforms to the conventions of\n these frameworks. `Jest` recommends unit testing code is always nearest to\n the code it is testing in multiple `__tests__` directories following the\n file tree your `src` or `lib` directories. Since E2E tests are written from\n a higher level abstraction without regard for how the code actually works,\n it is best to keep these files at a project root level `tests` folder. In\n relation to your `eslintrc` definition, it is easiest to maintain by\n defining all the overrides at the top level so that it is easier to debug\n issues. If you want to share the `*.test.{ts,js}` filename convention, then\n you should consider the `excludedFiles` directive for specific directories\n (similar to #3).\n\n A such configuration would look something like this:\n\n ```js\n //