chore: Eslint migration foundation + migrate npm/grep package #32046

cacieprins · 2025-07-17T13:26:59Z

Additional details

This is a pared down PR related to #30892

It includes:

The new shared eslint config
A migration guide, including troubleshooting steps discovered while migrating npm/grep
An example migration in ./npm/grep

Steps to test

How has the user experience changed?

PR Tasks

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

jennifer-shehane · 2025-07-17T14:03:10Z

@MikeMcC399 Might be curious to get your eyes on this (if you have time), since you've been handling eslint config in the other repos so nicely. Particularly the guide outline.

cypress · 2025-07-17T14:10:40Z

cypress Run #64013

Run Properties: Failed #64013 • 09a88ac975: fix linting of primary eslint config pkg

Project	`cypress`
Branch Review	`eslint-migration-foundation`
Run status	`Failed #64013`
Run duration	`46m 55s`
Commit	`09a88ac975: fix linting of primary eslint config pkg`
Committer	`Cacie Prins`
View all properties for this run ↗︎

Test results
Failures	`1`
Flaky	`13`
Pending	`1233`
Skipped	`0`
Passing	`32048`
View all changes introduced in this branch ↗︎

UI Coverage `45.83%`
Untested elements	`190`
Tested elements	`165`

Accessibility `97.95%`
Failed rules	`3 critical` `8 serious` `2 moderate` `2 minor`
Failed elements	`107`

Tests for review

cypress/e2e/studio/studio-cloud.cy.ts • 1 failed test • app-e2e

View Output

Test		Artifacts
Studio Cloud > opens a cloud studio session with AI marked as coming soon		`Test Replay` `Screenshots`

issues/28527.cy.ts • 1 flaky test • 5x-driver-electron

View Output

Test		Artifacts
issue 28527 > fails and then retries and verifies about:blank is not displayed		`Test Replay` `Screenshots`

commands/waiting.cy.js • 1 flaky test • 5x-driver-chrome

View Output

Test		Artifacts
... > errors > throws when waiting for 1st response to bar		`Test Replay`

issues/28527.cy.ts • 1 flaky test • 5x-driver-chrome

View Output

Test		Artifacts
issue 28527 > fails and then retries and verifies about:blank is not displayed		`Test Replay` `Screenshots`

commands/net_stubbing.cy.ts • 1 flaky test • 5x-driver-chrome:beta

View Output

Test		Artifacts
... > stops waiting when an fetch request is canceled		`Test Replay`

e2e/e2e_cookies.cy.js • 1 flaky test • 5x-driver-chrome:beta

View Output

Test		Artifacts
e2e cookies spec > __Host- prefix > can set __Host- cookie		`Test Replay`

The first 5 flaky specs are shown, see all 13 specs in Cypress Cloud.

MikeMcC399 · 2025-07-18T07:29:20Z

guides/eslint-migration.md

+
+**After ESLint 9.x:**
+```json
+"lint": "eslint ."


The . is also no longer needed. See https://eslint.org/docs/latest/use/command-line-interface

MikeMcC399 · 2025-07-18T07:45:29Z

packages/eslint-config/package.json

+    "@typescript-eslint/parser": "7.2.0",
+    "eslint": "^9.18.0",
+    "eslint-import-resolver-typescript": "3.8.2",
+    "eslint-plugin-cypress": "^4.1.0",


If you are only working with ESLint 9.x flat configuration, then you should upgrade to "eslint-plugin-cypress": "^5.1.0"

The 4.x version is no longer maintained.

MikeMcC399 · 2025-07-18T07:47:23Z

packages/eslint-config/package.json

+    "eslint-import-resolver-typescript": "3.8.2",
+    "eslint-plugin-cypress": "^4.1.0",
+    "eslint-plugin-import-x": "^4.6.1",
+    "eslint-plugin-mocha": "^10.5.0",


Consider upgrading to eslint-plugin-mocha@11

MikeMcC399 · 2025-07-18T07:49:22Z

@jennifer-shehane

Might be curious to get your eyes on this (if you have time), since you've been handling eslint config in the other repos so nicely. Particularly the guide outline.

I only have some general comments:

It's good to see a staged approach!
If updates to @cypress/eslint-plugin-dev are no longer to be published to the npm registry, then the other repos using this module would need an alternate strategy for linting:
I would recommend using the latest eslint@9 version, currently v9.31.0 (see https://eslint.org/). ESLint is continually making improvements that also affect ease-of-use and configuration.
Some of the other dependencies are outdated (like eslint-plugin-cypress@4). Use latest versions unless there are compatibility issues preventing this.

cacieprins · 2025-07-18T15:18:20Z

@MikeMcC399 Thank you so much for the feedback!

guides/eslint-migration.md

cacieprins · 2025-07-18T15:21:15Z

@MikeMcC399 I'm considering whether, after the migration in this repo, switching eslint-config out to the npm package as a major version upgrade. It's not right now to allow for a progressive migration in this repo, though. Thanks for bringing that up!

AtofStryker · 2025-07-21T19:57:15Z

npm/grep/cypress/tsconfig.json

  },
-  "include": ["e2e/**/*.ts"]
+  "include": [
+    "**/*.ts",


Do you remember why we needed to touch the tsconfig here?

AtofStryker · 2025-07-21T19:57:56Z

npm/grep/src/utils.js

@@ -132,8 +132,6 @@ function shouldTestRunTitle (parsedGrep, testName) {
  }

  if (!Array.isArray(parsedGrep)) {
-    console.error('Invalid parsed title grep')


why did we omit these errors? I think they are part of the source and we likely want to maintain the code here

think that was a --fix - before I turned no-console off for this pkg

AtofStryker · 2025-07-21T20:01:29Z

packages/eslint-config/package.json

+    "lint": "eslint"
+  },
+  "dependencies": {
+    "jiti": "^2.4.2"


is jiti a peer dependency or something that we need to include here?

jiti is a dependency of eslint one of these eslint plugins, but a few dependencies of frontend-shared depend on an older version of jiti. Yarn doesn't install the version that one of the eslint pugins here needs, so node uses thet older version of jiti via hoisting. Declaring it here prevents it from using the hoisted version.

AtofStryker · 2025-07-21T20:03:27Z

packages/eslint-config/src/baseConfig.ts

+
+  {
+    // rules that are gold standard, but have many violations
+    // these are off while developing eslint, but should eventually be enabled


in other words we need to disable these rules temporarily because there is an overwhelming amount of errors?

yep, they're not currently rules that are applied to the project, but ones that would be good to turn on.

… from eslint-config

cursor

Bug: Invalid Glob Pattern Causes Incorrect File Exclusion

The lint-staged glob pattern **/[!npm/{grep}]/**/*.{js,jsx,ts,tsx,json,eslintrc,vue} is invalid. The [!npm/{grep}] syntax is a character class negation, matching single characters, not the npm/grep directory path. This prevents files within npm/grep from being correctly excluded from linting, potentially applying incorrect ESLint configurations or causing unexpected behavior. The pattern should use proper glob negation (e.g., !npm/grep/** or !(npm/grep)/**).

package.json#L268-L271

cypress/package.json

Lines 268 to 271 in 09a88ac

    
           "*.coffee": "yarn stop-only --folder", 
        
           "npm/{grep}/**/*.{js,jsx,ts,tsx}": "yarn lint:fix", 
        
           "**/[!npm/{grep}]/**/*.{js,jsx,ts,tsx,json,eslintrc,vue}": "eslint --fix", 
        
           "*workflows.yml": "node scripts/format-workflow-file.js"

Fix in Cursor • Fix in Web

Bug: Debugging Statements Removed by ESLint

Two console.error statements, intended for debugging invalid parsed grep input by logging "Invalid parsed title grep" and the parsedGrep object, were unintentionally removed. This occurred due to eslint --fix running before the no-console rule was properly configured for the package.

npm/grep/src/utils.js#L134-L136

cypress/npm/grep/src/utils.js

Lines 134 to 136 in 09a88ac

    
           if (!Array.isArray(parsedGrep)) { 
        
             console.error('Invalid parsed title grep') 
        
             console.error(parsedGrep)

Fix in Cursor • Fix in Web

Was this report helpful? Give feedback by reacting with 👍 or 👎

cacieprins added 3 commits July 16, 2025 16:33

foundational monorepo pkg for shared eslint config

045ea2e

add a migration guide

028dc0f

adds new eslint to grep

923f770

cacieprins force-pushed the eslint-migration-foundation branch from 5c327f5 to 831af8d Compare July 17, 2025 13:28

add troubleshooting guide

8c27e00

cacieprins force-pushed the eslint-migration-foundation branch from 831af8d to 8c27e00 Compare July 17, 2025 13:29

jennifer-shehane assigned cacieprins Jul 17, 2025

MikeMcC399 reviewed Jul 18, 2025

View reviewed changes

MikeMcC399 mentioned this pull request Jul 18, 2025

Remove dependency on ESLint v8 (EOL) #30386

Open

Merge branch 'develop' into eslint-migration-foundation

26df718

jennifer-shehane changed the title ~~chore: Eslint migration foundation~~ chore: Eslint migration foundation + migrate npm/grep package Jul 18, 2025

cacieprins added 2 commits July 18, 2025 09:54

fix eslint config jiti issue

ecb9b16

fix a bit

bec2718

This comment was marked as outdated.

Sign in to view

cacieprins commented Jul 18, 2025

View reviewed changes

guides/eslint-migration.md Outdated Show resolved Hide resolved

Update guides/eslint-migration.md

4d0e588

AtofStryker reviewed Jul 21, 2025

View reviewed changes

restore console.error to grep, export collection of cli related rules…

abb7d13

… from eslint-config

This comment was marked as outdated.

Sign in to view

cacieprins and others added 2 commits July 22, 2025 14:16

Merge branch 'develop' into eslint-migration-foundation

dc67077

fix linting of primary eslint config pkg

09a88ac

cursor bot reviewed Jul 22, 2025

View reviewed changes

	"*.coffee": "yarn stop-only --folder",
	"npm/{grep}/*/.{js,jsx,ts,tsx}": "yarn lint:fix",
	"/[!npm/{grep}]//*.{js,jsx,ts,tsx,json,eslintrc,vue}": "eslint --fix",
	"*workflows.yml": "node scripts/format-workflow-file.js"

	if (!Array.isArray(parsedGrep)) {
	console.error('Invalid parsed title grep')
	console.error(parsedGrep)

chore: Eslint migration foundation + migrate npm/grep package #32046

Are you sure you want to change the base?

chore: Eslint migration foundation + migrate npm/grep package #32046

Uh oh!

Conversation

cacieprins commented Jul 17, 2025

Additional details

Steps to test

How has the user experience changed?

PR Tasks

Uh oh!

jennifer-shehane commented Jul 17, 2025

Uh oh!

cypress bot commented Jul 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Tests for review

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MikeMcC399 commented Jul 18, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

cacieprins commented Jul 18, 2025

Uh oh!

Uh oh!

cacieprins commented Jul 18, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cacieprins Jul 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cacieprins Jul 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment was marked as outdated.

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Bug: Invalid Glob Pattern Causes Incorrect File Exclusion

Bug: Debugging Statements Removed by ESLint

Uh oh!

Uh oh!

cypress bot commented Jul 17, 2025 •

edited

Loading

cacieprins Jul 22, 2025 •

edited

Loading

cacieprins Jul 22, 2025 •

edited

Loading