eslint-plugin-cypress 5.0.0 → 5.1.0

package/CONTRIBUTING.md

@@ -32,7 +32,7 @@ To add a new rule:
 * Run `eslint-doc-generator` to generate automated documentation sections (see [Document generation](#document-generation) below)
 * Review documentation changes
 * Run `npm run lint`
-* 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)
+* Run `npm test` to run [Vitest](https://vitest.dev/)
 * Make sure all tests are passing
 * Add the rule to [flat.js](https://github.com/cypress-io/eslint-plugin-cypress/blob/master/lib/flat.js)
 * Create a git commit with a commit message similar to: `feat: add rule <description>` (see [commit message conventions](https://github.com/semantic-release/semantic-release#commit-message-format))

package/lib/flat.js

@@ -20,8 +20,8 @@ const plugin = {
   },
 }
 
-const commonGlobals =
-  Object.assign({
+const commonGlobals
+  = Object.assign({
     cy: false,
     Cypress: false,
     expect: false,
@@ -33,20 +33,20 @@ Object.assign(plugin.configs, {
   globals: {
     name: 'cypress/globals',
     plugins: {
-      cypress: plugin
+      cypress: plugin,
     },
     languageOptions: {
       globals:
         commonGlobals,
-    }
-  }
+    },
+  },
 })
 
 Object.assign(plugin.configs, {
   recommended: {
     name: 'cypress/recommended',
     plugins: {
-      cypress: plugin
+      cypress: plugin,
     },
     rules: {
       'cypress/no-assigning-return-values': 'error',
@@ -57,8 +57,8 @@ Object.assign(plugin.configs, {
     languageOptions: {
       globals:
         commonGlobals,
-    }
-  }
+    },
+  },
 })
 
 module.exports = plugin

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

@@ -28,9 +28,9 @@ module.exports = {
       unexpected: 'Make an assertion on the page state before taking a screenshot',
     },
   },
-  create (context) {
+  create(context) {
     return {
-      CallExpression (node) {
+      CallExpression(node) {
         if (isCallingCyScreenshot(node) && !isPreviousAnAssertion(node)) {
           context.report({ node, messageId: 'unexpected' })
         }
@@ -39,12 +39,12 @@ module.exports = {
   },
 }
 
-function isRootCypress (node) {
+function isRootCypress(node) {
   while (node.type === 'CallExpression') {
     if (node.callee.type !== 'MemberExpression') return false
 
-    if (node.callee.object.type === 'Identifier' &&
-        node.callee.object.name === 'cy') {
+    if (node.callee.object.type === 'Identifier'
+      && node.callee.object.name === 'cy') {
       return true
     }
 
@@ -54,26 +54,26 @@ function isRootCypress (node) {
   return false
 }
 
-function getPreviousInChain (node) {
-  return node.type === 'CallExpression' &&
-         node.callee.type === 'MemberExpression' &&
-         node.callee.object.type === 'CallExpression' &&
-         node.callee.object.callee.type === 'MemberExpression' &&
-         node.callee.object.callee.property.type === 'Identifier' &&
-         node.callee.object.callee.property.name
+function getPreviousInChain(node) {
+  return node.type === 'CallExpression'
+    && node.callee.type === 'MemberExpression'
+    && node.callee.object.type === 'CallExpression'
+    && node.callee.object.callee.type === 'MemberExpression'
+    && node.callee.object.callee.property.type === 'Identifier'
+    && node.callee.object.callee.property.name
 }
 
-function getCallExpressionCypressCommand (node) {
-  return isRootCypress(node) &&
-         node.callee.property.type === 'Identifier' &&
-         node.callee.property.name
+function getCallExpressionCypressCommand(node) {
+  return isRootCypress(node)
+    && node.callee.property.type === 'Identifier'
+    && node.callee.property.name
 }
 
-function isCallingCyScreenshot (node) {
+function isCallingCyScreenshot(node) {
   return getCallExpressionCypressCommand(node) === 'screenshot'
 }
 
-function getPreviousCypressCommand (node) {
+function getPreviousCypressCommand(node) {
   const previousInChain = getPreviousInChain(node)
 
   if (previousInChain) {
@@ -97,15 +97,15 @@ function getPreviousCypressCommand (node) {
 
   const previousStatement = body[index - 1]
 
-  if (previousStatement.type !== 'ExpressionStatement' ||
-      previousStatement.expression.type !== 'CallExpression') {
+  if (previousStatement.type !== 'ExpressionStatement'
+    || previousStatement.expression.type !== 'CallExpression') {
     return null
   }
 
   return getCallExpressionCypressCommand(previousStatement.expression)
 }
 
-function isPreviousAnAssertion (node) {
+function isPreviousAnAssertion(node) {
   const previousCypressCommand = getPreviousCypressCommand(node)
 
   return assertionCommands.indexOf(previousCypressCommand) >= 0

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

@@ -1,7 +1,7 @@
 'use strict'
 
 // safely get nested object property
-function get (obj, propertyString = '') {
+function get(obj, propertyString = '') {
   const properties = propertyString.split('.')
 
   for (let i = 0; i < properties.length; i++) {
@@ -29,9 +29,9 @@ module.exports = {
       unexpected: 'Do not assign the return value of a Cypress command',
     },
   },
-  create (context) {
+  create(context) {
     return {
-      VariableDeclaration (node) {
+      VariableDeclaration(node) {
         if (node.declarations.some(isCypressCommandDeclaration)) {
           context.report({ node, messageId: 'unexpected' })
         }
@@ -47,7 +47,7 @@ const allowedCommands = {
   stub: true,
 }
 
-function isCypressCommandDeclaration (declarator) {
+function isCypressCommandDeclaration(declarator) {
   let object = get(declarator, 'init.callee.object')
 
   if (!object) return

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

@@ -15,31 +15,31 @@ module.exports = {
     },
   },
 
-  create (context) {
-    function isBeforeBlock (callExpressionNode) {
+  create(context) {
+    function isBeforeBlock(callExpressionNode) {
       const { type, name } = callExpressionNode.callee
 
       return type === 'Identifier'
-                && name === 'before' || name === 'beforeEach'
+        && (name === 'before' || name === 'beforeEach')
     }
 
-    function isBeforeAsync (node) {
+    function isBeforeAsync(node) {
       return node.arguments
-                && node.arguments.length >= 2
-                && node.arguments[1].async === true
+        && node.arguments.length >= 2
+        && node.arguments[1].async === true
     }
     const sourceCode = context.sourceCode ?? context.getSourceCode()
 
     return {
-      Identifier (node) {
+      Identifier(node) {
         if (node.name === 'cy' || node.name === 'Cypress') {
           const ancestors = sourceCode.getAncestors
             ? sourceCode.getAncestors(node)
             : context.getAncestors()
           const asyncTestBlocks = ancestors
-          .filter((n) => n.type === 'CallExpression')
-          .filter(isBeforeBlock)
-          .filter(isBeforeAsync)
+            .filter((n) => n.type === 'CallExpression')
+            .filter(isBeforeBlock)
+            .filter(isBeforeAsync)
 
           if (asyncTestBlocks.length >= 1) {
             asyncTestBlocks.forEach((node) => {

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

@@ -15,31 +15,31 @@ module.exports = {
     },
   },
 
-  create (context) {
-    function isTestBlock (callExpressionNode) {
+  create(context) {
+    function isTestBlock(callExpressionNode) {
       const { type, name } = callExpressionNode.callee
 
       return type === 'Identifier'
-                && name === 'it' || name === 'test'
+        && (name === 'it' || name === 'test')
     }
 
-    function isTestAsync (node) {
+    function isTestAsync(node) {
       return node.arguments
-                && node.arguments.length >= 2
-                && node.arguments[1].async === true
+        && node.arguments.length >= 2
+        && node.arguments[1].async === true
     }
     const sourceCode = context.sourceCode ?? context.getSourceCode()
 
     return {
-      Identifier (node) {
+      Identifier(node) {
         if (node.name === 'cy' || node.name === 'Cypress') {
           const ancestors = sourceCode.getAncestors
             ? sourceCode.getAncestors(node)
             : context.getAncestors()
           const asyncTestBlocks = ancestors
-          .filter((n) => n.type === 'CallExpression')
-          .filter(isTestBlock)
-          .filter(isTestAsync)
+            .filter((n) => n.type === 'CallExpression')
+            .filter(isTestBlock)
+            .filter(isTestAsync)
 
           if (asyncTestBlocks.length >= 1) {
             asyncTestBlocks.forEach((node) => {

package/lib/rules/no-chained-get.js

@@ -1,8 +1,8 @@
-'use strict';
+'use strict'
 
-//------------------------------------------------------------------------------
+// ------------------------------------------------------------------------------
 // Rule Definition
-//------------------------------------------------------------------------------
+// ------------------------------------------------------------------------------
 
 /** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
@@ -23,55 +23,55 @@ module.exports = {
   create(context) {
     const isRootCypress = (node) => {
       if (
-        node.type !== 'CallExpression' ||
-        node.callee.type !== 'MemberExpression'
+        node.type !== 'CallExpression'
+        || node.callee.type !== 'MemberExpression'
       ) {
-        return false;
+        return false
       }
 
       if (
-        node.callee.object.type === 'Identifier' &&
-        node.callee.object.name === 'cy'
+        node.callee.object.type === 'Identifier'
+        && node.callee.object.name === 'cy'
       ) {
-        return true;
+        return true
       }
 
-      return isRootCypress(node.callee.object);
-    };
+      return isRootCypress(node.callee.object)
+    }
 
     const hasChainedGet = (node) => {
       // Check if this node is a get() call
-      const isGetCall =
-        node.callee &&
-        node.callee.type === 'MemberExpression' &&
-        node.callee.property &&
-        node.callee.property.type === 'Identifier' &&
-        node.callee.property.name === 'get';
+      const isGetCall
+        = node.callee
+          && node.callee.type === 'MemberExpression'
+          && node.callee.property
+          && node.callee.property.type === 'Identifier'
+          && node.callee.property.name === 'get'
 
       if (!isGetCall) {
-        return false;
+        return false
       }
 
-      const obj = node.callee.object;
+      const obj = node.callee.object
 
       if (obj.type === 'CallExpression') {
-        const objCallee = obj.callee;
+        const objCallee = obj.callee
 
         if (
-          objCallee &&
-          objCallee.type === 'MemberExpression' &&
-          objCallee.property &&
-          objCallee.property.type === 'Identifier' &&
-          objCallee.property.name === 'get'
+          objCallee
+          && objCallee.type === 'MemberExpression'
+          && objCallee.property
+          && objCallee.property.type === 'Identifier'
+          && objCallee.property.name === 'get'
         ) {
-          return true;
+          return true
         }
 
-        return hasChainedGet(obj);
+        return hasChainedGet(obj)
       }
 
-      return false;
-    };
+      return false
+    }
 
     return {
       CallExpression(node) {
@@ -79,9 +79,9 @@ module.exports = {
           context.report({
             node,
             messageId: 'unexpected',
-          });
+          })
         }
       },
-    };
+    }
   },
-};
+}

package/lib/rules/no-debug.js

@@ -1,8 +1,8 @@
 'use strict'
 
-//------------------------------------------------------------------------------
+// ------------------------------------------------------------------------------
 // Rule Definition
-//------------------------------------------------------------------------------
+// ------------------------------------------------------------------------------
 
 module.exports = {
   meta: {
@@ -20,37 +20,36 @@ module.exports = {
     },
   },
 
-  create (context) {
-
+  create(context) {
     // variables should be defined here
 
-    //----------------------------------------------------------------------
+    // ----------------------------------------------------------------------
     // Helpers
-    //----------------------------------------------------------------------
-    function isCallingDebug (node) {
-      return node.callee &&
-        node.callee.property &&
-        node.callee.property.type === 'Identifier' &&
-        node.callee.property.name === 'debug'
+    // ----------------------------------------------------------------------
+    function isCallingDebug(node) {
+      return node.callee
+        && node.callee.property
+        && node.callee.property.type === 'Identifier'
+        && node.callee.property.name === 'debug'
     }
 
-    function isCypressCall (node) {
+    function isCypressCall(node) {
       if (!node.callee || node.callee.type !== 'MemberExpression') {
-        return false;
+        return false
       }
       if (node.callee.object.type === 'Identifier' && node.callee.object.name === 'cy') {
-        return true;
+        return true
       }
-      return isCypressCall(node.callee.object);
+      return isCypressCall(node.callee.object)
     }
-    
-    //----------------------------------------------------------------------
+
+    // ----------------------------------------------------------------------
     // Public
-    //----------------------------------------------------------------------
+    // ----------------------------------------------------------------------
 
     return {
 
-      CallExpression (node) {
+      CallExpression(node) {
         if (isCypressCall(node) && isCallingDebug(node)) {
           context.report({ node, messageId: 'unexpected' })
         }

package/lib/rules/no-force.js

@@ -1,8 +1,8 @@
 'use strict'
 
-//------------------------------------------------------------------------------
+// ------------------------------------------------------------------------------
 // Rule Definition
-//------------------------------------------------------------------------------
+// ------------------------------------------------------------------------------
 
 module.exports = {
   meta: {
@@ -20,39 +20,36 @@ module.exports = {
     },
   },
 
-  create (context) {
-
+  create(context) {
     // variables should be defined here
 
-    //----------------------------------------------------------------------
+    // ----------------------------------------------------------------------
     // Helpers
-    //----------------------------------------------------------------------
-    function isCallingClickOrType (node) {
+    // ----------------------------------------------------------------------
+    function isCallingClickOrType(node) {
       const allowedMethods = ['click', 'dblclick', 'type', 'trigger', 'check', 'rightclick', 'focus', 'select']
 
-      return node.property && node.property.type === 'Identifier' &&
-             allowedMethods.includes(node.property.name)
+      return node.property && node.property.type === 'Identifier'
+        && allowedMethods.includes(node.property.name)
     }
 
-    function isCypressCall (node) {
-      return node.callee.type === 'MemberExpression' &&
-        node.callee.object.type === 'Identifier' &&
-        node.callee.object.name === 'cy'
+    function isCypressCall(node) {
+      return node.callee.type === 'MemberExpression'
+        && node.callee.object.type === 'Identifier'
+        && node.callee.object.name === 'cy'
     }
 
-    function hasOptionForce (node) {
-
-      return node.arguments && node.arguments.length &&
-      node.arguments.some((arg) => {
-        return arg.type === 'ObjectExpression' && arg.properties.some((propNode) => propNode.key && propNode.key.name === 'force')
-      })
+    function hasOptionForce(node) {
+      return node.arguments && node.arguments.length
+        && node.arguments.some((arg) => {
+          return arg.type === 'ObjectExpression' && arg.properties.some((propNode) => propNode.key && propNode.key.name === 'force')
+        })
     }
 
-    function deepCheck (node, checkFunc) {
+    function deepCheck(node, checkFunc) {
       let currentNode = node
 
       while (currentNode.parent) {
-
         if (checkFunc(currentNode.parent)) {
           return true
         }
@@ -63,13 +60,13 @@ module.exports = {
       return false
     }
 
-    //----------------------------------------------------------------------
+    // ----------------------------------------------------------------------
     // Public
-    //----------------------------------------------------------------------
+    // ----------------------------------------------------------------------
 
     return {
 
-      CallExpression (node) {
+      CallExpression(node) {
         if (isCypressCall(node) && deepCheck(node, isCallingClickOrType) && deepCheck(node, hasOptionForce)) {
           context.report({ node, messageId: 'unexpected' })
         }

package/lib/rules/no-pause.js

@@ -1,8 +1,8 @@
 'use strict'
 
-//------------------------------------------------------------------------------
+// ------------------------------------------------------------------------------
 // Rule Definition
-//------------------------------------------------------------------------------
+// ------------------------------------------------------------------------------
 
 module.exports = {
   meta: {
@@ -20,37 +20,36 @@ module.exports = {
     },
   },
 
-  create (context) {
-
+  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 isCallingPause(node) {
+      return node.callee
+        && node.callee.property
+        && node.callee.property.type === 'Identifier'
+        && node.callee.property.name === 'pause'
     }
 
-    function isCypressCall (node) {
+    function isCypressCall(node) {
       if (!node.callee || node.callee.type !== 'MemberExpression') {
-        return false;
+        return false
       }
       if (node.callee.object.type === 'Identifier' && node.callee.object.name === 'cy') {
-        return true;
+        return true
       }
-      return isCypressCall(node.callee.object);
+      return isCypressCall(node.callee.object)
     }
-    
-    //----------------------------------------------------------------------
+
+    // ----------------------------------------------------------------------
     // Public
-    //----------------------------------------------------------------------
+    // ----------------------------------------------------------------------
 
     return {
 
-      CallExpression (node) {
+      CallExpression(node) {
         if (isCypressCall(node) && isCallingPause(node)) {
           context.report({ node, messageId: 'unexpected' })
         }

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

@@ -14,11 +14,11 @@ module.exports = {
       unexpected: 'Do not wait for arbitrary time periods',
     },
   },
-  create (context) {
+  create(context) {
     const sourceCode = context.sourceCode ?? context.getSourceCode()
 
     return {
-      CallExpression (node) {
+      CallExpression(node) {
         if (isCallingCyWait(node)) {
           const scope = sourceCode.getScope
             ? sourceCode.getScope(node)
@@ -33,7 +33,7 @@ module.exports = {
   },
 }
 
-function nodeIsCalledByCy (node) {
+function nodeIsCalledByCy(node) {
   if (node.type === 'Identifier' && node.name === 'cy') return true
 
   if (typeof node.callee === 'undefined' || typeof node.callee.object === 'undefined') {
@@ -43,20 +43,20 @@ function nodeIsCalledByCy (node) {
   return nodeIsCalledByCy(node.callee.object)
 }
 
-function isCallingCyWait (node) {
-  return node.callee.type === 'MemberExpression' &&
-         nodeIsCalledByCy(node) &&
-         node.callee.property.type === 'Identifier' &&
-         node.callee.property.name === 'wait'
+function isCallingCyWait(node) {
+  return node.callee.type === 'MemberExpression'
+    && nodeIsCalledByCy(node)
+    && node.callee.property.type === 'Identifier'
+    && node.callee.property.name === 'wait'
 }
 
-function isNumberArgument (node) {
-  return node.arguments.length > 0 &&
-         node.arguments[0].type === 'Literal' &&
-         typeof (node.arguments[0].value) === 'number'
+function isNumberArgument(node) {
+  return node.arguments.length > 0
+    && node.arguments[0].type === 'Literal'
+    && typeof (node.arguments[0].value) === 'number'
 }
 
-function isIdentifierNumberConstArgument (node, scope) {
+function isIdentifierNumberConstArgument(node, scope) {
   if (node.arguments.length === 0) return false
 
   if (node.arguments[0].type !== 'Identifier') return false