eslint-plugin-cypress 5.3.0 → 6.0.0

package/CONTRIBUTING.md

@@ -35,7 +35,7 @@ To add a new rule:
 - Run `npm run format`
 - Run `npm test` to run [Vitest](https://vitest.dev/)
 - Make sure all tests are passing
-- Add the rule to [flat.js](https://github.com/cypress-io/eslint-plugin-cypress/blob/master/lib/flat.js)
+- Add the rule to [index.js](./lib/index.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
 

package/README.md

@@ -20,7 +20,9 @@ yarn add eslint eslint-plugin-cypress --dev
 
 ## Usage
 
-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.
+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:
 
@@ -28,11 +30,10 @@ To set up a configuration, add a file `eslint.config.mjs` to the root directory
 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:
+The configuration `eslint-plugin-cypress/flat`, which was deprecated in plugin version `5.0.0`, is no longer available.
+Migrate to using the equivalent configuration `eslint-plugin-cypress` by dropping the `/flat` suffix.
 
-```shell
-import pluginCypress from 'eslint-plugin-cypress/flat' # deprecated
-```
+Refer to ESLint `v10` [Configuration File Resolution](https://eslint.org/docs/latest/use/configure/configuration-files#configuration-file-resolution) for hierachical use of configuration files.
 
 ## Configurations
 
@@ -81,7 +82,7 @@ The examples use the `defineConfig()` helper, introduced with ESLint [9.22.0](ht
 
 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`
+- [cypress/unsafe-to-chain-command](./docs/rules/unsafe-to-chain-command.md) is activated and set to `error`
 
 ```js
 import { defineConfig } from 'eslint/config'
@@ -102,7 +103,7 @@ export default defineConfig([
 
 The `eslint-plugin-cypress` [recommended rules](#rules) `configs.recommended` are activated, except for
 
-- [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`
+- [cypress/no-unnecessary-waiting](./docs/rules/no-unnecessary-waiting.md) which is set to `off`
 
 ```js
 import { defineConfig } from 'eslint/config'
@@ -139,7 +140,7 @@ export default defineConfig([
 
 ## Disable rules
 
-You can disable specific rules per file, for a portion of a file, or for a single line. See the [ESLint rules](https://eslint.org/docs/latest/use/configure/rules#disabling-rules) documentation. For example ...
+You can disable specific rules per file, for a portion of a file, or for a single line. See the [ESLint rules](https://eslint.org/docs/latest/use/configure/rules#disable-rules) documentation. For example ...
 
 Disable the `cypress/no-unnecessary-waiting` rule for the entire file by placing this at the start of the file:
 
@@ -190,7 +191,7 @@ 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). This version of the plugin supports only flat file configurations with the option `configs.recommended`.
+[eslint-plugin-mocha@^11](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.
 

package/package.json

@@ -1,11 +1,10 @@
 {
   "name": "eslint-plugin-cypress",
-  "version": "5.3.0",
+  "version": "6.0.0",
   "description": "An ESLint plugin for projects using Cypress",
-  "main": "./lib/flat.js",
+  "main": "./lib/index.js",
   "exports": {
-    ".": "./lib/flat.js",
-    "./flat": "./lib/flat.js"
+    ".": "./lib/index.js"
   },
   "files": [
     "lib",
@@ -14,6 +13,7 @@
   ],
   "author": "Cypress-io",
   "license": "MIT",
+  "type": "commonjs",
   "keywords": [
     "eslint",
     "eslintplugin",
@@ -31,19 +31,19 @@
     "eslint": ">=9"
   },
   "dependencies": {
-    "globals": "^16.5.0"
+    "globals": "^17.3.0"
   },
   "devDependencies": {
-    "@eslint/js": "^9.39.2",
+    "@eslint/js": "^10.0.1",
     "@stylistic/eslint-plugin": "^5.8.0",
-    "eslint": "^9.39.2",
-    "eslint-plugin-eslint-plugin": "^7.3.0",
+    "eslint": "^10.0.0",
+    "eslint-plugin-eslint-plugin": "^7.3.1",
     "eslint-plugin-mocha": "^11.2.0",
     "husky": "^9.1.7",
     "prettier": "^3.8.1",
     "semantic-release": "^25.0.3",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.54.0",
+    "typescript-eslint": "^8.56.0",
     "vitest": "^4.0.18"
   },
   "scripts": {