Swap to fork of eslint-plugin-cypress, add missing recommended rule
#106
Conversation
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
🦋 Changeset detectedLatest commit: f866067 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
jahredhope
reviewed
May 25, 2023
jahredhope
reviewed
May 25, 2023
mrm007
approved these changes
May 25, 2023
Co-authored-by: Remus Mate <rmate@seek.com.au>
Merged
72636c
added a commit
that referenced
this pull request
Apr 22, 2024
I noticed that they cut a new release, is this sufficient for us to revert back? https://github.com/cypress-io/eslint-plugin-cypress/releases/tag/v3.0.0 See #106 and #111 for historical context.
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.
eslint-plugin-cypressdoesn't support ESLint v8. There is an issue for this on the repo with no activity. There is a plan to uplift and move the package into cypress' monorepo, however there has been no movement on that issue for some months.Since most users of cypress will likely be using cypress alongside a
skuapp, this has forcedskuto stay on ESLint v7. We would like to update sku to use ESLint v8, and luckily for us there is a fork ofeslint-plugin-cypressthat supports it. Unfortunately, that package too hasn't been updated for a few months, and it is missing one of the recommended rules provided by the originaleslint-plugin-cypress. I have made a PR to add this missing rule.In the meantime (either until the original package is updated/moved, or the fork is updated), in order to enable
skuto update to ESLint v8, without dropping support for an existing lint rule, I've done two things:eslint-plugin-cypressfork@finsit/eslint-plugin-cypresseslint-plugin-cypressand exposed it from this package viaeslint-plugin-local-rules. This was the simplest way I found to expose a rule from a plugin without having to create and publish a separate package (e.g.eslint-plugin-seek). Since this rule hopefully won't stick around for too long, I opted for this solution rather than creating a package for the rule.I've added a note to the changeset for consumers that are overriding cypress rules mentioning that they need to update the references to those rules. I'm not considering this a breaking change since this config is usually not consumed directly but rather via a framework tool as sku or skuba.
EDIT: Another option could have been to make our own fork or
eslint-plugin-cypress. However, since the use of a fork is hopefully going to be temporary, it didn't feel worth the effort to fork the repo, set up CI, deploy a package, and add the new rule, when it was easy enough to get the rule working in this repo.