eslint-plugin-cypress 2.11.1 → 2.12.1

package/README.md

@@ -11,7 +11,7 @@ npm install eslint-plugin-cypress --save-dev
 ```
 or
 ```sh
-yarn add eslint-plugin-cypress --save-dev
+yarn add eslint-plugin-cypress --dev
 ```
 
 ## Usage
@@ -35,12 +35,13 @@ You can add rules:
     "cypress/no-unnecessary-waiting": "error",
     "cypress/assertion-before-screenshot": "warn",
     "cypress/no-force": "warn",
-    "cypress/no-async-tests": "error"
+    "cypress/no-async-tests": "error",
+    "cypress/no-pause": "error"
   }
 }
 ```
 
-You can whitelist globals provided by Cypress:
+You can allow certain globals provided by Cypress:
 
 ```json
 {
@@ -62,6 +63,51 @@ Use the recommended configuration and you can forego configuring _plugins_, _rul
 }
 ```
 
+## Disable rules
+
+You can disable specific rules per file, for a portion of a file, or for a single line.
+
+Disable the `cypress/no-unnecessary-waiting` rule for the entire file by placing this at the start of the file:
+
+```js
+/* eslint-disable cypress/no-unnecessary-waiting */
+```
+
+Disable the `cypress/no-unnecessary-waiting` rule for a portion of the file:
+
+```js
+it('waits for a second', () => {
+  ...
+  /* eslint-disable cypress/no-unnecessary-waiting */
+  cy.wait(1000)
+  /* eslint-enable cypress/no-unnecessary-waiting */
+  ...
+})
+```
+
+Disable the `cypress/no-unnecessary-waiting` rule for a specific line:
+
+```js
+it('waits for a second', () => {
+  ...
+  cy.wait(1000) // eslint-disable-line cypress/no-unnecessary-waiting
+  ...
+})
+```
+
+You can also disable a rule for the next line:
+
+```js
+it('waits for a second', () => {
+  ...
+  // eslint-disable-next-line cypress/no-unnecessary-waiting
+  cy.wait(1000)
+  ...
+})
+```
+
+For more, see the [ESLint rules](https://eslint.org/docs/user-guide/configuring/rules) documentation.
+
 ## Rules
 
 These rules enforce some of the [best practices recommended for using Cypress](https://on.cypress.io/best-practices).
@@ -78,6 +124,7 @@ Rules with a check mark (✅) are enabled by default while using the `plugin:cyp
 |     | [no-force](./docs/rules/no-force.md)                                       | Disallow using `force: true` with action commands               |
 |     | [assertion-before-screenshot](./docs/rules/assertion-before-screenshot.md) | Ensure screenshots are preceded by an assertion                 |
 |     | [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 |
 
 ## Chai and `no-unused-expressions`
 

package/docs/rules/no-pause.md

@@ -0,0 +1,16 @@
+## Do not use `cy.pause` command
+
+It is recommended to remove [cy.pause](https://on.cypress.io/pause) command before committing the specs to avoid other developers getting unexpected results.
+
+Invalid:
+
+```js
+cy.pause();
+```
+
+Valid:
+
+```js
+// only the parent cy.pause command is detected
+cy.get('selector').pause();
+```

package/index.js

@@ -8,6 +8,7 @@ module.exports = {
     'assertion-before-screenshot': require('./lib/rules/assertion-before-screenshot'),
     'require-data-selectors': require('./lib/rules/require-data-selectors'),
     'no-force': require('./lib/rules/no-force'),
+    'no-pause': require('./lib/rules/no-pause'),
   },
   configs: {
     recommended: require('./lib/config/recommended'),

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

@@ -39,7 +39,7 @@ module.exports = {
   },
 }
 
-const whitelistedCommands = {
+const allowedCommands = {
   now: true,
   spy: true,
   state: true,
@@ -61,7 +61,7 @@ function isCypressCommandDeclaration (declarator) {
 
   const parent = get(object, 'parent.property.name') || get(declarator, 'id.name')
 
-  if (commandName && (whitelistedCommands[commandName] || whitelistedCommands[parent])) return
+  if (commandName && (allowedCommands[commandName] || allowedCommands[parent])) return
 
   return object.name === 'cy'
 }

package/lib/rules/no-force.js

@@ -42,7 +42,7 @@ module.exports = {
 
       return node.arguments && node.arguments.length &&
       node.arguments.some((arg) => {
-        return arg.type === 'ObjectExpression' && arg.properties.some((propNode) => propNode.key.name === 'force')
+        return arg.type === 'ObjectExpression' && arg.properties.some((propNode) => propNode.key && propNode.key.name === 'force')
       })
     }
 

package/lib/rules/no-pause.js

@@ -0,0 +1,56 @@
+'use strict'
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+module.exports = {
+  meta: {
+    docs: {
+      description: 'Disallow using of \'cy.pause\' calls',
+      category: 'Possible Errors',
+      recommended: false,
+    },
+    fixable: null, // or "code" or "whitespace"
+    schema: [],
+    messages: {
+      unexpected: 'Do not use cy.pause command',
+    },
+  },
+
+  create (context) {
+
+    // variables should be defined here
+
+    //----------------------------------------------------------------------
+    // Helpers
+    //----------------------------------------------------------------------
+    function isCallingPause (node) {
+      return node.callee &&
+        node.callee.property &&
+        node.callee.property.type === 'Identifier' &&
+        node.callee.property.name === 'pause'
+    }
+
+    function isCypressCall (node) {
+      return node.callee &&
+        node.callee.type === 'MemberExpression' &&
+        node.callee.object.type === 'Identifier' &&
+        node.callee.object.name === 'cy'
+    }
+
+    //----------------------------------------------------------------------
+    // Public
+    //----------------------------------------------------------------------
+
+    return {
+
+      CallExpression (node) {
+        if (isCypressCall(node) && isCallingPause(node)) {
+          context.report({ node, messageId: 'unexpected' })
+        }
+      },
+
+    }
+  },
+}

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

@@ -56,7 +56,8 @@ function isIdentifierNumberConstArgument (node, scope) {
 
   if (node.arguments[0].type !== 'Identifier') return false
 
-  const resolvedIdentifier = scope.resolve(node.arguments[0]).resolved
+  const identifier = node.arguments[0]
+  const resolvedIdentifier = scope.references.find((ref) => ref.identifier === identifier).resolved
   const definition = resolvedIdentifier.defs[0]
   const isVariable = definition.type === 'Variable'
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-cypress",
-  "version": "2.11.1",
+  "version": "2.12.1",
   "description": "An ESLint plugin for projects using Cypress",
   "main": "index.js",
   "author": "Chris Breiding (chris@cypress.io)",

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

@@ -9,7 +9,7 @@ const rule = require('../../../lib/rules/no-force')
 const RuleTester = require('eslint').RuleTester
 
 const errors = [{ messageId: 'unexpected' }]
-const parserOptions = { ecmaVersion: 6 }
+const parserOptions = { ecmaVersion: 2018 }
 
 //------------------------------------------------------------------------------
 // Tests
@@ -24,12 +24,13 @@ ruleTester.run('no-force', rule, {
     { code: `cy.get('button').click({multiple: true})`, parserOptions },
     { code: `cy.get('button').dblclick()`, parserOptions },
     { code: `cy.get('input').type('somth')`, parserOptions },
-    { code: `cy.get('input').type('somth', {anyoption: true})`, parserOptions, errors },
-    { code: `cy.get('input').trigger('click', {anyoption: true})`, parserOptions, errors },
-    { code: `cy.get('input').rightclick({anyoption: true})`, parserOptions, errors },
-    { code: `cy.get('input').check()`, parserOptions, errors },
-    { code: `cy.get('input').select()`, parserOptions, errors },
-    { code: `cy.get('input').focus()`, parserOptions, errors },
+    { code: `cy.get('input').type('somth', {anyoption: true})`, parserOptions },
+    { code: `cy.get('input').trigger('click', {anyoption: true})`, parserOptions },
+    { code: `cy.get('input').rightclick({anyoption: true})`, parserOptions },
+    { code: `cy.get('input').check()`, parserOptions },
+    { code: `cy.get('input').select()`, parserOptions },
+    { code: `cy.get('input').focus()`, parserOptions },
+    { code: `cy.document().trigger("keydown", { ...event })`, parserOptions },
   ],
 
   invalid: [

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

@@ -0,0 +1,33 @@
+'use strict'
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const rule = require('../../../lib/rules/no-pause')
+
+const RuleTester = require('eslint').RuleTester
+
+const errors = [{ messageId: 'unexpected' }]
+const parserOptions = { ecmaVersion: 2018 }
+
+//------------------------------------------------------------------------------
+// Tests
+//------------------------------------------------------------------------------
+
+const ruleTester = new RuleTester()
+
+ruleTester.run('no-pause', rule, {
+
+  valid: [
+    // for now, we do not detect .pause() child command
+    { code: `cy.get('button').pause()`, parserOptions },
+    { code: `pause()`, parserOptions },
+    { code: `cy.get('button').dblclick()`, parserOptions },
+  ],
+
+  invalid: [
+    { code: `cy.pause()`, parserOptions, errors },
+    { code: `cy.pause({ log: false })`, parserOptions, errors },
+  ],
+})

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

@@ -26,6 +26,29 @@ ruleTester.run('no-unnecessary-waiting', rule, {
     { code: 'const customWait = (alias = "@someRequest") => { cy.wait(alias) }', parserOptions, errors },
     { code: 'function customWait (ms) { cy.wait(ms) }', parserOptions, errors },
     { code: 'const customWait = (ms) => { cy.wait(ms) }', parserOptions, errors },
+
+    // disable the eslint rule
+    {
+      code: `
+        cy.wait(100); // eslint-disable-line no-unnecessary-waiting
+      `,
+      parserOptions,
+    },
+    {
+      code: `
+        /* eslint-disable-next-line no-unnecessary-waiting */
+        cy.wait(100)
+      `,
+      parserOptions,
+    },
+    {
+      code: `
+        /* eslint-disable no-unnecessary-waiting */
+        cy.wait(100)
+        /* eslint-enable no-unnecessary-waiting */
+      `,
+      parserOptions,
+    },
   ],
 
   invalid: [