eslint-plugin-cypress 6.4.3 → 7.0.0

package/CONTRIBUTING.md

@@ -29,7 +29,7 @@ To add a new rule:
   - 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 `eslint-doc-generator` to generate automated documentation sections (see [Document generation](#document-generation) below)
+- 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`
@@ -41,14 +41,17 @@ To add a new rule:
 
 ## Document generation
 
-This plugin uses the ESLint [eslint-doc-generator](https://www.npmjs.com/package/eslint-doc-generator) to generate consistent documentation.
+This plugin uses the [eslint-doc-generator](https://www.npmjs.com/package/eslint-doc-generator) package to generate consistent documentation.
 
-- Install with `npm install eslint-doc-generator@latest -g`
-- Run `eslint-doc-generator` in the root directory of the plugin
+- Run `npx eslint-doc-generator` in the root directory of the plugin
 
-Note that [eslint-doc-generator](https://www.npmjs.com/package/eslint-doc-generator) has some unresolved issues running under
-Microsoft Windows (see issue[#265](https://github.com/cypress-io/eslint-plugin-cypress/issues/265)).
-Do not attempt to run under Windows until these issues are resolved.
+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
 

package/README.md

@@ -6,7 +6,7 @@ Note: If you installed ESLint globally then you must also install `eslint-plugin
 
 ## Installation
 
-Prerequisites: [ESLint](https://www.npmjs.com/package/eslint) `v9` or `v10`. Lower versions are no longer supported.
+Prerequisites: [ESLint](https://www.npmjs.com/package/eslint) `v10`. Lower versions are no longer supported.
 
 ```sh
 npm install eslint eslint-plugin-cypress --save-dev
@@ -22,7 +22,6 @@ yarn add eslint eslint-plugin-cypress --dev
 
 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.
-This is the default in ESLint `v9`, and in ESLint `v10` it is the only config format available.
 
 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:
 
@@ -79,8 +78,6 @@ These rules enforce some of the [best practices recommended for using Cypress](h
 
 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.
 
-The examples use the `defineConfig()` helper, introduced with ESLint [9.22.0](https://eslint.org/blog/2025/03/eslint-v9.22.0-released/). Refer to the blog article [Evolving flat config with extends](https://eslint.org/blog/2025/03/flat-config-extends-define-config-global-ignores/) for background information. If you are using ESLint `<9.22.0`, import `defineConfig` from [@eslint/config-helpers](https://www.npmjs.com/package/@eslint/config-helpers) instead of from `eslint/config`.
-
 ### Cypress
 
 All rules are available by importing from `eslint-plugin-cypress` and can be individually activated.
@@ -114,9 +111,7 @@ import pluginCypress from 'eslint-plugin-cypress'
 export default defineConfig([
   {
     files: ['cypress/**/*.js'],
-    extends: [
-      pluginCypress.configs.recommended,
-    ],
+    extends: [pluginCypress.configs.recommended],
     rules: {
       'cypress/no-unnecessary-waiting': 'off',
     },
@@ -134,9 +129,7 @@ import pluginCypress from 'eslint-plugin-cypress'
 export default defineConfig([
   {
     files: ['cypress/**/*.js'],
-    extends: [
-      pluginCypress.configs.globals,
-    ],
+    extends: [pluginCypress.configs.globals],
   },
 ])
 ```
@@ -160,7 +153,7 @@ If you already have a TypeScript codebase, you can skip the next step. If not, y
     "allowJs": true,
     "checkJs": false,
     "noEmit": true
-  },
+  }
 }
 ```
 
@@ -177,7 +170,7 @@ export default defineConfig([
         projectService: true,
       },
     },
-  }
+  },
 ])
 ```
 
@@ -234,15 +227,19 @@ During test spec development, [Mocha exclusive tests](https://mochajs.org/#exclu
 
 ### Cypress and Mocha recommended
 
-[eslint-plugin-mocha@^11](https://www.npmjs.com/package/eslint-plugin-mocha) is added to the example [Cypress recommended](#cypress-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) is set to `off` instead of `error`
+- [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@^11 --save-dev
+npm install eslint-plugin-mocha --save-dev
 ```
 
 ```js
@@ -257,6 +254,7 @@ export default defineConfig([
       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',
@@ -275,7 +273,7 @@ Using an assertion such as `expect(value).to.be.true` can fail the ESLint rule `
 The recommended rules for both plugins are used: `pluginCypress.configs.recommended` and `pluginChaiFriendly.configs.recommendedFlat`:
 
 ```shell
-npm install eslint-plugin-chai-friendly@^1.0.1 --save-dev
+npm install eslint-plugin-chai-friendly --save-dev
 ```
 
 ```js

package/docs/rules/no-and.md

@@ -26,7 +26,10 @@ Examples of **correct** code for this rule:
 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')
+cy.get('foo')
+  .should('be.visible')
+  .and('have.text', 'bar')
+  .and('have.class', 'active')
 ```
 
 ## When Not To Use It

package/docs/rules/require-data-selectors.md

@@ -22,16 +22,16 @@ cy.get('[daedta-cy=submit]').click()
 cy.get('[d-cy=submit]')
 cy.get('.btn-large').click()
 cy.get('.btn-.large').click()
-cy.get(condition ? "[data-cy=submit]" : ".btn-large")
+cy.get(condition ? '[data-cy=submit]' : '.btn-large')
 
-const CLASS_SELECTOR = ".my-class"; 
+const CLASS_SELECTOR = '.my-class'
 cy.get(CLASS_SELECTOR)
 
 const TYPE = 'submit'
 const SUBMIT_TEMPLATE = `.${TYPE}`
 cy.get(SUBMIT_TEMPLATE)
 
-const MY_SUBMIT_TEMPLATE = SUBMIT_TEMPLATE;
+const MY_SUBMIT_TEMPLATE = SUBMIT_TEMPLATE
 cy.get(MY_SUBMIT_TEMPLATE)
 ```
 
@@ -41,16 +41,16 @@ Examples of **correct** code for this rule:
 cy.get('[data-cy=submit]').click()
 cy.get('[data-QA=submit]')
 cy.get(`[data-QA=submit]`)
-cy.get(condition ? "[data-cy=submit]" : "[data-QA=submit]")
+cy.get(condition ? '[data-cy=submit]' : '[data-QA=submit]')
 
-const ASSESSMENT_SUBMIT = "[data-cy=assessment-submit]"
+const ASSESSMENT_SUBMIT = '[data-cy=assessment-submit]'
 cy.get(ASSESSMENT_SUBMIT).click()
 
 const TYPE = 'submit'
 const SUBMIT_TEMPLATE = `[data-QA=${TYPE}]`
 cy.get(SUBMIT_TEMPLATE)
 
-const MY_SUBMIT_TEMPLATE = SUBMIT_TEMPLATE;
+const MY_SUBMIT_TEMPLATE = SUBMIT_TEMPLATE
 cy.get(MY_SUBMIT_TEMPLATE)
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-cypress",
-  "version": "6.4.3",
+  "version": "7.0.0",
   "description": "An ESLint plugin for projects using Cypress",
   "main": "./lib/index.js",
   "exports": {
@@ -29,7 +29,7 @@
   "homepage": "https://github.com/cypress-io/eslint-plugin-cypress#readme",
   "peerDependencies": {
     "@typescript-eslint/parser": ">=8",
-    "eslint": ">=9"
+    "eslint": ">=10"
   },
   "peerDependenciesMeta": {
     "@typescript-eslint/parser": {
@@ -37,20 +37,21 @@
     }
   },
   "dependencies": {
-    "globals": "^17.7.0"
+    "globals": "^17.9.0"
   },
   "devDependencies": {
     "@eslint/js": "^10.0.1",
     "@stylistic/eslint-plugin": "^5.10.0",
-    "@typescript-eslint/rule-tester": "^8.62.1",
-    "cypress": "^15.18.1",
-    "eslint": "^10.6.0",
-    "eslint-plugin-eslint-plugin": "^7.4.1",
-    "eslint-plugin-mocha": "^11.3.0",
+    "@typescript-eslint/rule-tester": "^8.66.0",
+    "cypress": "^15.20.0",
+    "eslint": "^10.8.0",
+    "eslint-doc-generator": "^3.7.0",
+    "eslint-plugin-eslint-plugin": "^7.6.1",
+    "eslint-plugin-mocha": "^12.0.2",
     "husky": "^9.1.7",
-    "prettier": "^3.9.4",
-    "typescript": "^5.9.3",
-    "typescript-eslint": "^8.62.1",
+    "prettier": "^3.9.6",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.66.0",
     "vitest": "^4.1.10"
   },
   "scripts": {
@@ -60,5 +61,8 @@
     "format:check": "prettier --check .",
     "test": "vitest run",
     "prepare": "husky"
+  },
+  "allowScripts": {
+    "cypress": true
   }
 }