refactor: Unify eslint config, convert to flat configs and update plugins (WIP)

.circleci/workflows.yml

@@ -2319,14 +2319,6 @@ jobs:
           path: npm/grep/test_results
       - store-npm-logs
 
-  npm-eslint-plugin-dev:
-    <<: *defaults
-    steps:
-      - restore_cached_workspace
-      - run:
-          name: Run tests
-          command: yarn workspace @cypress/eslint-plugin-dev test
-
   npm-cypress-schematic:
     <<: *defaults
     steps:
@@ -3013,9 +3005,6 @@ linux-x64-workflow: &linux-x64-workflow
     - npm-mount-utils:
         requires:
           - build
-    - npm-eslint-plugin-dev:
-        requires:
-          - build
     - npm-cypress-schematic:
         requires:
           - build
@@ -3028,7 +3017,6 @@ linux-x64-workflow: &linux-x64-workflow
         requires:
           - check-ts
           - npm-angular
-          - npm-eslint-plugin-dev
           - npm-puppeteer-unit-tests
           - npm-puppeteer-cypress-tests
           - npm-react
@@ -3384,9 +3372,6 @@ linux-x64-contributor-workflow: &linux-x64-contributor-workflow
     - npm-mount-utils:
         requires:
           - build
-    - npm-eslint-plugin-dev:
-        requires:
-          - build
     - npm-cypress-schematic:
         requires:
           - build
@@ -3398,7 +3383,6 @@ linux-x64-contributor-workflow: &linux-x64-contributor-workflow
         requires:
           - check-ts
           - npm-angular
-          - npm-eslint-plugin-dev
           - npm-puppeteer-unit-tests
           - npm-puppeteer-cypress-tests
           - npm-react

CONTRIBUTING.md

@@ -182,7 +182,6 @@ Here is a list of the npm packages in this repository:
  | Folder Name                                            | Package Name                       | Purpose                                                                      |
  | :----------------------------------------------------- | :--------------------------------- | :--------------------------------------------------------------------------- |
  | [angular](./npm/angular)                               | `@cypress/angular`                   | Cypress component testing for Angular.     |
- | [eslint-plugin-dev](./npm/eslint-plugin-dev)           | `@cypress/eslint-plugin-dev`       | Eslint plugin for internal development.          |
  | [grep](./npm/grep)                                       | `@cypress/grep`                     | Filter tests using substring                        |
  | [mount-utils](./npm/mount-utils)                       | `@cypress/mount-utils`             | Common functionality for Vue/React/Angular adapters. |
  | [react](./npm/react)                                   | `@cypress/react`                   | Cypress component testing for React.             |
@@ -341,8 +340,7 @@ Many Cypress packages print out debugging information to console via the `debug`
 
 ### Coding Style
 
-We use [eslint](https://eslint.org/) to lint all JavaScript code and follow rules specified in
-[@cypress/eslint-plugin-dev](./npm/eslint-plugin-dev) plugin.
+We use [eslint](https://eslint.org/) to lint all JavaScript code.
 
 This project uses a Git pre-commit hook to lint staged files before committing. See the [`lint-staged` project](https://github.com/okonet/lint-staged) for details.
 `lint-staged` will try to auto-fix any lint errors with `eslint --fix`, so if it fails, you must manually fix the lint errors before committing.

cli/eslint.config.ts

@@ -0,0 +1,62 @@
+/*
+{
+  "rules": {
+    "no-restricted-syntax": [
+      "error",
+      {
+        "selector": "CallExpression[callee.name='arch']",
+        "message": "Do not use `arch()` to detect the user's machine architecture. Use util.getRealArch() instead."
+      },
+      {
+        "selector": "CallExpression[callee.object.name='os'][callee.property.name='arch']",
+        "message": "Do not use `os.arch()` to detect the user's machine architecture. Use util.getRealArch() instead."
+      },
+      {
+        "selector": "MemberExpression[object.name='process'][property.name='arch']",
+        "message": "Do not use `process.arch` to detect the user's machine architecture. Use util.getRealArch() instead."
+      }
+    ]
+  }
+}
+*/
+import path from 'path'
+import { baseConfig } from '../eslint.config'
+import globals from 'globals'
+
+export default [
+  ...baseConfig,
+  {
+    files: ['**/*.{ts,js}'],
+    languageOptions: {
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: path.join(__dirname, '../packages/ts/tsconfig.json'),
+      },
+      globals: {
+        ...globals.node,
+      },
+    },
+  },
+  {
+    ignores: [
+      '__snapshots__/**/*',
+      'angular/**/*',
+      'build/**/*',
+      'mount-utils/**/*',
+      'node_modules/**/*',
+      'react/**/*',
+      'svelte/**/*',
+      'vue/**/*',
+      'types/**/*',
+    ],
+  },
+  {
+    files: ['test/**/*.{ts,js}'],
+    languageOptions: {
+      globals: {
+        sinon: 'readonly',
+        lib: 'readonly',
+      },
+    },
+  },
+]

cli/lib/util.js

@@ -467,7 +467,7 @@ const util = {
 
     async function _getRealArch () {
       const osPlatform = os.platform()
-      // eslint-disable-next-line no-restricted-syntax
+
       const osArch = os.arch()
 
       debug('detecting arch %o', { osPlatform, osArch })
@@ -492,7 +492,6 @@ const util = {
         if (['aarch64_be', 'aarch64', 'armv8b', 'armv8l'].includes(stdout)) return 'arm64'
       }
 
-      // eslint-disable-next-line no-restricted-syntax
       const pkgArch = arch()
 
       if (pkgArch === 'x86') return 'ia32'

cli/package.json

@@ -8,7 +8,7 @@
     "clean": "node ./scripts/clean.js",
     "dtslint": "dtslint types",
     "postinstall": "patch-package && node ./scripts/post-install.js",
-    "lint": "eslint --ext .js,.jsx,.ts,.tsx,.json,.vue .",
+    "lint": "eslint .",
     "prebuild": "yarn postinstall && node ./scripts/start-build.js",
     "size": "t=\"cypress-v0.0.0.tgz\"; yarn pack --filename \"${t}\"; wc -c \"${t}\"; tar tvf \"${t}\"; rm \"${t}\";",
     "test": "yarn test-unit",

cli/scripts/clean.js

@@ -2,10 +2,12 @@ const fs = require('fs-extra')
 const path = require('path')
 const { includeTypes } = require('./utils')
 
+// eslint-disable-next-line no-restricted-syntax
 fs.removeSync(path.join(__dirname, '..', 'build'))
 
 includeTypes.forEach((folder) => {
   try {
+    // eslint-disable-next-line no-restricted-syntax
     fs.removeSync(path.join(__dirname, '..', 'types', folder))
   } catch (e) {
     //

cli/scripts/post-install.js

@@ -19,12 +19,13 @@ shell.set('-e') // any error is fatal
 // This ensures that globals like Cypress.$, Cypress._ etc are property typed
 // yet we do not install "@types/.." packages with "npm install cypress"
 // because they can conflict with user's own libraries
-
+// eslint-disable-next-line no-restricted-syntax
 fs.ensureDirSync(join(__dirname, '..', 'types'))
 
 includeTypes.forEach((folder) => {
   const source = resolvePkg(`@types/${folder}`, { cwd: __dirname })
 
+  // eslint-disable-next-line no-restricted-syntax
   fs.copySync(source, join(__dirname, '..', 'types', folder))
 })
 
@@ -75,6 +76,7 @@ shell.sed('-i', 'from \'sinon\';', 'from \'../sinon\';', sinonChaiFilename)
 
 // copy experimental network stubbing type definitions
 // so users can import: `import 'cypress/types/net-stubbing'`
+// eslint-disable-next-line no-restricted-syntax
 fs.copySync(resolvePkg('@packages/net-stubbing/lib/external-types.ts'), 'types/net-stubbing.d.ts')
 
 // https://github.com/cypress-io/cypress/issues/18069
@@ -90,11 +92,13 @@ const filesToUncomment = [
 
 filesToUncomment.forEach((file) => {
   const filePath = join(__dirname, '../types', file)
+  // eslint-disable-next-line no-restricted-syntax
   const str = fs.readFileSync(filePath).toString()
 
   const result = str.split('\n').map((line) => {
     return line.startsWith('//z ') ? line.substring(4) : line
   }).join('\n')
 
+  // eslint-disable-next-line no-restricted-syntax
   fs.writeFileSync(filePath, result)
 })

cli/test/lib/tasks/download_spec.js

@@ -186,6 +186,7 @@ describe('lib/tasks/download', function () {
   context('verify downloaded file', function () {
     before(function () {
       this.expectedChecksum = hasha.fromFileSync(examplePath)
+      // eslint-disable-next-line no-restricted-syntax
       this.expectedFileSize = fs.statSync(examplePath).size
       this.onProgress = sinon.stub().returns(undefined)
       debug('example file %s should have checksum %s and file size %d',

cli/test/lib/tasks/verify_spec.js

@@ -31,8 +31,6 @@ const DEFAULT_VERIFY_TIMEOUT = 30000
 let stdout
 let spawnedProcess
 
-/* eslint-disable no-octal */
-
 context('lib/tasks/verify', () => {
   require('mocha-banner').register()
 

cli/test/spec_helper.js

@@ -69,7 +69,6 @@ function throwIfFnNotStubbed (stub, method) {
 const $stub = sinon.stub
 
 sinon.stub = function (obj, method) {
-  /* eslint-disable prefer-rest-params */
   const stub = $stub.apply(this, arguments)
 
   let fns = [method]

cli/test/support/stdout.js

@@ -9,7 +9,6 @@ module.exports = {
     process.stdout.write = function (str) {
       logs.push(str)
 
-      /* eslint-disable prefer-rest-params */
       write.apply(this, arguments)
     }