eslint-plugin-cypress 6.4.3 → 6.4.4

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

@@ -114,9 +114,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 +132,7 @@ import pluginCypress from 'eslint-plugin-cypress'
 export default defineConfig([
   {
     files: ['cypress/**/*.js'],
-    extends: [
-      pluginCypress.configs.globals,
-    ],
+    extends: [pluginCypress.configs.globals],
   },
 ])
 ```
@@ -160,7 +156,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 +173,7 @@ export default defineConfig([
         projectService: true,
       },
     },
-  }
+  },
 ])
 ```
 

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": "6.4.4",
   "description": "An ESLint plugin for projects using Cypress",
   "main": "./lib/index.js",
   "exports": {
@@ -37,20 +37,21 @@
     }
   },
   "dependencies": {
-    "globals": "^17.7.0"
+    "globals": "^17.8.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",
+    "@typescript-eslint/rule-tester": "^8.65.0",
+    "cypress": "^15.19.0",
+    "eslint": "^10.7.0",
+    "eslint-doc-generator": "^3.7.0",
+    "eslint-plugin-eslint-plugin": "^7.5.0",
     "eslint-plugin-mocha": "^11.3.0",
     "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.65.0",
     "vitest": "^4.1.10"
   },
   "scripts": {
@@ -60,5 +61,8 @@
     "format:check": "prettier --check .",
     "test": "vitest run",
     "prepare": "husky"
+  },
+  "allowScripts": {
+    "cypress": true
   }
 }