You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
BREAKING CHANGE: Drop legacy configuration support
Support for non-flat legacy configurations is removed
eslint-plugin-cypress/flat is deprecated and replaced by
eslint-plugin-cypress
globals is updated to 16.2.0
semantic-release is update to 24.2.5
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+1-6Lines changed: 1 addition & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,7 +34,7 @@ To add a new rule:
34
34
* Run `npm run lint`
35
35
* 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)
36
36
* Make sure all tests are passing
37
-
* 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)
37
+
* Add the rule to [flat.js](https://github.com/cypress-io/eslint-plugin-cypress/blob/master/lib/flat.js)
38
38
* 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))
39
39
* Create a PR from your branch
40
40
@@ -44,11 +44,6 @@ This plugin uses the ESLint [eslint-doc-generator](https://www.npmjs.com/package
44
44
* Install with `npm install eslint-doc-generator -g`
45
45
* Run `eslint-doc-generator` in the root directory of the plugin
46
46
47
-
## Legacy tests
48
-
49
-
* 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.
50
-
* 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).
51
-
52
47
## Merging pull requests
53
48
54
49
This information is for Cypress.io Members or Collaborators who merge pull requests:
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.
3
+
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).
4
4
5
-
Usage with ESLint `9.x`is described.
5
+
This form of configuration was deprecated with the release of ESLint `v9` and its use with `eslint-plugin-cypress`is no longer supported.
6
6
7
-
## Deprecations
8
-
9
-
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).
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:
28
-
29
-
```json
30
-
{
31
-
"plugins": [
32
-
"cypress"
33
-
]
34
-
}
35
-
```
36
-
37
-
You can add rules - see [Rules](./README.md#rules) for a list of the available rules:
38
-
39
-
```json
40
-
{
41
-
"rules": {
42
-
"cypress/no-assigning-return-values": "error",
43
-
"cypress/no-unnecessary-waiting": "error",
44
-
"cypress/assertion-before-screenshot": "warn",
45
-
"cypress/no-force": "warn",
46
-
"cypress/no-async-tests": "error",
47
-
"cypress/no-async-before": "error",
48
-
"cypress/no-pause": "error",
49
-
"cypress/no-debug": "error"
50
-
}
51
-
}
52
-
```
53
-
54
-
You can allow certain globals provided by Cypress:
55
-
56
-
```json
57
-
{
58
-
"env": {
59
-
"cypress/globals": true
60
-
}
61
-
}
62
-
```
63
-
64
-
## Recommended configuration
65
-
66
-
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.
67
-
68
-
```json
69
-
{
70
-
"extends": [
71
-
"plugin:cypress/recommended"
72
-
]
73
-
}
74
-
```
75
-
76
-
## Rules
77
-
78
-
See the [Rules](./README.md#rules) list in the main [README](./README.md) document.
79
-
80
-
## Mocha and Chai
81
-
82
-
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`.
83
-
84
-
## Mocha `.only` and `.skip`
85
-
86
-
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`:
87
-
88
-
```sh
89
-
npm install --save-dev eslint-plugin-mocha@^10
90
-
```
91
-
92
-
In your `.eslintrc.json`:
93
-
94
-
```json
95
-
{
96
-
"plugins": [
97
-
"cypress",
98
-
"mocha"
99
-
],
100
-
"rules": {
101
-
"mocha/no-exclusive-tests": "warn",
102
-
"mocha/no-skipped-tests": "warn"
103
-
}
104
-
}
105
-
```
106
-
107
-
Or you can simply use the `cypress/recommended` and `mocha/recommended` configurations together, for example:
108
-
109
-
```json
110
-
{
111
-
"extends": [
112
-
"plugin:cypress/recommended",
113
-
"plugin:mocha/recommended"
114
-
]
115
-
}
116
-
```
117
-
118
-
## Chai and `no-unused-expressions`
119
-
120
-
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).
Users who were previously using a deprecated configuration environment should migrate to a [flat configuration](https://eslint.org/docs/latest/use/configure/configuration-files).
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.
4
-
5
-
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.
3
+
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).
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.
21
+
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.
22
22
23
-
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:
23
+
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:
24
24
25
25
```shell
26
-
import pluginCypress from 'eslint-plugin-cypress/flat'
26
+
import pluginCypress from 'eslint-plugin-cypress'
27
+
```
28
+
29
+
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:
30
+
31
+
```shell
32
+
import pluginCypress from 'eslint-plugin-cypress/flat'# deprecated
27
33
```
28
34
29
35
## Configurations
30
36
31
-
There are two specific flat configurations available:
|`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. |
41
+
|`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. |
36
42
|`configs.recommended`| enables [recommended Rules](#rules). It includes also `configs.global` (see above). |
37
43
38
44
## Rules
@@ -67,11 +73,11 @@ In the following sections, different examples of possible configuration file con
67
73
68
74
### Cypress
69
75
70
-
All rules from `eslint-plugin-cypress` are available through `eslint-plugin-cypress/flat` and can be individually activated.
76
+
All rules from `eslint-plugin-cypress` are available through `eslint-plugin-cypress` and can be individually activated.
71
77
-[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`
@@ -90,7 +96,7 @@ The `eslint-plugin-cypress` [recommended rules](#rules) `configs.recommended` ar
90
96
-[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`
0 commit comments