eslint-plugin-cypress 2.14.0 → 2.15.2

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npm run lint

package/.node-version

@@ -0,0 +1 @@
+16.15.0

package/.nvmrc

@@ -0,0 +1 @@
+16.15.0

package/README.md

@@ -36,6 +36,7 @@ You can add rules:
     "cypress/assertion-before-screenshot": "warn",
     "cypress/no-force": "warn",
     "cypress/no-async-tests": "error",
+    "cypress/no-async-before": "error",
     "cypress/no-pause": "error"
   }
 }

package/circle.yml

@@ -27,7 +27,7 @@ jobs:
       - checkout
       - run:
           name: Install dependencies
-          command: npm install
+          command: npm ci
       - run:
           name: Lint code
           command: npm run lint
@@ -39,10 +39,13 @@ jobs:
       - checkout
       - run:
           name: Install dependencies
-          command: npm install
+          command: npm ci
+      - run:
+          name: Install ESLint 4
+          command: npm install eslint@4
       - run:
           name: Test ESLint 4
-          command: npm run test:v4
+          command: npm test
 
   test-v5:
     docker:
@@ -51,10 +54,13 @@ jobs:
       - checkout
       - run:
           name: Install dependencies
-          command: npm install
+          command: npm ci
+      - run:
+          name: Install ESLint 5
+          command: npm install eslint@5
       - run:
           name: Test ESLint 5
-          command: npm run test
+          command: npm test
 
   test-v6:
     docker:
@@ -63,10 +69,13 @@ jobs:
       - checkout
       - run:
           name: Install dependencies
-          command: npm install
+          command: npm ci
+      - run:
+          name: Install ESLint 6
+          command: npm install eslint@6
       - run:
           name: Test ESLint 6
-          command: npm run test:v6
+          command: npm test
 
   release:
     docker:
@@ -75,7 +84,7 @@ jobs:
       - checkout
       - run:
           name: Install dependencies
-          command: npm install
+          command: npm ci
       - run:
           name: Run semantic release
           command: npm run semantic-release

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

@@ -0,0 +1,52 @@
+# 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. 
+
+## Rule Details
+
+This rule disallows using `async` `before` and `beforeEach` functions.
+
+Examples of **incorrect** code for this rule:
+
+```js
+describe('my feature', () => {
+  before('my test case', async ()  => {
+    await cy.get('.myClass')
+    // other operations
+  })
+})
+```
+
+```js
+describe('my feature', () => {
+  before('my test case', async ()  => {
+    cy
+    .get('.myClass')
+    .click()
+
+    await someAsyncFunction()
+  })
+})
+```
+
+Examples of **correct** code for this rule:
+
+```js
+describe('my feature', () => {
+  before('my test case', ()  => {
+    cy.get('.myClass')
+    // other operations
+  })
+})
+
+```
+
+## When Not To Use It
+
+If there are genuine use-cases for using `async/await` in your before then you may not want to include this rule (or at least demote it to a warning).
+
+## 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)

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

@@ -0,0 +1,47 @@
+'use strict'
+
+module.exports = {
+  meta: {
+    docs: {
+      description: 'Prevent using async/await in Cypress before methods',
+      category: 'Possible Errors',
+      recommended: true,
+    },
+    messages: {
+      unexpected: 'Avoid using async functions with Cypress before / beforeEach functions',
+    },
+  },
+
+  create (context) {
+    function isBeforeBlock (callExpressionNode) {
+      const { type, name } = callExpressionNode.callee
+
+      return type === 'Identifier'
+                && name === 'before' || name === 'beforeEach'
+    }
+
+    function isBeforeAsync (node) {
+      return node.arguments
+                && node.arguments.length >= 2
+                && node.arguments[1].async === true
+    }
+
+    return {
+      Identifier (node) {
+        if (node.name === 'cy' || node.name === 'Cypress') {
+          const ancestors = context.getAncestors()
+          const asyncTestBlocks = ancestors
+          .filter((n) => n.type === 'CallExpression')
+          .filter(isBeforeBlock)
+          .filter(isBeforeAsync)
+
+          if (asyncTestBlocks.length >= 1) {
+            asyncTestBlocks.forEach((node) => {
+              context.report({ node, messageId: 'unexpected' })
+            })
+          }
+        }
+      },
+    }
+  },
+}

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

@@ -19,7 +19,7 @@ const unsafeToChainActions = [
   'check',
   'dblclick',
   'each',
-  'focus',
+  'focus$',
   'rightclick',
   'screenshot',
   'scrollIntoView',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-cypress",
-  "version": "2.14.0",
+  "version": "2.15.2",
   "description": "An ESLint plugin for projects using Cypress",
   "main": "index.js",
   "author": "Cypress-io",
@@ -27,22 +27,21 @@
   "devDependencies": {
     "@cypress/eslint-plugin-dev": "3.2.0",
     "@cypress/eslint-plugin-json": "3.2.1",
-    "condition-circle": "2.0.2",
     "eslint": "^5.7.0",
-    "husky": "^3.0.0",
+    "husky": "^8.0.3",
     "jest": "^24.8.0",
-    "semantic-release": "15.13.18"
+    "semantic-release": "19.0.3"
   },
   "scripts": {
-    "precommit": "npm run lint",
-    "lint": "eslint '*.js' '**/**/*.js'",
+    "lint": "eslint \"*.js\" \"**/**/*.js\"",
     "lint-fix": "npm run lint -- --fix",
     "semantic-release": "semantic-release",
     "start": "yarn 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"
+    "test-watch": "jest --watchAll",
+    "prepare": "husky install"
   },
   "jest": {
     "testMatch": [

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

@@ -0,0 +1,25 @@
+'use strict'
+
+const rule = require('../../../lib/rules/no-async-before')
+const RuleTester = require('eslint').RuleTester
+
+const ruleTester = new RuleTester()
+
+const errors = [{ messageId: 'unexpected' }]
+// async functions are an ES2017 feature
+const parserOptions = { ecmaVersion: 8 }
+
+ruleTester.run('no-async-before', rule, {
+  valid: [
+    { code: 'before(\'a before case\', () => { cy.get(\'.someClass\'); })', parserOptions },
+    { code: 'before(\'a before case\', async () => { await somethingAsync(); })', parserOptions },
+    { code: 'async function nonTestFn () { return await somethingAsync(); }', parserOptions },
+    { code: 'const nonTestArrowFn = async () => { await somethingAsync(); }', parserOptions },
+  ],
+  invalid: [
+    { code: 'before(\'a test case\', async () => { cy.get(\'.someClass\'); })', parserOptions, errors },
+    { code: 'beforeEach(\'a test case\', async () => { cy.get(\'.someClass\'); })', parserOptions, errors },
+    { code: 'before(\'a test case\', async function () { cy.get(\'.someClass\'); })', parserOptions, errors },
+    { code: 'beforeEach(\'a test case\', async function () { cy.get(\'.someClass\'); })', parserOptions, errors },
+  ],
+})

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

@@ -14,6 +14,10 @@ ruleTester.run('action-ends-chain', rule, {
       code: 'cy.get("new-todo").type("todo A{enter}"); cy.get("new-todo").type("todo B{enter}"); cy.get("new-todo").should("have.class", "active");',
       parserOptions,
     },
+    {
+      code: 'cy.focused().should("be.visible");',
+      parserOptions,
+    },
   ],
 
   invalid: [
@@ -27,6 +31,11 @@ ruleTester.run('action-ends-chain', rule, {
       parserOptions,
       errors,
     },
+    {
+      code: 'cy.get("new-todo").focus().should("have.class", "active");',
+      parserOptions,
+      errors,
+    },
     {
       code: 'cy.get("new-todo").customType("todo A{enter}").customClick();',
       parserOptions,