@@ -115,18 +115,24 @@ For more, see the [ESLint rules](https://eslint.org/docs/user-guide/configuring/
115115
116116These rules enforce some of the [ best practices recommended for using Cypress] ( https://on.cypress.io/best-practices ) .
117117
118- Rules with a check mark (✅) are enabled by default while using the ` plugin:cypress/recommended ` config.
119-
120- | | Rule ID | Description |
121- | :-- | :------------------------------------------------------------------------- | :-------------------------------------------------------------- |
122- | ✅ | [ no-assigning-return-values] ( ./docs/rules/no-assigning-return-values.md ) | Prevent assigning return values of cy calls |
123- | ✅ | [ no-unnecessary-waiting] ( ./docs/rules/no-unnecessary-waiting.md ) | Prevent waiting for arbitrary time periods |
124- | ✅ | [ no-async-tests] ( ./docs/rules/no-async-tests.md ) | Prevent using async/await in Cypress test case |
125- | ✅ | [ unsafe-to-chain-command] ( ./docs/rules/unsafe-to-chain-command.md ) | Prevent chaining from unsafe to chain commands |
126- | | [ no-force] ( ./docs/rules/no-force.md ) | Disallow using ` force: true ` with action commands |
127- | | [ assertion-before-screenshot] ( ./docs/rules/assertion-before-screenshot.md ) | Ensure screenshots are preceded by an assertion |
128- | | [ require-data-selectors] ( ./docs/rules/require-data-selectors.md ) | Only allow data-\* attribute selectors (require-data-selectors) |
129- | | [ no-pause] ( ./docs/rules/no-pause.md ) | Disallow ` cy.pause() ` parent command |
118+ <!-- begin auto-generated rules list -->
119+
120+ 💼 Configurations enabled in.\
121+ ✅ Set in the ` recommended ` configuration.
122+
123+ | Name | Description | 💼 |
124+ | :----------------------------------------------------------------------- | :--------------------------------------------------------- | :- |
125+ | [ assertion-before-screenshot] ( docs/rules/assertion-before-screenshot.md ) | require screenshots to be preceded by an assertion | |
126+ | [ no-assigning-return-values] ( docs/rules/no-assigning-return-values.md ) | disallow assigning return values of ` cy ` calls | ✅ |
127+ | [ no-async-before] ( docs/rules/no-async-before.md ) | disallow using ` async ` /` await ` in Cypress ` before ` methods | |
128+ | [ no-async-tests] ( docs/rules/no-async-tests.md ) | disallow using ` async ` /` await ` in Cypress test cases | ✅ |
129+ | [ no-force] ( docs/rules/no-force.md ) | disallow using ` force: true ` with action commands | |
130+ | [ no-pause] ( docs/rules/no-pause.md ) | disallow using ` cy.pause() ` calls | |
131+ | [ no-unnecessary-waiting] ( docs/rules/no-unnecessary-waiting.md ) | disallow waiting for arbitrary time periods | ✅ |
132+ | [ require-data-selectors] ( docs/rules/require-data-selectors.md ) | require ` data-* ` attribute selectors | |
133+ | [ unsafe-to-chain-command] ( docs/rules/unsafe-to-chain-command.md ) | disallow actions within chains | ✅ |
134+
135+ <!-- end auto-generated rules list -->
130136
131137## Mocha and Chai
132138
0 commit comments