eslint-plugin-cypress 3.0.0 → 3.0.2

package/.eslintrc.json

@@ -1,8 +1,40 @@
 {
+  "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"
+      }
+    ],
+    "eslint-plugin/require-meta-docs-description": "error",
+    "n/no-extraneous-require": [
+      "error",
+      {
+        "allowModules": [
+          "jest-config"
+        ]
+      }
+    ],
+    "no-redeclare": "off",
+    "mocha/no-mocha-arrows": "off",
+    "mocha/no-setup-in-describe": "off"
+  },
+  "parserOptions": {
+    "ecmaVersion": 2020
+  }
 }

package/circle.yml

@@ -41,6 +41,9 @@ jobs:
       - run:
           name: Install dependencies
           command: npm ci
+      - run:
+          name: Remove unneeded plugins # minimum eslint@8.23.0 required
+          command: npm uninstall eslint-plugin-eslint-plugin eslint-plugin-n
       - run:
           name: Install ESLint 7
           command: npm install eslint@7

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

@@ -1,6 +1,6 @@
 # Prevent using async/await in Cypress test cases (no-async-tests)
 
-Cypress commands that return a promise may cause side effects in before/beforeEach hooks, possibly causing unexpected behavior. 
+Cypress commands that return a promise may cause side effects in before/beforeEach hooks, possibly causing unexpected behavior.
 
 ## Rule Details
 
@@ -47,6 +47,5 @@ If there are genuine use-cases for using `async/await` in your before then you m
 
 ## Further Reading
 
-- [Commands Are Asynchronous](https://docs.cypress.io/guides/core-concepts/introduction-to-cypress.html#Commands-Are-Asynchronous)
-- [Commands Are Promises](https://docs.cypress.io/guides/core-concepts/introduction-to-cypress.html#Commands-Are-Promises)
-- [Commands Are Not Promises](https://docs.cypress.io/guides/core-concepts/introduction-to-cypress.html#Commands-Are-Not-Promises)
+- [Mixing Async and Sync code](https://on.cypress.io/guides/core-concepts/introduction-to-cypress#Mixing-Async-and-Sync-code)
+- [Commands Are Asynchronous](https://on.cypress.io/guides/core-concepts/introduction-to-cypress.html#Commands-Are-Asynchronous)

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

@@ -47,6 +47,5 @@ If there are genuine use-cases for using `async/await` in your test cases then y
 
 ## Further Reading
 
-- [Commands Are Asynchronous](https://docs.cypress.io/guides/core-concepts/introduction-to-cypress.html#Commands-Are-Asynchronous)
-- [Commands Are Promises](https://docs.cypress.io/guides/core-concepts/introduction-to-cypress.html#Commands-Are-Promises)
-- [Commands Are Not Promises](https://docs.cypress.io/guides/core-concepts/introduction-to-cypress.html#Commands-Are-Not-Promises)
+- [Mixing Async and Sync code](https://on.cypress.io/guides/core-concepts/introduction-to-cypress#Mixing-Async-and-Sync-code)
+- [Commands Are Asynchronous](https://on.cypress.io/guides/core-concepts/introduction-to-cypress.html#Commands-Are-Asynchronous)

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',
+      description: 'require screenshots to be preceded by an assertion',
       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',
+      description: 'disallow 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',
+      description: 'disallow 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',
     },
@@ -25,11 +28,14 @@ module.exports = {
                 && node.arguments.length >= 2
                 && node.arguments[1].async === true
     }
+    const sourceCode = context.sourceCode ?? context.getSourceCode()
 
     return {
       Identifier (node) {
         if (node.name === 'cy' || node.name === 'Cypress') {
-          const ancestors = context.getAncestors()
+          const ancestors = sourceCode.getAncestors
+            ? sourceCode.getAncestors(node)
+            : context.getAncestors()
           const asyncTestBlocks = ancestors
           .filter((n) => n.type === 'CallExpression')
           .filter(isBeforeBlock)

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',
+      description: 'disallow 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',
     },
@@ -25,11 +28,14 @@ module.exports = {
                 && node.arguments.length >= 2
                 && node.arguments[1].async === true
     }
+    const sourceCode = context.sourceCode ?? context.getSourceCode()
 
     return {
       Identifier (node) {
         if (node.name === 'cy' || node.name === 'Cypress') {
-          const ancestors = context.getAncestors()
+          const ancestors = sourceCode.getAncestors
+            ? sourceCode.getAncestors(node)
+            : context.getAncestors()
           const asyncTestBlocks = ancestors
           .filter((n) => n.type === 'CallExpression')
           .filter(isTestBlock)

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',
+      description: 'disallow using `force: true` with action commands',
       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',
+      description: 'disallow using `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',
+      description: 'disallow 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: {
@@ -14,10 +15,14 @@ module.exports = {
     },
   },
   create (context) {
+    const sourceCode = context.sourceCode ?? context.getSourceCode()
+
     return {
       CallExpression (node) {
         if (isCallingCyWait(node)) {
-          const scope = context.getScope()
+          const scope = sourceCode.getScope
+            ? sourceCode.getScope(node)
+            : context.getScope()
 
           if (isIdentifierNumberConstArgument(node, scope) || isNumberArgument(node)) {
             context.report({ node, messageId: 'unexpected' })

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: 'require `data-*` attribute selectors',
       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

@@ -3,7 +3,7 @@
 const { basename } = require('path')
 
 const NAME = basename(__dirname)
-const DESCRIPTION = 'Actions should be in the end of chains, not in the middle'
+const DESCRIPTION = 'disallow actions within chains'
 
 /**
  * Commands listed in the documentation with text: 'It is unsafe to chain further commands that rely on the subject after xxx.'
@@ -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": "3.0.0",
+  "version": "3.0.2",
   "description": "An ESLint plugin for projects using Cypress",
   "main": "index.js",
   "author": "Cypress-io",
@@ -25,19 +25,14 @@
     "globals": "^13.20.0"
   },
   "devDependencies": {
-    "@cypress/eslint-plugin-dev": "3.9.1",
-    "@cypress/eslint-plugin-json": "3.2.3",
-    "@typescript-eslint/eslint-plugin": "^4.33.0",
-    "@typescript-eslint/parser": "^4.33.0",
-    "eslint": "^7.32.0",
-    "eslint-plugin-mocha": "^6.3.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": "^29.7.0",
     "semantic-release": "19.0.3"
   },
-  "overrides": {
-    "eslint-plugin-mocha": "$eslint-plugin-mocha"
-  },
   "scripts": {
     "lint": "eslint \"*.js\" \"**/**/*.js\"",
     "lint-fix": "npm run lint -- --fix",

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
   ],
 })