-
Notifications
You must be signed in to change notification settings - Fork 89
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Add 'unsafe-to-chain-command' rule
- Loading branch information
1 parent
874c51f
commit bf6a75d
Showing
4 changed files
with
71 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
## Unsafe to chain command | ||
|
||
See [retry-ability guide](https://docs.cypress.io/guides/core-concepts/retry-ability#Actions-should-be-at-the-end-of-chains-not-the-middle). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
'use strict' | ||
|
||
module.exports = { | ||
meta: { | ||
docs: { | ||
description: 'Actions should be in the end of chains, not in the middle', | ||
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', | ||
}, | ||
schema: [], | ||
messages: { | ||
unexpected: 'It is unsafe to chain further commands that rely on the subject after this command. It is best to split the chain, chaining again from `cy.` in a next command line.', | ||
}, | ||
}, | ||
create (context) { | ||
return { | ||
CallExpression (node) { | ||
if (isRootCypress(node) && isActionUnsafeToChain(node) && node.parent.type === 'MemberExpression') { | ||
context.report({ node, messageId: 'unexpected' }) | ||
} | ||
}, | ||
} | ||
}, | ||
} | ||
|
||
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') { | ||
return true | ||
} | ||
|
||
node = node.callee.object | ||
} | ||
|
||
return false | ||
} | ||
|
||
function isActionUnsafeToChain (node) { | ||
// commands listed in the documentation with text: 'It is unsafe to chain further commands that rely on the subject after xxx' | ||
const unsafeToChainActions = ['blur', 'clear', 'click', 'check', 'dblclick', 'each', 'focus', 'rightclick', 'screenshot', 'scrollIntoView', 'scrollTo', 'select', 'selectFile', 'spread', 'submit', 'type', 'trigger', 'uncheck', 'wait', 'within'] | ||
|
||
return node.callee && node.callee.property && node.callee.property.type === 'Identifier' && unsafeToChainActions.includes(node.callee.property.name) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
'use strict' | ||
|
||
const rule = require('../../../lib/rules/unsafe-to-chain-command') | ||
const RuleTester = require('eslint').RuleTester | ||
|
||
const ruleTester = new RuleTester() | ||
|
||
const errors = [{ messageId: 'unexpected' }] | ||
const parserOptions = { ecmaVersion: 6 } | ||
|
||
ruleTester.run('action-ends-chain', rule, { | ||
valid: [ | ||
{ 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 }, | ||
], | ||
|
||
invalid: [ | ||
{ code: 'cy.get("new-todo").type("todo A{enter}").should("have.class", "active");', parserOptions, errors }, | ||
{ code: 'cy.get("new-todo").type("todo A{enter}").type("todo B{enter}");', parserOptions, errors }, | ||
], | ||
}) |