eslint-plugin-cypress 5.2.0 → 5.3.0

package/CONTRIBUTING.md

@@ -43,9 +43,13 @@ To add a new rule:
 
 This plugin uses the ESLint [eslint-doc-generator](https://www.npmjs.com/package/eslint-doc-generator) to generate consistent documentation.
 
-- Install with `npm install eslint-doc-generator -g`
+- Install with `npm install eslint-doc-generator@latest -g`
 - Run `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.
+
 ## Merging pull requests
 
 This information is for Cypress.io Members or Collaborators who merge 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`. Lower versions are no longer supported.
+Prerequisites: [ESLint](https://www.npmjs.com/package/eslint) `v9` or `v10`. Lower versions are no longer supported.
 
 ```sh
 npm install eslint eslint-plugin-cypress --save-dev
@@ -20,7 +20,7 @@ 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. 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.
+ESLint `v9` and `v10` use 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 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:
 

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

@@ -1,4 +1,6 @@
-# Require screenshots to be preceded by an assertion (`cypress/assertion-before-screenshot`)
+# cypress/assertion-before-screenshot
+
+📝 Require screenshots to be preceded by an assertion.
 
 <!-- end auto-generated rule header -->
 

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

@@ -1,4 +1,6 @@
-# Disallow assigning return values of `cy` calls (`cypress/no-assigning-return-values`)
+# cypress/no-assigning-return-values
+
+📝 Disallow assigning return values of `cy` calls.
 
 💼 This rule is enabled in the ✅ `recommended` config.
 

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

@@ -1,4 +1,6 @@
-# Disallow using `async`/`await` in Cypress `before` methods (`cypress/no-async-before`)
+# cypress/no-async-before
+
+📝 Disallow using `async`/`await` in Cypress `before` methods.
 
 <!-- end auto-generated rule header -->
 

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

@@ -1,4 +1,6 @@
-# Disallow using `async`/`await` in Cypress test cases (`cypress/no-async-tests`)
+# cypress/no-async-tests
+
+📝 Disallow using `async`/`await` in Cypress test cases.
 
 💼 This rule is enabled in the ✅ `recommended` config.
 

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

@@ -1,4 +1,6 @@
-# Disallow chain of `cy.get()` calls (`cypress/no-chained-get`)
+# cypress/no-chained-get
+
+📝 Disallow chain of `cy.get()` calls.
 
 <!-- end auto-generated rule header -->
 

package/docs/rules/no-debug.md

@@ -1,4 +1,6 @@
-# Disallow using `cy.debug()` calls (`cypress/no-debug`)
+# cypress/no-debug
+
+📝 Disallow using `cy.debug()` calls.
 
 <!-- end auto-generated rule header -->
 

package/docs/rules/no-force.md

@@ -1,4 +1,6 @@
-# Disallow using `force: true` with action commands (`cypress/no-force`)
+# cypress/no-force
+
+📝 Disallow using `force: true` with action commands.
 
 <!-- end auto-generated rule header -->
 

package/docs/rules/no-pause.md

@@ -1,4 +1,6 @@
-# Disallow using `cy.pause()` calls (`cypress/no-pause`)
+# cypress/no-pause
+
+📝 Disallow using `cy.pause()` calls.
 
 <!-- end auto-generated rule header -->
 

package/docs/rules/no-unnecessary-waiting.md

@@ -1,4 +1,6 @@
-# Disallow waiting for arbitrary time periods (`cypress/no-unnecessary-waiting`)
+# cypress/no-unnecessary-waiting
+
+📝 Disallow waiting for arbitrary time periods.
 
 💼 This rule is enabled in the ✅ `recommended` config.
 

package/docs/rules/no-xpath.md

@@ -1,4 +1,6 @@
-# Disallow using `cy.xpath()` calls (`cypress/no-xpath`)
+# cypress/no-xpath
+
+📝 Disallow using `cy.xpath()` calls.
 
 <!-- end auto-generated rule header -->
 

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

@@ -1,4 +1,6 @@
-# Require `data-*` attribute selectors (`cypress/require-data-selectors`)
+# cypress/require-data-selectors
+
+📝 Require `data-*` attribute selectors.
 
 <!-- end auto-generated rule header -->
 

package/docs/rules/unsafe-to-chain-command.md

@@ -1,4 +1,6 @@
-# Disallow actions within chains (`cypress/unsafe-to-chain-command`)
+# cypress/unsafe-to-chain-command
+
+📝 Disallow actions within chains.
 
 💼 This rule is enabled in the ✅ `recommended` config.
 

package/lib/rules/unsafe-to-chain-command.js

@@ -49,6 +49,7 @@ const schema = {
       default: [],
     },
   },
+  additionalProperties: false,
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-cypress",
-  "version": "5.2.0",
+  "version": "5.3.0",
   "description": "An ESLint plugin for projects using Cypress",
   "main": "./lib/flat.js",
   "exports": {
@@ -31,17 +31,20 @@
     "eslint": ">=9"
   },
   "dependencies": {
-    "globals": "^16.2.0"
+    "globals": "^16.5.0"
   },
   "devDependencies": {
-    "@stylistic/eslint-plugin": "^5.3.1",
-    "eslint": "^9.35.0",
-    "eslint-plugin-eslint-plugin": "^7.0.0",
-    "eslint-plugin-mocha": "^11.1.0",
+    "@eslint/js": "^9.39.2",
+    "@stylistic/eslint-plugin": "^5.8.0",
+    "eslint": "^9.39.2",
+    "eslint-plugin-eslint-plugin": "^7.3.0",
+    "eslint-plugin-mocha": "^11.2.0",
     "husky": "^9.1.7",
-    "prettier": "^3.6.2",
-    "semantic-release": "24.2.7",
-    "vitest": "^3.2.4"
+    "prettier": "^3.8.1",
+    "semantic-release": "^25.0.3",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.54.0",
+    "vitest": "^4.0.18"
   },
   "scripts": {
     "lint": "eslint",