cypress-io · jennifer-shehane · May 29, 2025 · May 27, 2025 · May 29, 2025
diff --git a/.node-version b/.node-version
@@ -1 +1 @@
-22.11.0
+22.16.0
diff --git a/.nvmrc b/.nvmrc
@@ -1 +1 @@
-22.11.0
+22.16.0
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -34,7 +34,7 @@ To add a new rule:
 * Run `npm run lint`
 * Run `npm test` to run [Jest](https://jestjs.io/) (or run `npm start` to run [Jest](https://jestjs.io/) in [watchAll](https://jestjs.io/docs/cli#--watchall) mode where it remains active and reruns when source changes are made)
 * Make sure all tests are passing
-* Add the rule to [legacy.js](https://github.com/cypress-io/eslint-plugin-cypress/blob/master/legacy.js) and to [flat.js](https://github.com/cypress-io/eslint-plugin-cypress/blob/master/lib/flat.js)
+* Add the rule to [flat.js](https://github.com/cypress-io/eslint-plugin-cypress/blob/master/lib/flat.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
 
@@ -44,11 +44,6 @@ This plugin uses the ESLint [eslint-doc-generator](https://www.npmjs.com/package
 * Install with `npm install eslint-doc-generator -g`
 * Run `eslint-doc-generator` in the root directory of the plugin
 
-## Legacy tests
-
-* The directory [tests-legacy](https://github.com/cypress-io/eslint-plugin-cypress/tree/master/tests-legacy) contains tests which are compatible with the legacy [ESLint v8 RuleTester](https://eslint.org/docs/v8.x/integrate/nodejs-api#ruletester) utility. It is not expected to add new rules to this set of tests.
-* The directory [tests](https://github.com/cypress-io/eslint-plugin-cypress/tree/master/tests) is for tests compatible with the current [ESLint RuleTester](https://eslint.org/docs/latest/integrate/nodejs-api#ruletester).
-
 ## Merging pull requests
 
 This information is for Cypress.io Members or Collaborators who merge pull requests:

diff --git a/ESLINTRC-CONFIG.md b/ESLINTRC-CONFIG.md
@@ -1,147 +1,7 @@
 # Cypress ESLint Plugin - Legacy Config
 
-This document supplements the [README](./README.md) document and describes how to use the Cypress ESLint Plugin (`eslint-plugin-cypress`) in a [deprecated ESLint legacy config environment](https://eslint.org/docs/latest/use/configure/configuration-files-deprecated). The use of flat configurations with this plugin is described in the [README](./README.md) document.
+This document previously described how to use the Cypress ESLint Plugin (`eslint-plugin-cypress`) with an [ESLint legacy config environment](https://eslint.org/docs/latest/use/configure/configuration-files-deprecated).
 
-Usage with ESLint `9.x` is described.
+This form of configuration was deprecated with the release of ESLint `v9` and its use with `eslint-plugin-cypress` is no longer supported.
 
-## Deprecations
-
-The use of `eslintrc` configurations with `eslint-plugin-cypress` is deprecated and support will be removed in a future version of this plugin. This is tied in to the ESLint announcement in the blog post [Flat config rollout plans](https://eslint.org/blog/2023/10/flat-config-rollout-plans/) from October 2023 which describes that the `eslintrc` configuration system is planned to be removed in the future ESLint `v10.0.0`. Users are encouraged to migrate to using a [flat configuration](https://eslint.org/docs/latest/use/configure/configuration-files).
-
-## Installation
-
-Use a minimum ESLint `9.x`.
-
-```shell
-npm install eslint eslint-plugin-cypress --save-dev
-```
-
-or
-
-```shell
-yarn add eslint eslint-plugin-cypress --dev
-```
-
-## Usage
-
-To use a deprecated configuration with ESLint `v9`, such as `.eslintrc.json`, you must set the `ESLINT_USE_FLAT_CONFIG` environment variable to `false` (see [ESLint v9 > Configuration Files (Deprecated)](https://eslint.org/docs/latest/use/configure/configuration-files-deprecated)). The following examples use `json` format for the content of the configuration file:
-
-```json
-{
-  "plugins": [
-    "cypress"
-  ]
-}
-```
-
-You can add rules - see [Rules](./README.md#rules) for a list of the available rules:
-
-```json
-{
-  "rules": {
-    "cypress/no-assigning-return-values": "error",
-    "cypress/no-unnecessary-waiting": "error",
-    "cypress/assertion-before-screenshot": "warn",
-    "cypress/no-force": "warn",
-    "cypress/no-async-tests": "error",
-    "cypress/no-async-before": "error",
-    "cypress/no-pause": "error",
-    "cypress/no-debug": "error"
-  }
-}
-```
-
-You can allow certain globals provided by Cypress:
-
-```json
-{
-  "env": {
-    "cypress/globals": true
-  }
-}
-```
-
-## Recommended configuration
-
-Use the recommended configuration and you can forego configuring _plugins_, _rules_, and _env_ individually. See [Rules](./README.md#rules) for which rules are included in the recommended configuration.
-
-```json
-{
-  "extends": [
-    "plugin:cypress/recommended"
-  ]
-}
-```
-
-## Rules
-
-See the [Rules](./README.md#rules) list in the main [README](./README.md) document.
-
-## 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@^10](https://www.npmjs.com/package/eslint-plugin-mocha). This is the highest plugin version that still supports legacy configurations. 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-skipped-tests](https://github.com/lo1tuma/eslint-plugin-mocha/blob/v10.5.0/docs/rules/no-skipped-tests.md) rule detects the use of `.skip`:
-
-```sh
-npm install --save-dev eslint-plugin-mocha@^10
-```
-
-In your `.eslintrc.json`:
-
-```json
-{
-  "plugins": [
-    "cypress",
-    "mocha"
-  ],
-  "rules": {
-    "mocha/no-exclusive-tests": "warn",
-    "mocha/no-skipped-tests": "warn"
-  }
-}
-```
-
-Or you can simply use the `cypress/recommended` and `mocha/recommended` configurations together, for example:
-
-```json
-{
-  "extends": [
-    "plugin:cypress/recommended",
-    "plugin:mocha/recommended"
-  ]
-}
-```
-
-## Chai and `no-unused-expressions`
-
-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).
-
-```sh
-npm install --save-dev eslint-plugin-chai-friendly
-```
-
-In your `.eslintrc.json`:
-
-```json
-{
-  "plugins": [
-    "cypress",
-    "chai-friendly"
-  ],
-  "rules": {
-    "no-unused-expressions": 0,
-    "chai-friendly/no-unused-expressions": 2
-  }
-}
-```
-
-Or you can simply add its `recommended` config:
-
-```json
-{
-  "extends": ["plugin:chai-friendly/recommended"]
-}
-```
+Users who were previously using a deprecated configuration environment should migrate to a [flat configuration](https://eslint.org/docs/latest/use/configure/configuration-files).
diff --git a/FLAT-CONFIG.md b/FLAT-CONFIG.md
@@ -1,5 +1,3 @@
 # Cypress ESLint Plugin - Flat Config
 
- Please refer to the [README](./README.md) document where the previous contents of this document, describing how to use `eslint-plugin-cypress` with an ESLint `v9` (default) [flat configuration](https://eslint.org/docs/latest/use/configure/configuration-files), can now be found.
-
-For instructions on using a deprecated [eslintrc-type](https://eslint.org/docs/latest/use/configure/configuration-files-deprecated) config file from previous ESLint `v8` versions and below, please refer to the [ESLINTRC-CONFIG](./ESLINTRC-CONFIG.md) document.
+ Please refer to the [README](./README.md) document which describes how to use `eslint-plugin-cypress` with an ESLint `v9` (default) [flat configuration](https://eslint.org/docs/latest/use/configure/configuration-files).
diff --git a/README.md b/README.md
@@ -18,21 +18,27 @@ yarn add eslint eslint-plugin-cypress --dev
 
 ## Usage
 
-ESLint `v9` uses a [Flat config file](https://eslint.org/docs/latest/use/configure/configuration-files) format with filename `eslint.config.*js` by default. For instructions on using a deprecated [eslintrc-type](https://eslint.org/docs/latest/use/configure/configuration-files-deprecated) config file from previous ESLint versions, please refer to the [ESLINTRC-CONFIG](./ESLINTRC-CONFIG.md) document.
+ESLint `v9` uses a [Flat config file](https://eslint.org/docs/latest/use/configure/configuration-files) format with filename `eslint.config.*js` by default. This plugin no longer supports the use of a deprecated [eslintrc-type](https://eslint.org/docs/latest/use/configure/configuration-files-deprecated) config file from previous ESLint versions.
 
-To set up a flat configuration, add a file `eslint.config.mjs` to the root directory of your Cypress project and include the following instructions to import the available flat configurations using:
+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/flat'
+import pluginCypress from 'eslint-plugin-cypress'
+```
+
+For backwards compatibility with previous plugin versions `3.3.0` - `4.3.0`, the following equivalent deprecated form is also supported. This is planned to be removed in a future major version:
+
+```shell
+import pluginCypress from 'eslint-plugin-cypress/flat' # deprecated
 ```
 
 ## Configurations
 
-There are two specific flat configurations available:
+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). This version no longer specifies `languageOptions` for `ecmaVersion` and `sourceType` - see ESLint [JavaScript languageOptions](https://eslint.org/docs/latest/use/configure/language-options#specifying-javascript-options). There are no default rules enabled in this configuration. |
+| `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
@@ -67,11 +73,11 @@ In the following sections, different examples of possible configuration file con
 
 ### Cypress
 
-All rules from `eslint-plugin-cypress` are available through `eslint-plugin-cypress/flat` and can be individually activated.
+All rules are available by importing from `eslint-plugin-cypress` and can be individually activated.
 - [cypress/unsafe-to-chain-command](https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/unsafe-to-chain-command.md) is activated and set to `error`
 
 ```js
-import pluginCypress from 'eslint-plugin-cypress/flat'
+import pluginCypress from 'eslint-plugin-cypress'
 export default [
   {
     plugins: {
@@ -90,7 +96,7 @@ The `eslint-plugin-cypress` [recommended rules](#rules) `configs.recommended` ar
 - [cypress/no-unnecessary-waiting](https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-unnecessary-waiting.md) which is set to `off`
 
 ```js
-import pluginCypress from 'eslint-plugin-cypress/flat'
+import pluginCypress from 'eslint-plugin-cypress'
 export default [
   pluginCypress.configs.recommended,
   {
@@ -106,7 +112,7 @@ export default [
 The `configs.globals` are activated.
 
 ```js
-import pluginCypress from 'eslint-plugin-cypress/flat'
+import pluginCypress from 'eslint-plugin-cypress'
 export default [
   pluginCypress.configs.globals
 ]
@@ -177,7 +183,7 @@ npm install eslint-plugin-mocha@^11 --save-dev
 
 ```js
 import pluginMocha from 'eslint-plugin-mocha'
-import pluginCypress from 'eslint-plugin-cypress/flat'
+import pluginCypress from 'eslint-plugin-cypress'
 export default [
   pluginMocha.configs.recommended,
   pluginCypress.configs.recommended,
@@ -205,7 +211,7 @@ npm install eslint-plugin-chai-friendly@^1.0.1 --save-dev
 ```
 
 ```js
-import pluginCypress from 'eslint-plugin-cypress/flat'
+import pluginCypress from 'eslint-plugin-cypress'
 import pluginChaiFriendly from 'eslint-plugin-chai-friendly'
 export default [
   pluginCypress.configs.recommended,

diff --git a/circle.yml b/circle.yml
@@ -3,14 +3,13 @@ version: 2.1
 executors:
   docker-executor:
     docker:
-      - image: cimg/node:22.14.0
+      - image: cimg/node:22.16.0
     resource_class: medium
 
 workflows:
   main:
     jobs:
       - lint
-      - test-v8
       - test-v9
 
       - build-test-project
@@ -21,6 +20,7 @@ workflows:
               config-file: [
                   # configurations correspond to examples in README
                   'default',
+                  'default-deprecated', # using deprecated /flat
                   'recommended',
                   'globals',
                 ]
@@ -29,7 +29,6 @@ workflows:
       - release:
           requires:
             - lint
-            - test-v8
             - test-v9
             - test-test-project
           filters:
@@ -52,23 +51,6 @@ jobs:
           name: Lint code
           command: npm run lint
 
-  test-v8:
-    executor: docker-executor
-    steps:
-      - checkout
-      - run:
-          name: Install dependencies
-          command: npm ci
-      - run:
-          name: Install ESLint 8
-          command: npm install eslint@8
-      - run:
-          name: Show ESLint version
-          command: npx eslint --version
-      - run:
-          name: Test ESLint 8
-          command: npm run test:legacy
-
   test-v9:
     executor: docker-executor
     steps:

diff --git a/jest.config-legacy.js b/jest.config-legacy.js
diff --git a/legacy.js b/legacy.js
diff --git a/lib/flat.js b/lib/flat.js
@@ -5,18 +5,18 @@ const plugin = {
   meta: { name, version },
   configs: {},
   rules: {
+    'assertion-before-screenshot': require('./rules/assertion-before-screenshot'),
     'no-assigning-return-values': require('./rules/no-assigning-return-values'),
-    'unsafe-to-chain-command': require('./rules/unsafe-to-chain-command'),
-    'no-unnecessary-waiting': require('./rules/no-unnecessary-waiting'),
     'no-async-before': require('./rules/no-async-before'),
     'no-async-tests': require('./rules/no-async-tests'),
-    'assertion-before-screenshot': require('./rules/assertion-before-screenshot'),
-    'require-data-selectors': require('./rules/require-data-selectors'),
+    'no-chained-get': require('./rules/no-chained-get'),
+    'no-debug': require('./rules/no-debug'),
     'no-force': require('./rules/no-force'),
     'no-pause': require('./rules/no-pause'),
-    'no-debug': require('./rules/no-debug'),
+    'no-unnecessary-waiting': require('./rules/no-unnecessary-waiting'),
     'no-xpath': require('./rules/no-xpath'),
-    'no-chained-get': require('./rules/no-chained-get'),
+    'require-data-selectors': require('./rules/require-data-selectors'),
+    'unsafe-to-chain-command': require('./rules/unsafe-to-chain-command'),
   },
 }