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

.circleci/workflows.yml

@@ -2322,14 +2322,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:
@@ -3016,9 +3008,6 @@ linux-x64-workflow: &linux-x64-workflow
     - npm-mount-utils:
         requires:
           - build
-    - npm-eslint-plugin-dev:
-        requires:
-          - build
     - npm-cypress-schematic:
         requires:
           - build
@@ -3031,7 +3020,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
@@ -3387,9 +3375,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
@@ -3401,7 +3386,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

.prettierignore

@@ -1,4 +1,8 @@
 **/*
 
 /.nx/cache
-/.nx/workspace-data
+/.nx/workspace-data
+
+!**/*.json
+**/package.json
+**/package-lock.json

.vscode/settings.json

@@ -8,16 +8,8 @@
     "json"
   ],
   "eslint.enable": true,
-  // this project does not use Prettier
-  // thus set all settings to disable accidentally running Prettier
+  // this project only uses Prettier for json files
   "prettier.requireConfig": true,
-  "prettier.disableLanguages": [
-    "javascript",
-    "javascriptreact",
-    "typescript",
-    "typescriptreact",
-    "json"
-  ],
   "editor.codeActionsOnSave": {
     "source.fixAll.eslint": "explicit"
   },

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,12 @@ 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.
+Cypress uses [eslint](https://eslint.org/) to lint all JavaScript code. All packages should import the `baseConfig` from the root `eslint.config.ts`. The only overrides in package-specific `eslint.config.ts` files should be regarding:
+- Which files get processed
+- Which globals are expected for selections of files
+- Downgrading inherited rules from `error` to `warn`, if they cannot be `--fix`ed.
+
+Package-specific `eslint.config.ts` configurations should *never* turn inherited rules off. This is to ensure repository-wide linting standards. If a rule is inappropriately applied to a package or its files, there is likely a better solution than turning the rule off.
 
 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.

autobarrel.json

@@ -1,13 +1,10 @@
 {
   "prefix": "/* eslint-disable padding-line-between-statements */",
-  "paths": [
-    "packages/graphql/src/**/*",
-    "packages/data-context/src/**/*"
-  ],
+  "paths": ["packages/graphql/src/**/*", "packages/data-context/src/**/*"],
   "ignore": [
     "packages/data-context/src/gen",
     "packages/graphql/src/stitching",
     "packages/graphql/src/testing",
     "packages/graphql/src/gen"
   ]
-}
+}

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) {
     //