chore: update eslint from version 7 to version 8

[AtofStryker]

• Closes Update Cypress repo to Eslint version 8 and have @cypress/eslint-plugin-dev support eslint v8 #29354

Additional details

This PR gets the monorepo on eslint v8 from v7. Because we leverage @cypress/eslint-plugin-dev quite heavily, we also needed to update @cypress/eslint-plugin-dev to support eslint version 8 and up, which is a breaking change to @cypress/eslint-plugin-dev .

Also, since eslint-plugin-json-format is no longer maintained and uses the old babel-eslint parser, I have migrated us to eslint-plugin-jsonc which is actively maintained. eslint-plugin-json-format doesn't actually have a dependency on babel-eslint, it was just a red herring of an error when trying to lint one of the system tests that is using an outdated version (intentionally) of vue-eslint-parser. I have correctly configured eslint-plugin-json-format in the repo and linted all package.json files in sub packages, which was not working correctly before.

Currently, with our release process, it is very difficult to release a standalone npm package as breaking while there are other changes inside the monorepo, which will also be flagged as breaking.

My recommendation is we merge this in as a chore, which will NOT trigger a release of @cypress/eslint-plugin-dev, and have a follow up PR that is breaking and only includes changes in the @cypress/eslint-plugin-dev directory, mainly the changelog and referencing the correct merged commit so we can easily release @cypress/eslint-plugin-dev 6.x.x

Steps to test

run yarn lint in the repo, as well as the tests inside @cypress/eslint-plugin-dev to make sure everything works correctly

Steps to review

There are quite a few changes in this PR, so I have squashed them down to two major things

1. the updaing of eslint-plugin-dev which can be seen in the first commit. This is the bulk of important changes 309ee08
2. the removal of eslint-plugin-json-format from the repo and the plugin and using eslint-plugin-jsonc, which changes a lot of the references in the repo. This looks like much, but most of the changes are the same. I have elected to lint the tsconfig and removed lock files from the eslint ignore since eslint-plugin-json-format does not try to lint those files by default. 2a9c95f Correctly configure eslint-plugin-json-format for use in the repo with eslint 8 and lint files that were not previously being linted correctly by the plugin 118bae2

How has the user experience changed?

mono repo users will now be on eslint v8 and opens the door to support Eslint v8 inside eslint-plugin-cypress if we still use @cypress/eslint-plugin-dev inside eslint-plugin-cypress . @MikeMcC399 is working on a PR to remove @cypress/eslint-plugin-dev (see cypress-io/eslint-plugin-cypress#177) from eslint-plugin-cypress, which is the correct direction. In the future, we might not need this plugin any longer as most the rules look to be supported OOTB from eslint-plugin-mocha (a decision to be made later).

PR Tasks

• Have tests been added/updated?
• Has a PR for user-facing changes been opened in cypress-documentation?
• Have API changes been updated in the type definitions?

[AtofStryker]

cc @MikeMcC399

[cypress]

1 flaky test on run #55197 ↗︎

0

230

4

0

1

Details:

properly support no duplicate imports
Project: cypress	Commit: e6e262ff52
Status: Passed	Duration: 11:27 💡
Started: Apr 26, 2024 6:35 PM	Ended: Apr 26, 2024 6:46 PM

  cypress/e2e/project-setup.cy.ts • 1 flaky test • launchpad-e2e

View Output

Test		Artifacts
... > can skip setup CT testing for an E2E project		Test Replay Screenshots

Review all test suite changes for PR #29355 ↗︎

[MikeMcC399]

@AtofStryker

Thanks for the cc: !

mono repo users will now be on eslint v8 and opens the door to support Eslint v8 inside eslint-plugin-cypress

• eslint-plugin-cypress needs to migrate to ESLint 9.x, the current latest version released on Apr 5, 2024. See Support ESLint 9 eslint-plugin-cypress#155, so although migrating @cypress/eslint-plugin-dev to ESLint 8.x is surely a necessity for its usage in other repos, it would not fulfil the needs of eslint-plugin-cypress moving forward. I have proposed in Migrate from @cypress/eslint-plugin-dev to supported plugins eslint-plugin-cypress#174 to use instead the set of linters recommended by ESLint for eslint-plugins as detailed in the ESLint documentation section Linting a Plugin. These fully support ESLint 7.x, 8.x and 9.x already.

[MikeMcC399]

I'm not sure about the compatibility advice!

I doubt if you have ESLint 9 compatibility set up, which requires flat files, and I don't know that getting involved with ESLint 6 and below is still worthwhile, so that would reduce to:

⚠️ Currently does not support ESLint version 9
For Eslint 8, use version 6.x.x
For Eslint 7, use version 5.x.x

[AtofStryker]

I would also think that is true too. I will update the readme!

[MikeMcC399]

@AtofStryker FYI

• refactor: migrate internal linting to recommended plugins eslint-plugin-cypress#177 is now merged, so the dependency of cypress-io/eslint-plugin-cypress on @cypress/eslint-plugin-dev no longer exists. The final dependency before transition was "@cypress/eslint-plugin-dev": "3.9.1".

[jennifer-shehane]

@AtofStryker The intention of the original json linter was to lint our package.json files to ensure they are formatted correctly and that all packages are listed alphabetically. I see that this behavior is lost with these changes.

This branch (no suggestions or fixing on save)

develop (auto fixes and alphabetizes on save)

[AtofStryker]

@AtofStryker The intention of the original json linter was to lint our package.json files to ensure they are formatted correctly and that all packages are listed alphabetically. I see that this behavior is lost with these changes.

This branch (no suggestions or fixing on save)

develop (auto fixes and alphabetizes on save)

ah I see! I only checked for syntax corrections when doing the move over. I think we can still use eslint-plugin-json-format I just needed to tune a few things in the config. It doesn't look like the sorting or linting was fulling running on the packages, so I configured it to run on all sub packages and lint the json files in 118bae2. This keeps the old plugin and reduces the scope of changes, which is a great thing!

Going to see if there are issues in CI then will update the description and request a re review

[mschile]

Does this mean duplicate imports are now allowed? I added a duplicate import to a file and yarn lint passed.

[AtofStryker]

weird the rule was renamed. I'll double check and make sure I implemented it correctly

[AtofStryker]

OK I see what happened. so the rule was deprecated for import/no-duplicates which we have set to off but we really should have it turned on. However, the rule comes from import/no-duplicates which was referenced in @cypress/eslint-plugin-dev but not installed or configured (likely resolved from the root of the monorepo). I added the dependency to the package and configured the plugin correctly, so the linting rules for duplicate imports should now work correctly. done in e6e262f

[cypress-bot]

Released in 13.9.0.

This comment thread has been locked. If you are still experiencing this issue after upgrading to
Cypress v13.9.0, please open a new issue.