feat: support chains started of helper functions in unsafe-to-chain-command#307
Open
MgmClientGuy0 wants to merge 7 commits intocypress-io:masterfrom
Open
feat: support chains started of helper functions in unsafe-to-chain-command#307MgmClientGuy0 wants to merge 7 commits intocypress-io:masterfrom
MgmClientGuy0 wants to merge 7 commits intocypress-io:masterfrom
Conversation
|
b72e502 to
a49261b
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hi, this is a bit bigger PR, but I tried to keep it as minimal as possible without sacrificing documentation or tests.
Problem
Most rules (including unsafe-to-chain-command) check whether or not the expression they want to lint was started from a identifier called 'cy'. This fails if the chain was started somewhere else, e.g. from a helper function. The following code is invalid since two actions are chained, but it is not flagged.
typescript-eslint
The only way of reliably detecting whether or not it is a Cypress chain is to check the return type of the helper function. With JS alone, this is not possible, especially if the function was imported from another file. ESLint only lints one file at a time and we need the whole project as context. The "typescript-eslint' parser changes that.
Since this is the first time support for 'typescript-eslint' is introduced, maybe some pros and cons:
Pros
Cons
Implementation
Let me know if you have questions.