chore: improve linting

[flotwig]

• For cypress-io/cypress-internal#513

User facing changelog

Additional details

• Simplifies linting a few ways:
  • Removes eslintrc config that duplicates already-extended eslintrc config
  • Removes "extends" that are implicit (eslint always extends from all eslintrcs in the parent list)
  • Removes globally-defined rules that are only applicable in a few specific places
  • Remove some redundant eslint-ignore-next-lines
  • See eslint docs for info on why this is possible: https://eslint.org/docs/latest/user-guide/configuring/configuration-files#cascading-and-hierarchy
• Corrects a few common linting issues:
  • "no-unused-vars: off" is present in a lot of our rules. I've removed most of these and fixed the errors that arose.
  • Some packages had .eslintrc but no yarn lint command, meaning linting only happened in the IDE, not in CI. Fixed this where needed.
• Also removes an unused jscodeshift dep/script
• Future PRs will further unify the eslintrcs to extend from a few common base scenarios.

Steps to test

How has the user experience changed?

PR Tasks

• Have tests been added/updated?
• [na] Has the original issue (or this PR, if no issue exists) been tagged with a release in ZenHub? (user-facing changes only)
• [na] Has a PR for user-facing changes been opened in cypress-documentation?
• [na] Have API changes been updated in the type definitions?

[cypress-bot]

Thanks for taking the time to open a PR!

• Create a Draft Pull Request if your PR is not ready for review. Mark the PR as Ready for Review when you're ready for a Cypress team member to review the PR.
• Become familiar with the Code Review Checklist for guidelines on coding standards and what needs to be done before a PR can be merged.

[cypress]

---

Test summary

26392 • 0 • 1179 • 0 • 30

---

Run details

Project	cypress
Status	Passed
Commit	9590db3
Started	Dec 29, 2022 4:48 PM
Ended	Dec 29, 2022 5:06 PM
Duration	18:18 💡
OS	Linux Debian -
Browser	Multiple

View run in Cypress Dashboard ➡️

---

Flakiness

	create-from-component.cy.ts		1
1	... > runs generated spec
	runner/reporter-ct-vite.errors.cy.ts		1
1	Vite - errors ui > cy.readFile
	commands/net_stubbing.cy.ts		3
1	network stubbing > intercepting request > can delay and throttle a StaticResponse
2	network stubbing > intercepting request > can delay and throttle a StaticResponse
3	network stubbing > intercepting request > can delay and throttle a StaticResponse
This comment includes only the first 5 flaky tests. See all 30 flaky tests in the Cypress Dashboard.

---

This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard

[flotwig]

I'm not totally sure what the right thing to do here is, I made this change to fix the lint error from no-unused-vars but this doesn't look exactly right. Should E on line 14 extend Subject instead of HTMLElement? @jordanpowell88 any ideas?

[lmiller1990]

Doe we need Chainable to have Subject? We might be able to omit it. Should it just be

declare namespace Cypress {
  interface Chainable {
    /**
    * Get one or more DOM elements by an XPath selector.
    * **Note:** you can test XPath expressions from DevTools console using $x(...) function, for example $x('//div') to find all divs.
    * @see https://github.com/cypress-io/cypress-xpath
    * @example
    * cy.xpath(`//ul[@class="todo-list"]//li`)
    *   .should('have.length', 3)
    */
    xpath<E extends Node = HTMLElement>(selector: string, options?: Partial<Loggable & Timeoutable>): Chainable<JQuery<E>>
  }
}

[lmiller1990]

We have some examples in the docs that don't pass Subject to Chainable: https://docs.cypress.io/guides/tooling/typescript-support#Types-for-Custom-Commands

[flotwig]

Removing these 3 historical deps got rid of 249 transitive dependencies and 74 MB:

Before:

~ echo **/node_modules/* | wc -w
7371
~ du -c -B M **/node_modules/*
...
2792M   total

After:

~ echo **/node_modules/* | wc -w
7122
~ du -c -B M **/node_modules/*
...
2718M   total

[lmiller1990]

Nice!

I wonder if there's a tool we can use to detect unused dependencies and prune more?

[flotwig]

Yeah, it's called depcheck: https://github.com/depcheck/depcheck I want to add this to the repo at some point for sure.

[lmiller1990]

Code seems fine. I tried doing yarn lint-changed but I got a strange error:

$ yarn lint-changed                                            simplify-linting
yarn run v1.22.11
$ lint-changed

Oops! Something went wrong! :(

ESLint: 7.22.0

Error: 'patterns' must be a non-empty string or an array of non-empty strings
    at ESLint.lintFiles (/home/lachlan/code/work/dev/node_modules/eslint/lib/eslint/eslint.js:524:19)
    at Object.execute (/home/lachlan/code/work/dev/node_modules/eslint/lib/cli.js:296:36)
    at main (/home/lachlan/code/work/dev/node_modules/eslint/bin/eslint.js:142:52)
    at Object.<anonymous> (/home/lachlan/code/work/dev/node_modules/eslint/bin/eslint.js:146:2)
    at Module._compile (node:internal/modules/cjs/loader:1155:14)
    at Object.Module._extensions..js (node:internal/modules/cjs/loader:1209:10)
    at Module.load (node:internal/modules/cjs/loader:1033:32)
    at Function.Module._load (node:internal/modules/cjs/loader:868:12)
    at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:81:12)
    at node:internal/main/run_main_module:22:47
error Command failed with exit code 1.

I'm not sure if this ever worked, though, or if anyone uses it. The pre-commit lint hook still works fine, I tested it out.

[lmiller1990]

Nice!

I wonder if there's a tool we can use to detect unused dependencies and prune more?

[flotwig]

I'm not sure if this ever worked, though, or if anyone uses it. The pre-commit lint hook still works fine, I tested it out.

@lmiller1990 It seems broken in develop too. I opened a PR here to remove it, since lint-staged covers the functionality: #25308