eslint-plugin-cypress 5.1.1 → 5.2.1

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

@@ -75,6 +75,8 @@ 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.
@@ -82,8 +84,9 @@ All rules are available by importing from `eslint-plugin-cypress` and can be ind
 - [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 { defineConfig } from 'eslint/config'
 import pluginCypress from 'eslint-plugin-cypress'
-export default [
+export default defineConfig([
   {
     plugins: {
       cypress: pluginCypress,
@@ -92,7 +95,7 @@ export default [
       'cypress/unsafe-to-chain-command': 'error',
     },
   },
-]
+])
 ```
 
 ### Cypress recommended
@@ -102,15 +105,19 @@ 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 { defineConfig } from 'eslint/config'
 import pluginCypress from 'eslint-plugin-cypress'
-export default [
-  pluginCypress.configs.recommended,
+export default defineConfig([
   {
+    files: ['cypress/**/*.js'],
+    extends: [
+      pluginCypress.configs.recommended,
+    ],
     rules: {
       'cypress/no-unnecessary-waiting': 'off',
     },
   },
-]
+])
 ```
 
 ### Cypress globals
@@ -118,8 +125,16 @@ export default [
 The `configs.globals` are activated.
 
 ```js
+import { defineConfig } from 'eslint/config'
 import pluginCypress from 'eslint-plugin-cypress'
-export default [pluginCypress.configs.globals]
+export default defineConfig([
+  {
+    files: ['cypress/**/*.js'],
+    extends: [
+      pluginCypress.configs.globals,
+    ],
+  },
+])
 ```
 
 ## Disable rules
@@ -187,12 +202,16 @@ npm install eslint-plugin-mocha@^11 --save-dev
 ```
 
 ```js
+import { defineConfig } from 'eslint/config'
 import pluginMocha from 'eslint-plugin-mocha'
 import pluginCypress from 'eslint-plugin-cypress'
-export default [
-  pluginMocha.configs.recommended,
-  pluginCypress.configs.recommended,
+export default defineConfig([
   {
+    files: ['cypress/**/*.js'],
+    extends: [
+      pluginMocha.configs.recommended,
+      pluginCypress.configs.recommended,
+    ],
     rules: {
       'mocha/no-exclusive-tests': 'error',
       'mocha/no-pending-tests': 'error',
@@ -200,7 +219,7 @@ export default [
       'cypress/no-unnecessary-waiting': 'off',
     },
   },
-]
+])
 ```
 
 ### Cypress and Chai recommended
@@ -216,17 +235,21 @@ npm install eslint-plugin-chai-friendly@^1.0.1 --save-dev
 ```
 
 ```js
+import { defineConfig } from 'eslint/config'
 import pluginCypress from 'eslint-plugin-cypress'
 import pluginChaiFriendly from 'eslint-plugin-chai-friendly'
-export default [
-  pluginCypress.configs.recommended,
-  pluginChaiFriendly.configs.recommendedFlat,
+export default defineConfig([
   {
+    files: ['cypress/**/*.js'],
+    extends: [
+      pluginCypress.configs.recommended,
+      pluginChaiFriendly.configs.recommendedFlat,
+    ],
     rules: {
       'cypress/no-unnecessary-waiting': 'off',
     },
   },
-]
+])
 ```
 
 ## Contributing

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/flat.d.ts

@@ -0,0 +1,12 @@
+import type { ESLint, Linter } from 'eslint'
+
+declare const plugin: {
+  meta: { name: string, version: string }
+  configs: {
+    globals: Linter.Config<Linter.RulesRecord>
+    recommended: Linter.Config<Linter.RulesRecord>
+  }
+  rules: NonNullable<ESLint.Plugin['rules']>
+}
+
+export = plugin

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.1.1",
+  "version": "5.2.1",
   "description": "An ESLint plugin for projects using Cypress",
   "main": "./lib/flat.js",
   "exports": {
@@ -34,14 +34,17 @@
     "globals": "^16.2.0"
   },
   "devDependencies": {
-    "@stylistic/eslint-plugin": "^4.4.0",
-    "eslint": "^9.27.0",
-    "eslint-plugin-eslint-plugin": "^6.4.0",
+    "@eslint/js": "^9.39.1",
+    "@stylistic/eslint-plugin": "^5.4.0",
+    "eslint": "^9.39.1",
+    "eslint-plugin-eslint-plugin": "^7.0.0",
     "eslint-plugin-mocha": "^11.1.0",
     "husky": "^9.1.7",
-    "prettier": "^3.5.3",
-    "semantic-release": "24.2.5",
-    "vitest": "^3.1.4"
+    "prettier": "^3.6.2",
+    "semantic-release": "24.2.7",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.45.0",
+    "vitest": "^4.0.4"
   },
   "scripts": {
     "lint": "eslint",