eslint-plugin-cypress 2.15.2 → 3.0.1

package/.eslintrc.json

@@ -1,8 +1,39 @@
 {
+  "env": {
+    "node": true,
+    "es6": true
+  },
   "plugins": [
-    "@cypress/dev"
+    "eslint-plugin",
+    "n",
+    "mocha"
   ],
   "extends": [
-    "plugin:@cypress/dev/general"
-  ]
+    "eslint:recommended",
+    "plugin:eslint-plugin/recommended",
+    "plugin:n/recommended",
+    "plugin:mocha/recommended"
+  ],
+  "rules": {
+    "eslint-plugin/require-meta-docs-url": [
+      "error",
+      {
+        "pattern": "https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/{{name}}.md"
+      }
+    ],
+    "n/no-extraneous-require": [
+      "error",
+      {
+        "allowModules": [
+          "jest-config"
+        ]
+      }
+    ],
+    "no-redeclare": "off",
+    "mocha/no-mocha-arrows": "off",
+    "mocha/no-setup-in-describe": "off"
+  },
+  "parserOptions": {
+    "ecmaVersion": 2018
+  }
 }

package/.node-version

@@ -1 +1 @@
-16.15.0
+20.12.2

package/.nvmrc

@@ -1 +1 @@
-16.15.0
+20.12.2

package/CONTRIBUTING.md

@@ -0,0 +1,16 @@
+# Contributing to cypress-io/eslint-plugin-cypress
+
+Thanks for taking the time to contribute! :smile:
+
+To add a new rule:
+  * Fork and clone this repository
+  * Generate a new rule (a [yeoman generator](https://github.com/eslint/generator-eslint) is available)
+  * Write test scenarios then implement logic
+  * Describe the rule in the generated `docs` file
+  * Run `npm test` to run [Jest](https://jestjs.io/) or
+  * Run `npm start` to run [Jest](https://jestjs.io/) in [watchAll](https://jestjs.io/docs/cli#--watchall) mode where it remains active and reruns when source changes are made
+  * Make sure all tests are passing
+  * Add the rule to the [README](README.md) file
+  * Create a PR
+
+Use the following commit message conventions: https://github.com/semantic-release/semantic-release#commit-message-format

package/README.md

@@ -6,6 +6,8 @@ Note: If you installed ESLint globally then you must also install `eslint-plugin
 
 ## Installation
 
+Prerequisites: [ESLint](https://www.npmjs.com/package/eslint) `v7` or `v8`. ESLint `v9` is **not** supported yet.
+
 ```sh
 npm install eslint-plugin-cypress --save-dev
 ```
@@ -115,8 +117,6 @@ These rules enforce some of the [best practices recommended for using Cypress](h
 
 Rules with a check mark (✅) are enabled by default while using the `plugin:cypress/recommended` config.
 
-**NOTE**: These rules currently require eslint 5.0 or greater. If you would like support added for eslint 4.x, please 👍  [this issue](https://github.com/cypress-io/eslint-plugin-cypress/issues/14).
-
 |     | Rule ID                                                                    | Description                                                     |
 | :-- | :------------------------------------------------------------------------- | :-------------------------------------------------------------- |
 | ✅  | [no-assigning-return-values](./docs/rules/no-assigning-return-values.md)   | Prevent assigning return values of cy calls                     |
@@ -128,6 +128,44 @@ Rules with a check mark (✅) are enabled by default while using the `plugin:cyp
 |     | [require-data-selectors](./docs/rules/require-data-selectors.md)           | Only allow data-\* attribute selectors (require-data-selectors) |
 |     | [no-pause](./docs/rules/no-pause.md)           | Disallow `cy.pause()` parent command |
 
+## Mocha and Chai
+
+Cypress is built on top of [Mocha](https://on.cypress.io/guides/references/bundled-libraries#Mocha) and [Chai](https://on.cypress.io/guides/references/bundled-libraries#Chai). See the following sections for information on using ESLint plugins [eslint-plugin-mocha](https://www.npmjs.com/package/eslint-plugin-mocha) and [eslint-plugin-chai-friendly](https://www.npmjs.com/package/eslint-plugin-chai-friendly) together with `eslint-plugin-cypress`.
+
+## Mocha `.only` and `.skip`
+
+During test spec development, [Mocha exclusive tests](https://mochajs.org/#exclusive-tests) `.only` or [Mocha inclusive tests](https://mochajs.org/#inclusive-tests) `.skip` may be used to control which tests are executed, as described in the Cypress documentation [Excluding and Including Tests](https://on.cypress.io/guides/core-concepts/writing-and-organizing-tests#Excluding-and-Including-Tests). To apply corresponding rules, you can install and use [eslint-plugin-mocha](https://www.npmjs.com/package/eslint-plugin-mocha). The rule [mocha/no-exclusive-tests](https://github.com/lo1tuma/eslint-plugin-mocha/blob/main/docs/rules/no-exclusive-tests.md) detects the use of `.only` and the [mocha/no-skipped-tests](https://github.com/lo1tuma/eslint-plugin-mocha/blob/main/docs/rules/no-skipped-tests.md) rule detects the use of `.skip`:
+
+```sh
+npm install --save-dev eslint-plugin-mocha
+```
+
+In your `.eslintrc.json`:
+
+```json
+{
+  "plugins": [
+    "cypress",
+    "mocha"
+  ],
+  "rules": {
+    "mocha/no-exclusive-tests": "warn",
+    "mocha/no-skipped-tests": "warn"
+  }
+}
+```
+
+Or you can simply use the `cypress/recommended` and `mocha/recommended` configurations together, for example:
+
+```json
+{
+  "extends": [
+    "plugin:cypress/recommended",
+    "plugin:mocha/recommended"
+  ]
+}
+```
+
 ## Chai and `no-unused-expressions`
 
 Using an assertion such as `expect(value).to.be.true` can fail the ESLint rule `no-unused-expressions` even though it's not an error in this case. To fix this, you can install and use [eslint-plugin-chai-friendly](https://www.npmjs.com/package/eslint-plugin-chai-friendly).
@@ -159,16 +197,6 @@ Or you can simply add its `recommended` config:
 }
 ```
 
-## Contribution Guide
-
-To add a new rule:
-  * Fork and clone this repository
-  * Generate a new rule (a [yeoman generator](https://github.com/eslint/generator-eslint) is available)
-  * Run `yarn start` or `npm start`
-  * Write test scenarios then implement logic
-  * Describe the rule in the generated `docs` file
-  * Make sure all tests are passing
-  * Add the rule to this README
-  * Create a PR
+## Contributing
 
-Use the following commit message conventions: https://github.com/semantic-release/semantic-release#commit-message-format
+Please see our [Contributing Guideline](./CONTRIBUTING.md) which explains how to contribute rules or other fixes and features to the repo.

package/circle.yml

@@ -5,15 +5,13 @@ workflows:
   main:
     jobs:
       - lint
-      - test-v4
-      - test-v5
-      - test-v6
+      - test-v7
+      - test-v8
       - release:
           requires:
             - lint
-            - test-v4
-            - test-v5
-            - test-v6
+            - test-v7
+            - test-v8
           filters:
             branches:
               only:
@@ -22,64 +20,61 @@ workflows:
 jobs:
   lint:
     docker:
-      - image: circleci/node:16
+      - image: cimg/node:20.12.2
     steps:
       - checkout
       - run:
           name: Install dependencies
           command: npm ci
+      - run:
+          name: Show ESLint version
+          command: npx eslint --version
       - run:
           name: Lint code
           command: npm run lint
 
-  test-v4:
+  test-v7:
     docker:
-      - image: circleci/node:16
+      - image: cimg/node:20.12.2
     steps:
       - checkout
       - run:
           name: Install dependencies
           command: npm ci
       - run:
-          name: Install ESLint 4
-          command: npm install eslint@4
-      - run:
-          name: Test ESLint 4
-          command: npm test
-
-  test-v5:
-    docker:
-      - image: circleci/node:16
-    steps:
-      - checkout
+          name: Remove unneeded plugins # minimum eslint@8.23.0 required
+          command: npm uninstall eslint-plugin-eslint-plugin eslint-plugin-n
       - run:
-          name: Install dependencies
-          command: npm ci
+          name: Install ESLint 7
+          command: npm install eslint@7
       - run:
-          name: Install ESLint 5
-          command: npm install eslint@5
+          name: Show ESLint version
+          command: npx eslint --version
       - run:
-          name: Test ESLint 5
+          name: Test ESLint 7
           command: npm test
 
-  test-v6:
+  test-v8:
     docker:
-      - image: circleci/node:16
+      - image: cimg/node:20.12.2
     steps:
       - checkout
       - run:
           name: Install dependencies
           command: npm ci
       - run:
-          name: Install ESLint 6
-          command: npm install eslint@6
+          name: Install ESLint 8
+          command: npm install eslint@8
+      - run:
+          name: Show ESLint version
+          command: npx eslint --version
       - run:
-          name: Test ESLint 6
+          name: Test ESLint 8
           command: npm test
 
   release:
     docker:
-      - image: circleci/node:16
+      - image: cimg/node:20.12.2
     steps:
       - checkout
       - run:

package/index.js

@@ -5,6 +5,7 @@ module.exports = {
     'no-assigning-return-values': require('./lib/rules/no-assigning-return-values'),
     'unsafe-to-chain-command': require('./lib/rules/unsafe-to-chain-command'),
     'no-unnecessary-waiting': require('./lib/rules/no-unnecessary-waiting'),
+    'no-async-before': require('./lib/rules/no-async-before'),
     'no-async-tests': require('./lib/rules/no-async-tests'),
     'assertion-before-screenshot': require('./lib/rules/assertion-before-screenshot'),
     'require-data-selectors': require('./lib/rules/require-data-selectors'),

package/lib/rules/assertion-before-screenshot.js

@@ -16,10 +16,12 @@ const assertionCommands = [
 
 module.exports = {
   meta: {
+    type: 'problem',
     docs: {
       description: 'Assert on the page state before taking a screenshot, so the screenshot is consistent',
       category: 'Possible Errors',
       recommended: false,
+      url: 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/assertion-before-screenshot.md',
     },
     schema: [],
     messages: {

package/lib/rules/no-assigning-return-values.js

@@ -17,11 +17,12 @@ function get (obj, propertyString = '') {
 
 module.exports = {
   meta: {
+    type: 'problem',
     docs: {
       description: 'Prevent assigning return values of cy calls',
       category: 'Possible Errors',
       recommended: true,
-      url: 'https://on.cypress.io/best-practices#Assigning-Return-Values',
+      url: 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-assigning-return-values.md',
     },
     schema: [],
     messages: {

package/lib/rules/no-async-before.js

@@ -2,11 +2,14 @@
 
 module.exports = {
   meta: {
+    type: 'problem',
     docs: {
       description: 'Prevent using async/await in Cypress before methods',
       category: 'Possible Errors',
       recommended: true,
+      url: 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-async-before.md',
     },
+    schema: [],
     messages: {
       unexpected: 'Avoid using async functions with Cypress before / beforeEach functions',
     },

package/lib/rules/no-async-tests.js

@@ -2,11 +2,14 @@
 
 module.exports = {
   meta: {
+    type: 'problem',
     docs: {
       description: 'Prevent using async/await in Cypress test cases',
       category: 'Possible Errors',
       recommended: true,
+      url: 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-async-tests.md',
     },
+    schema: [],
     messages: {
       unexpected: 'Avoid using async functions with Cypress tests',
     },

package/lib/rules/no-force.js

@@ -6,10 +6,12 @@
 
 module.exports = {
   meta: {
+    type: 'suggestion',
     docs: {
       description: 'Disallow using of \'force: true\' option for click and type calls',
       category: 'Possible Errors',
       recommended: false,
+      url: 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-force.md',
     },
     fixable: null, // or "code" or "whitespace"
     schema: [],

package/lib/rules/no-pause.js

@@ -6,10 +6,12 @@
 
 module.exports = {
   meta: {
+    type: 'suggestion',
     docs: {
       description: 'Disallow using of \'cy.pause\' calls',
       category: 'Possible Errors',
       recommended: false,
+      url: 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-pause.md',
     },
     fixable: null, // or "code" or "whitespace"
     schema: [],

package/lib/rules/no-unnecessary-waiting.js

@@ -2,11 +2,12 @@
 
 module.exports = {
   meta: {
+    type: 'problem',
     docs: {
       description: 'Prevent waiting for arbitrary time periods',
       category: 'Possible Errors',
       recommended: true,
-      url: 'https://on.cypress.io/best-practices#Unnecessary-Waiting',
+      url: 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-unnecessary-waiting.md',
     },
     schema: [],
     messages: {

package/lib/rules/require-data-selectors.js

@@ -2,11 +2,12 @@
 
 module.exports = {
   meta: {
+    type: 'suggestion',
     docs: {
-      description: 'Use data-* attributes to provide context to your selectors and insulate them from CSS or JS changes https://docs.cypress.io/guides/references/best-practices.html#Selecting-Elements',
+      description: 'Use data-* attributes to provide context to your selectors and insulate them from CSS or JS changes',
       category: 'Possible Errors',
       recommended: false,
-      url: 'https://docs.cypress.io/guides/references/best-practices.html#Selecting-Elements',
+      url: 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/require-data-selectors.md',
     },
     schema: [],
     messages: {

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

@@ -69,11 +69,12 @@ const getDefaultOptions = (context) => {
 /** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
   meta: {
+    type: 'problem',
     docs: {
       description: DESCRIPTION,
       category: 'Possible Errors',
       recommended: true,
-      url: 'https://docs.cypress.io/guides/core-concepts/retry-ability#Actions-should-be-at-the-end-of-chains-not-the-middle',
+      url: 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/unsafe-to-chain-command.md',
     },
     schema: [schema],
     messages: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-cypress",
-  "version": "2.15.2",
+  "version": "3.0.1",
   "description": "An ESLint plugin for projects using Cypress",
   "main": "index.js",
   "author": "Cypress-io",
@@ -19,33 +19,27 @@
   },
   "homepage": "https://github.com/cypress-io/eslint-plugin-cypress#readme",
   "peerDependencies": {
-    "eslint": ">= 3.2.1"
+    "eslint": ">=7 <9"
   },
   "dependencies": {
     "globals": "^13.20.0"
   },
   "devDependencies": {
-    "@cypress/eslint-plugin-dev": "3.2.0",
-    "@cypress/eslint-plugin-json": "3.2.1",
-    "eslint": "^5.7.0",
+    "eslint": "^8.57.0",
+    "eslint-plugin-eslint-plugin": "^6.0.0",
+    "eslint-plugin-mocha": "^10.4.3",
+    "eslint-plugin-n": "^17.2.1",
     "husky": "^8.0.3",
-    "jest": "^24.8.0",
+    "jest": "^29.7.0",
     "semantic-release": "19.0.3"
   },
   "scripts": {
     "lint": "eslint \"*.js\" \"**/**/*.js\"",
     "lint-fix": "npm run lint -- --fix",
     "semantic-release": "semantic-release",
-    "start": "yarn run test-watch",
+    "start": "npm run test-watch",
     "test": "jest",
-    "test:v4": "npm i eslint@4.x && npm run test",
-    "test:v6": "npm i eslint@6.x && npm run test",
     "test-watch": "jest --watchAll",
     "prepare": "husky install"
-  },
-  "jest": {
-    "testMatch": [
-      "**/tests/**/*.js"
-    ]
   }
 }

package/tests/lib/rules/require-data-selectors.js

@@ -15,7 +15,7 @@ ruleTester.run('require-data-selectors', rule, {
     { code: 'cy.clock(5000)', parserOptions },
     { code: 'cy.scrollTo(0, 10)', parserOptions },
     { code: 'cy.tick(500)', parserOptions },
-    { code: 'cy.get(\`[data-cy=${1}]\`)', parserOptions },
+    { code: 'cy.get(\`[data-cy=${1}]\`)', parserOptions }, // eslint-disable-line no-useless-escape
     { code: 'cy.get("@my-alias")', parserOptions, errors },
     { code: 'cy.get(`@my-alias`)', parserOptions, errors },
   ],
@@ -26,6 +26,6 @@ ruleTester.run('require-data-selectors', rule, {
     { code: 'cy.get(".btn-large").click()', parserOptions, errors },
     { code: 'cy.get(".btn-.large").click()', parserOptions, errors },
     { code: 'cy.get(".a")', parserOptions, errors },
-    { code: 'cy.get(\`[daedta-cy=${1}]\`)', parserOptions, errors },
+    { code: 'cy.get(\`[daedta-cy=${1}]\`)', parserOptions, errors }, // eslint-disable-line no-useless-escape
   ],
 })