eslint-plugin-cypress 0.0.0-dev.1109

package/CONTRIBUTING.md

@@ -0,0 +1,80 @@
+# Contributing to cypress-io/eslint-plugin-cypress
+
+Thanks for taking the time to contribute! :smile:
+
+## Preparation
+
+- Fork and clone this repository
+- Branch from the default `master` branch using a descriptive new branch name
+- Install dependencies with `npm ci`
+
+## Rule references
+
+- Refer to the [ESLint documentation](https://eslint.org/docs/latest/) and the [Custom Rules](https://eslint.org/docs/latest/extend/custom-rules) page
+
+## New rule
+
+To add a new rule:
+
+- Follow the instructions in the ESLint [generator-eslint](https://www.npmjs.com/package/generator-eslint) documentation to install [Yeoman](https://www.npmjs.com/package/yo) and the generator
+- Run the new rule generator `yo eslint:rule` and answer the questions
+  - select "ESLint Plugin"
+  - for "Type a short description of this rule" provide text which starts with one of "enforce", "require" or "disallow" (all lower case)
+- Yeoman creates three boilerplate files:
+  - `docs/rules/<rule-id>.md`
+  - `lib/rules/<rule-id>.js`
+  - `test/rules/<rule-id>.js`
+- Run `npm run lint-fix`
+- Address the linting errors by editing `lib/rules/<rule-id>.js`
+  - Add a `meta.messages` property (see [MessageIds](https://eslint.org/docs/latest/extend/custom-rules#messageids))
+  - Select the appropriate `meta.type` property using `problem`, `suggestion`, or `layout`
+- Complete the new rule by adding content to the three files previously created
+- Run `npx eslint-doc-generator` to generate automated documentation sections (see [Document generation](#document-generation) below)
+- Review documentation changes
+- Run `npm run lint`
+- Run `npm run format`
+- Run `npm test` to run [Vitest](https://vitest.dev/)
+- Make sure all tests are passing
+- Add the rule to [index.js](./lib/index.js)
+- Create a git commit with a commit message similar to: `feat: add rule <description>` (see [commit message conventions](https://github.com/semantic-release/semantic-release#commit-message-format))
+- Create a PR from your branch
+
+## Document generation
+
+This plugin uses the [eslint-doc-generator](https://www.npmjs.com/package/eslint-doc-generator) package to generate consistent documentation.
+
+- Run `npx eslint-doc-generator` in the root directory of the plugin
+
+Previous compatibility issues with Windows are resolved, and
+[eslint-doc-generator](https://www.npmjs.com/package/eslint-doc-generator)
+is now installed together with other dependencies through `npm ci`.
+If you previously had [eslint-doc-generator](https://www.npmjs.com/package/eslint-doc-generator) installed globally,
+to work with this repo, you can now uninstall it:
+
+- Run `npm uninstall eslint-doc-generator -g` (only if previously installed)
+
+## Merging pull requests
+
+This information is for Cypress.io Members or Collaborators who merge pull requests:
+
+1. When merging a pull request, use the [Squash and merge](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/about-merge-methods-on-github#squashing-your-merge-commits) option to squash all commits into one.
+1. Make sure the commit subject and body follow [semantic commit convention](https://semantic-release.gitbook.io/semantic-release/#commit-message-format), for instance:
+
+   ```text
+   feat: added new parameter
+   fix: fixed a bug
+   ```
+
+   If you need to bump the major version, mark it as breaking change in the body of the commit's message like:
+
+   ```text
+   fix: upgrade dependency X
+
+   BREAKING CHANGE: requires minimum Node.js 20 to run
+   ```
+
+1. New versions of this module will be released automatically by the CI pipeline when any PR with a triggering commit message is merged to the `master` branch: see the `release` job of [circle.yml](circle.yml).
+   This will create a new [GitHub release](https://github.com/cypress-io/eslint-plugin-cypress/releases) and publish it to [eslint-plugin-cypress](https://www.npmjs.com/package/eslint-plugin-cypress) on the [npm registry](https://docs.npmjs.com/about-the-public-npm-registry).
+1. The module's CI is configured to use the [default Angular release rules](https://github.com/semantic-release/commit-analyzer/blob/master/lib/default-release-rules.js).
+   This means that only `feat:`, `fix:` and `perf:` trigger a new release.
+   Other Angular commit types listed in the [Angular commit message guidelines](https://github.com/angular/angular/blob/main/contributing-docs/commit-message-guidelines.md) can be used for documentation purposes, however they are ignored by the currently configured release process.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Cypress.io
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,299 @@
+# Cypress ESLint Plugin [![CircleCI](https://circleci.com/gh/cypress-io/eslint-plugin-cypress/tree/master.svg?style=svg)](https://circleci.com/gh/cypress-io/eslint-plugin-cypress/tree/master)
+
+An [ESLint](https://eslint.org) plugin for your [Cypress](https://cypress.io) tests.
+
+Note: If you installed ESLint globally then you must also install `eslint-plugin-cypress` globally.
+
+## Installation
+
+Prerequisites: [ESLint](https://www.npmjs.com/package/eslint) `v10`. Lower versions are no longer supported.
+
+```sh
+npm install eslint eslint-plugin-cypress --save-dev
+```
+
+or
+
+```sh
+yarn add eslint eslint-plugin-cypress --dev
+```
+
+## Usage
+
+ESLint as of `v10` and this plugin no longer support the use of the deprecated [eslintrc-type](https://eslint.org/docs/v9.x/use/configure/configuration-files-deprecated) config file format.
+You must use a [Flat config file](https://eslint.org/docs/latest/use/configure/configuration-files) format.
+
+To set up a configuration, add a file `eslint.config.mjs` to the root directory of your Cypress project and include the following instructions to import the available configurations using:
+
+```shell
+import pluginCypress from 'eslint-plugin-cypress'
+```
+
+The configuration `eslint-plugin-cypress/flat`, which was deprecated in plugin version `5.0.0`, is no longer available.
+Migrate to using the equivalent configuration `eslint-plugin-cypress` by dropping the `/flat` suffix.
+
+Refer to ESLint `v10` [Configuration File Resolution](https://eslint.org/docs/latest/use/configure/configuration-files#configuration-file-resolution) for hierarchical use of configuration files.
+
+## Configurations
+
+There are two specific configurations available:
+
+| Configuration         | Content                                                                                                                                                                                                                                                     |
+| --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `configs.globals`     | defines globals `cy`, `Cypress`, `expect`, `assert` and `chai` used in Cypress test specs as well as `globals.browser` and `globals.mocha` from [globals](https://www.npmjs.com/package/globals). There are no default rules enabled in this configuration. |
+| `configs.recommended` | enables [recommended Rules](#rules). It includes also `configs.global` (see above).                                                                                                                                                                         |
+
+## Rules
+
+These rules enforce some of the [best practices recommended for using Cypress](https://on.cypress.io/best-practices).
+
+<!-- prettier-ignore-start -->
+<!-- begin auto-generated rules list -->
+
+💼 Configurations enabled in.\
+✅ Set in the `recommended` configuration.\
+🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).\
+❌ Deprecated.
+
+| Name                                                                     | Description                                                     | 💼 | 🔧 | ❌  |
+| :----------------------------------------------------------------------- | :-------------------------------------------------------------- | :- | :- | :- |
+| [assertion-before-screenshot](docs/rules/assertion-before-screenshot.md) | require screenshots to be preceded by an assertion              |    |    |    |
+| [no-and](docs/rules/no-and.md)                                           | enforce `.should()` over `.and()` for starting assertion chains |    | 🔧 |    |
+| [no-assigning-return-values](docs/rules/no-assigning-return-values.md)   | disallow assigning return values of `cy` calls                  | ✅  |    |    |
+| [no-async-before](docs/rules/no-async-before.md)                         | disallow using `async`/`await` in Cypress `before` methods      |    |    |    |
+| [no-async-tests](docs/rules/no-async-tests.md)                           | disallow using `async`/`await` in Cypress test cases            | ✅  |    |    |
+| [no-chained-get](docs/rules/no-chained-get.md)                           | disallow chain of `cy.get()` calls                              |    |    |    |
+| [no-debug](docs/rules/no-debug.md)                                       | disallow using `cy.debug()` calls                               |    |    |    |
+| [no-force](docs/rules/no-force.md)                                       | disallow using `force: true` with action commands               |    |    |    |
+| [no-pause](docs/rules/no-pause.md)                                       | disallow using `cy.pause()` calls                               |    |    |    |
+| [no-unnecessary-waiting](docs/rules/no-unnecessary-waiting.md)           | disallow waiting for arbitrary time periods                     | ✅  |    |    |
+| [no-xpath](docs/rules/no-xpath.md)                                       | disallow using `cy.xpath()` calls                               |    |    | ❌  |
+| [require-data-selectors](docs/rules/require-data-selectors.md)           | require `data-*` attribute selectors                            |    |    |    |
+| [unsafe-to-chain-command](docs/rules/unsafe-to-chain-command.md)         | disallow actions within chains                                  | ✅  |    |    |
+
+<!-- end auto-generated rules list -->
+<!-- prettier-ignore-end -->
+
+## Usage examples
+
+In the following sections, different examples of possible configuration file contents are given, together with some brief explanations. Adapt these examples according to your needs.
+
+### Cypress
+
+All rules are available by importing from `eslint-plugin-cypress` and can be individually activated.
+
+- [cypress/unsafe-to-chain-command](./docs/rules/unsafe-to-chain-command.md) is activated and set to `error`
+
+```js
+import { defineConfig } from 'eslint/config'
+import pluginCypress from 'eslint-plugin-cypress'
+export default defineConfig([
+  {
+    plugins: {
+      cypress: pluginCypress,
+    },
+    rules: {
+      'cypress/unsafe-to-chain-command': 'error',
+    },
+  },
+])
+```
+
+### Cypress recommended
+
+The `eslint-plugin-cypress` [recommended rules](#rules) `configs.recommended` are activated, except for
+
+- [cypress/no-unnecessary-waiting](./docs/rules/no-unnecessary-waiting.md) which is set to `off`
+
+```js
+import { defineConfig } from 'eslint/config'
+import pluginCypress from 'eslint-plugin-cypress'
+export default defineConfig([
+  {
+    files: ['cypress/**/*.js'],
+    extends: [pluginCypress.configs.recommended],
+    rules: {
+      'cypress/no-unnecessary-waiting': 'off',
+    },
+  },
+])
+```
+
+### Cypress globals
+
+The `configs.globals` are activated.
+
+```js
+import { defineConfig } from 'eslint/config'
+import pluginCypress from 'eslint-plugin-cypress'
+export default defineConfig([
+  {
+    files: ['cypress/**/*.js'],
+    extends: [pluginCypress.configs.globals],
+  },
+])
+```
+
+### Typed Linting
+
+You can activate typed linting for increased accuracy, if you want. This is purely optional and all rules continue to work without it. It uses a TypeScript parser to parse your entire project, instead of only the file being linted, which gives the plugin more information to work with. Be aware of the [performance penalty](https://typescript-eslint.io/getting-started/typed-linting/#performance) that this brings with it.
+
+First, install the `@typescript-eslint/parser` npm package:
+
+```sh
+npm install @typescript-eslint/parser --save-dev
+```
+
+If you already have a TypeScript codebase, you can skip the next step. If not, you need a `tsconfig.json`. The following minimal `tsconfig.json` does not compile or check your code and includes all .js files.
+
+```json
+{
+  "include": ["**/*.js"],
+  "compilerOptions": {
+    "allowJs": true,
+    "checkJs": false,
+    "noEmit": true
+  }
+}
+```
+
+The last step is to extend your eslint config to use the `typescript-eslint` parser.
+
+```js
+import { defineConfig } from 'eslint/config'
+import typescriptParser from '@typescript-eslint/parser'
+export default defineConfig([
+  {
+    languageOptions: {
+      parser: typescriptParser,
+      parserOptions: {
+        projectService: true,
+      },
+    },
+  },
+])
+```
+
+## Disable rules
+
+You can disable specific rules per file, for a portion of a file, or for a single line. See the [ESLint rules](https://eslint.org/docs/latest/use/configure/rules#disable-rules) documentation. For example ...
+
+Disable the `cypress/no-unnecessary-waiting` rule for the entire file by placing this at the start of the file:
+
+```js
+/* eslint-disable cypress/no-unnecessary-waiting */
+```
+
+Disable the `cypress/no-unnecessary-waiting` rule for only a portion of the file:
+
+```js
+it('waits for a second', () => {
+  ...
+  /* eslint-disable cypress/no-unnecessary-waiting */
+  cy.wait(1000)
+  /* eslint-enable cypress/no-unnecessary-waiting */
+  ...
+})
+```
+
+Disable the `cypress/no-unnecessary-waiting` rule for a specific line:
+
+```js
+it('waits for a second', () => {
+  ...
+  cy.wait(1000) // eslint-disable-line cypress/no-unnecessary-waiting
+  ...
+})
+```
+
+You can also disable a rule for the next line:
+
+```js
+it('waits for a second', () => {
+  ...
+  // eslint-disable-next-line cypress/no-unnecessary-waiting
+  cy.wait(1000)
+  ...
+})
+```
+
+## Mocha and Chai
+
+Cypress is built on top of [Mocha](https://on.cypress.io/app/references/bundled-libraries#Mocha) and [Chai](https://on.cypress.io/app/references/bundled-libraries#Chai). See the following sections for information on using ESLint plugins [eslint-plugin-mocha](https://www.npmjs.com/package/eslint-plugin-mocha) and [eslint-plugin-chai-friendly](https://www.npmjs.com/package/eslint-plugin-chai-friendly) together with `eslint-plugin-cypress`.
+
+## Mocha `.only` and `.skip`
+
+During test spec development, [Mocha exclusive tests](https://mochajs.org/#exclusive-tests) `.only` or [Mocha inclusive tests](https://mochajs.org/#inclusive-tests) `.skip` may be used to control which tests are executed, as described in the Cypress documentation [Excluding and Including Tests](https://on.cypress.io/app/core-concepts/writing-and-organizing-tests#Excluding-and-Including-Tests). To apply corresponding rules, you can install and use [eslint-plugin-mocha@^11](https://www.npmjs.com/package/eslint-plugin-mocha) plugin version or above. The rule [mocha/no-exclusive-tests](https://github.com/lo1tuma/eslint-plugin-mocha/blob/main/docs/rules/no-exclusive-tests.md) detects the use of `.only` and the [mocha/no-pending-tests](https://github.com/lo1tuma/eslint-plugin-mocha/blob/main/docs/rules/no-pending-tests.md) rule detects the use of `.skip`.
+
+### Cypress and Mocha recommended
+
+[eslint-plugin-mocha](https://www.npmjs.com/package/eslint-plugin-mocha) is added to the example [Cypress recommended](#cypress-recommended).
+
+The settings for individual `mocha` rules from the `configs.recommended` option are changed.
+
+- [mocha/no-exclusive-tests](https://github.com/lo1tuma/eslint-plugin-mocha/blob/main/docs/rules/no-exclusive-tests.md)
+  and [mocha/no-pending-tests](https://github.com/lo1tuma/eslint-plugin-mocha/blob/main/docs/rules/no-pending-tests.md)
+  are set to `error` instead of `warn`
+- [mocha/no-mocha-arrows](https://github.com/lo1tuma/eslint-plugin-mocha/blob/main/docs/rules/no-mocha-arrows.md)
+  and [mocha/no-async-in-sync-tests](https://github.com/lo1tuma/eslint-plugin-mocha/blob/main/documentation/rules/no-async-in-sync-tests.md)
+  are set to `off` instead of `error`
+
+```shell
+npm install eslint-plugin-mocha --save-dev
+```
+
+```js
+import { defineConfig } from 'eslint/config'
+import pluginMocha from 'eslint-plugin-mocha'
+import pluginCypress from 'eslint-plugin-cypress'
+export default defineConfig([
+  {
+    files: ['cypress/**/*.js'],
+    extends: [
+      pluginMocha.configs.recommended,
+      pluginCypress.configs.recommended,
+    ],
+    rules: {
+      'mocha/no-async-in-sync-tests': 'off', // for Cypress compatibility
+      'mocha/no-exclusive-tests': 'error',
+      'mocha/no-pending-tests': 'error',
+      'mocha/no-mocha-arrows': 'off',
+      'cypress/no-unnecessary-waiting': 'off',
+    },
+  },
+])
+```
+
+### Cypress and Chai recommended
+
+Using an assertion such as `expect(value).to.be.true` can fail the ESLint rule `no-unused-expressions` even though it's not an error in this case. To fix this, you can install and use [eslint-plugin-chai-friendly](https://www.npmjs.com/package/eslint-plugin-chai-friendly).
+
+[eslint-plugin-chai-friendly](https://www.npmjs.com/package/eslint-plugin-chai-friendly) is combined with the Cypress plugin `eslint-plugin-cypress`.
+
+The recommended rules for both plugins are used: `pluginCypress.configs.recommended` and `pluginChaiFriendly.configs.recommendedFlat`:
+
+```shell
+npm install eslint-plugin-chai-friendly --save-dev
+```
+
+```js
+import { defineConfig } from 'eslint/config'
+import pluginCypress from 'eslint-plugin-cypress'
+import pluginChaiFriendly from 'eslint-plugin-chai-friendly'
+export default defineConfig([
+  {
+    files: ['cypress/**/*.js'],
+    extends: [
+      pluginCypress.configs.recommended,
+      pluginChaiFriendly.configs.recommendedFlat,
+    ],
+    rules: {
+      'cypress/no-unnecessary-waiting': 'off',
+    },
+  },
+])
+```
+
+## Contributing
+
+Please see our [Contributing Guideline](./CONTRIBUTING.md) which explains how to contribute rules or other fixes and features to the repo.

package/docs/rules/assertion-before-screenshot.md

@@ -0,0 +1,28 @@
+# cypress/assertion-before-screenshot
+
+📝 Require screenshots to be preceded by an assertion.
+
+<!-- end auto-generated rule header -->
+
+If you take screenshots without assertions then you may get different screenshots depending on timing.
+
+For example, if clicking a button makes some network calls and upon success, renders something, then the screenshot may sometimes have the new render and sometimes not.
+
+## Rule Details
+
+This rule checks there is an assertion making sure your application state is correct before doing a screenshot. This makes sure the result of the screenshot will be consistent.
+
+Examples of **incorrect** code for this rule:
+
+```js
+cy.visit('myUrl')
+cy.screenshot()
+```
+
+Examples of **correct** code for this rule:
+
+```js
+cy.visit('myUrl')
+cy.get('[data-test-id="my-element"]').should('be.visible')
+cy.screenshot()
+```

package/docs/rules/no-and.md

@@ -0,0 +1,37 @@
+# cypress/no-and
+
+📝 Enforce `.should()` over `.and()` for starting assertion chains.
+
+🔧 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 -->
+
+Cypress's [.and()](https://on.cypress.io/and) is an alias for [.should()](https://on.cypress.io/should). Using `.and()` reads naturally when it follows `.should()` or `.contains()` — it continues an assertion chain like "should be empty **and** be hidden." In other positions, `.should()` is clearer.
+
+## Rule Details
+
+This rule allows `.and()` only when it immediately follows `.should()`, `.and()`, or `.contains()`. In all other positions, it flags `.and()` and auto-fixes it to `.should()`.
+
+Examples of **incorrect** code for this rule:
+
+```js
+cy.get('elem').and('have.text', 'blah')
+cy.get('foo').find('.bar').and('have.class', 'active')
+cy.get('foo').click().and('be.disabled')
+```
+
+Examples of **correct** code for this rule:
+
+```js
+cy.get('elem').should('have.text', 'blah')
+cy.get('.err').should('be.empty').and('be.hidden')
+cy.contains('Login').and('be.visible')
+cy.get('foo')
+  .should('be.visible')
+  .and('have.text', 'bar')
+  .and('have.class', 'active')
+```
+
+## When Not To Use It
+
+If you prefer using `.and()` interchangeably with `.should()` in all positions, turn this rule off.

package/docs/rules/no-assigning-return-values.md

@@ -0,0 +1,11 @@
+# cypress/no-assigning-return-values
+
+📝 Disallow assigning return values of `cy` calls.
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+<!-- end auto-generated rule header -->
+
+## Further Reading
+
+See [the Cypress Best Practices guide](https://on.cypress.io/best-practices#Assigning-Return-Values).

package/docs/rules/no-async-before.md

@@ -0,0 +1,52 @@
+# cypress/no-async-before
+
+📝 Disallow using `async`/`await` in Cypress `before` methods.
+
+<!-- end auto-generated rule header -->
+
+Cypress commands that return a promise may cause side effects in `before`/`beforeEach` hooks, possibly causing unexpected behavior.
+
+## Rule Details
+
+This rule disallows using `async` `before` and `beforeEach` functions.
+
+Examples of **incorrect** code for this rule:
+
+```js
+describe('my feature', () => {
+  before('my test case', async () => {
+    await cy.get('.myClass')
+    // other operations
+  })
+})
+```
+
+```js
+describe('my feature', () => {
+  before('my test case', async () => {
+    cy.get('.myClass').click()
+
+    await someAsyncFunction()
+  })
+})
+```
+
+Examples of **correct** code for this rule:
+
+```js
+describe('my feature', () => {
+  before('my test case', () => {
+    cy.get('.myClass')
+    // other operations
+  })
+})
+```
+
+## When Not To Use It
+
+If there are genuine use-cases for using `async/await` in your `before` hooks then you may not want to include this rule (or at least demote it to a warning).
+
+## Further Reading
+
+- [Mixing Async and Sync code](https://on.cypress.io/app/core-concepts/introduction-to-cypress#Mixing-Async-and-Sync-code)
+- [Commands Are Asynchronous](https://on.cypress.io/app/core-concepts/introduction-to-cypress.html#Commands-Are-Asynchronous)

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

@@ -0,0 +1,55 @@
+# cypress/no-async-tests
+
+📝 Disallow using `async`/`await` in Cypress test cases.
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+<!-- end auto-generated rule header -->
+
+Cypress tests [that return a promise will error](https://docs.cypress.io/app/references/error-messages.html#Cypress-detected-that-you-returned-a-promise-from-a-command-while-also-invoking-one-or-more-cy-commands-in-that-promise) and cannot run successfully.
+An `async` function returns a promise under the hood, so a test using an `async` function will also error.
+
+## Rule Details
+
+This rule disallows using `async` test functions.
+
+Examples of **incorrect** code for this rule:
+
+```js
+describe('my feature', () => {
+  it('my test case', async () => {
+    await cy.get('.myClass')
+    // other operations
+  })
+})
+```
+
+```js
+describe('my feature', () => {
+  it('my test case', async () => {
+    cy.get('.myClass').click()
+
+    await someAsyncFunction()
+  })
+})
+```
+
+Examples of **correct** code for this rule:
+
+```js
+describe('my feature', () => {
+  it('my test case', () => {
+    cy.get('.myClass')
+    // other operations
+  })
+})
+```
+
+## When Not To Use It
+
+If there are genuine use-cases for using `async/await` in your test cases then you may not want to include this rule (or at least demote it to a warning).
+
+## Further Reading
+
+- [Mixing Async and Sync code](https://on.cypress.io/app/core-concepts/introduction-to-cypress#Mixing-Async-and-Sync-code)
+- [Commands Are Asynchronous](https://on.cypress.io/app/core-concepts/introduction-to-cypress.html#Commands-Are-Asynchronous)

package/docs/rules/no-chained-get.md

@@ -0,0 +1,21 @@
+# cypress/no-chained-get
+
+📝 Disallow chain of `cy.get()` calls.
+
+<!-- end auto-generated rule header -->
+
+This rule disallows the usage of chained `.get()` calls as `cy.get()` always starts its search from the cy.root element.
+
+## Rule Details
+
+Examples of **incorrect** code for this rule:
+
+```js
+cy.get('parent').get('child')
+```
+
+Examples of **correct** code for this rule:
+
+```js
+cy.get('parent').find('child')
+```

package/docs/rules/no-debug.md

@@ -0,0 +1,22 @@
+# cypress/no-debug
+
+📝 Disallow using `cy.debug()` calls.
+
+<!-- end auto-generated rule header -->
+
+It is recommended to remove any [cy.debug](https://on.cypress.io/debug) commands before committing specs to avoid other developers getting unexpected results.
+
+## Rule Details
+
+Examples of **incorrect** code for this rule:
+
+```js
+cy.debug()
+cy.get('selector').debug()
+```
+
+Examples of **correct** code for this rule:
+
+```js
+cy.get('selector')
+```