chore: migrate packages/errors to modern eslint (#32313)

Author: cacieprins

guides/eslint-migration.md

@@ -40,7 +40,7 @@
 - [ ] packages/socket
 - [ ] packages/telemetry
 - [ ] packages/launchpad
-- [ ] packages/errors
+- [x] packages/errors
 - [ ] packages/data-context
 - [ ] packages/app
 

packages/errors/.eslintignore

@@ -5,7 +5,7 @@ module.exports = {
   extension: ['ts'],
   reporter: 'mocha-multi-reporters',
   reporterOptions: {
-    configFile: '../../mocha-reporter-config.json'
+    configFile: '../../mocha-reporter-config.json',
   },
-  exit: true
-} 
+  exit: true,
+}

packages/errors/.mocharc.js

@@ -0,0 +1,3 @@
+import { baseConfig } from '@packages/eslint-config'
+
+export default baseConfig

packages/errors/eslint.config.ts

@@ -11,7 +11,7 @@
     "clean": "rimraf ./src/*.js ./src/**/*.js ./src/**/**/*.js ./test/**/*.js || echo 'cleaned'",
     "clean-deps": "rimraf node_modules",
     "comparison": "node -r @packages/ts/register test/support/error-comparison-tool.ts",
-    "lint": "eslint --ext .js,.jsx,.ts,.tsx,.json, .",
+    "lint": "eslint",
     "test": "yarn test-unit",
     "test-electron": "HTML_IMAGE_CONVERSION=1 xvfb-maybe electron --no-sandbox ./node_modules/.bin/_mocha",
     "pretest-unit": "yarn clean",
@@ -27,6 +27,7 @@
     "strip-ansi": "6.0.1"
   },
   "devDependencies": {
+    "@packages/eslint-config": "0.0.0-development",
     "@packages/server": "0.0.0-development",
     "@packages/ts": "0.0.0-development",
     "@packages/types": "0.0.0-development",
@@ -37,7 +38,9 @@
     "ansi-styles": "^5",
     "chai": "4.2.0",
     "ci-info": "^4.1.0",
+    "eslint": "^9.31.0",
     "globby": "^11.1.0",
+    "jiti": "^2.4.2",
     "mocha": "7.0.1",
     "pngjs": "^7.0.0",
     "rimraf": "5.0.10",
@@ -50,5 +53,8 @@
     "dist"
   ],
   "types": "src/index.ts",
+  "lint-staged": {
+    "**/*.{js,jsx,ts,tsx,json}": "eslint --fix"
+  },
   "nx": {}
 }

packages/errors/package.json

@@ -1,6 +1,6 @@
 import AU from 'ansi_up'
 import os from 'os'
-/* eslint-disable no-console */
+
 import chalk from 'chalk'
 import _ from 'lodash'
 import path from 'path'
@@ -145,7 +145,7 @@ export const AllCypressErrors = {
     return errTemplate`${fmt.off(`\n  `)}This spec and its tests were skipped because the run has been canceled.`
   },
   CLOUD_API_RESPONSE_FAILED_RETRYING: (
-    arg1: {tries: number, delayMs: number, response: Error },
+    arg1: { tries: number, delayMs: number, response: Error },
   ) => {
     const time = pluralize('time', arg1.tries)
     const delay = humanTime.long(arg1.delayMs, false)
@@ -160,9 +160,8 @@ export const AllCypressErrors = {
         We will retry ${fmt.off(arg1.tries)} more ${fmt.off(time)} in ${fmt.off(delay)}...
         `
     /* Because of fmt.listFlags() and fmt.listItems() */
-    /* eslint-disable indent */
   },
-  CLOUD_CANNOT_PROCEED_IN_PARALLEL: (arg1: {flags: any, response: Error}) => {
+  CLOUD_CANNOT_PROCEED_IN_PARALLEL: (arg1: { flags: any, response: Error }) => {
     const message = normalizeNetworkErrorMessage(arg1.response)
 
     return errTemplate`\
@@ -177,7 +176,7 @@ export const AllCypressErrors = {
       ciBuildId: '--ciBuildId',
     })}`
   },
-  CLOUD_CANNOT_PROCEED_IN_SERIAL: (arg1: {flags: any, response: Error}) => {
+  CLOUD_CANNOT_PROCEED_IN_SERIAL: (arg1: { flags: any, response: Error }) => {
     const message = normalizeNetworkErrorMessage(arg1.response)
 
     return errTemplate`\
@@ -192,7 +191,7 @@ export const AllCypressErrors = {
       ciBuildId: '--ciBuildId',
     })}`
   },
-  CLOUD_UNKNOWN_INVALID_REQUEST: (arg1: {flags: any, response: Error}) => {
+  CLOUD_UNKNOWN_INVALID_REQUEST: (arg1: { flags: any, response: Error }) => {
     const message = normalizeNetworkErrorMessage(arg1.response)
 
     return errTemplate`\
@@ -209,7 +208,7 @@ export const AllCypressErrors = {
       ciBuildId: '--ciBuildId',
     })}`
   },
-  CLOUD_UNKNOWN_CREATE_RUN_WARNING: (arg1: {props?: any, message: string}) => {
+  CLOUD_UNKNOWN_CREATE_RUN_WARNING: (arg1: { props?: any, message: string }) => {
     if (!Object.keys(arg1.props).length) {
       return errTemplate`\
           Warning from Cypress Cloud: ${fmt.highlight(arg1.message)}
@@ -222,7 +221,7 @@ export const AllCypressErrors = {
         Details:
         ${fmt.meta(arg1.props)}`
   },
-  CLOUD_STALE_RUN: (arg1: {runUrl: string, [key: string]: any}) => {
+  CLOUD_STALE_RUN: (arg1: { runUrl: string, [key: string]: any }) => {
     return errTemplate`\
         You are attempting to pass the ${fmt.flag(`--parallel`)} flag to a run that was completed over 24 hours ago.
 
@@ -239,7 +238,7 @@ export const AllCypressErrors = {
 
         https://on.cypress.io/stale-run`
   },
-  CLOUD_ALREADY_COMPLETE: (props: {runUrl: string, tags: string, group: string, parallel: string, ciBuildId: string}) => {
+  CLOUD_ALREADY_COMPLETE: (props: { runUrl: string, tags: string, group: string, parallel: string, ciBuildId: string }) => {
     return errTemplate`\
         The run you are attempting to access is already complete and will not accept new groups.
 
@@ -256,7 +255,7 @@ export const AllCypressErrors = {
 
         https://on.cypress.io/already-complete`
   },
-  CLOUD_PARALLEL_REQUIRED: (arg1: {tags: string, group: string, runUrl: string, ciBuildId: string }) => {
+  CLOUD_PARALLEL_REQUIRED: (arg1: { tags: string, group: string, runUrl: string, ciBuildId: string }) => {
     return errTemplate`\
         You did not pass the ${fmt.flag(`--parallel`)} flag, but this run's group was originally created with the --parallel flag.
 
@@ -273,7 +272,7 @@ export const AllCypressErrors = {
 
         https://on.cypress.io/parallel-required`
   },
-  CLOUD_PARALLEL_DISALLOWED: (arg1: {tags: string, group: string, runUrl: string, ciBuildId: string}) => {
+  CLOUD_PARALLEL_DISALLOWED: (arg1: { tags: string, group: string, runUrl: string, ciBuildId: string }) => {
     return errTemplate`\
         You passed the ${fmt.flag(`--parallel`)} flag, but this run group was originally created without the --parallel flag.
 
@@ -290,7 +289,7 @@ export const AllCypressErrors = {
 
         https://on.cypress.io/parallel-disallowed`
   },
-  CLOUD_PARALLEL_GROUP_PARAMS_MISMATCH: (arg1: {group: string, runUrl: string, ciBuildId: string, parameters: any, payload: any }) => {
+  CLOUD_PARALLEL_GROUP_PARAMS_MISMATCH: (arg1: { group: string, runUrl: string, ciBuildId: string, parameters: any, payload: any }) => {
     let params: any = arg1.parameters
 
     if (arg1.payload?.differentParams) {
@@ -344,7 +343,7 @@ export const AllCypressErrors = {
 
         https://on.cypress.io/parallel-group-params-mismatch`
   },
-  CLOUD_RUN_GROUP_NAME_NOT_UNIQUE: (arg1: {group: string, runUrl: string, ciBuildId?: string | null}) => {
+  CLOUD_RUN_GROUP_NAME_NOT_UNIQUE: (arg1: { group: string, runUrl: string, ciBuildId?: string | null }) => {
     return errTemplate`\
         You passed the ${fmt.flag(`--group`)} flag, but this group name has already been used for this run.
 
@@ -362,15 +361,15 @@ export const AllCypressErrors = {
 
         https://on.cypress.io/run-group-name-not-unique`
   },
-  CLOUD_AUTO_CANCEL_NOT_AVAILABLE_IN_PLAN: (arg1: {link: string}) => {
+  CLOUD_AUTO_CANCEL_NOT_AVAILABLE_IN_PLAN: (arg1: { link: string }) => {
     return errTemplate`\
       ${fmt.highlightSecondary(`Auto Cancellation`)} is not included under your current billing plan.
 
       To enable this service, please visit your billing and upgrade to another plan with Auto Cancellation.
 
       ${fmt.off(arg1.link)}`
   },
-  CLOUD_AUTO_CANCEL_MISMATCH: (arg1: {runUrl: string, tags: string, group: string, parallel: string, ciBuildId: string, autoCancelAfterFailures: string }) => {
+  CLOUD_AUTO_CANCEL_MISMATCH: (arg1: { runUrl: string, tags: string, group: string, parallel: string, ciBuildId: string, autoCancelAfterFailures: string }) => {
     return errTemplate`\
         You passed the ${fmt.flag(`--auto-cancel-after-failures`)} flag, but this run originally started with a different value for the ${fmt.flag(`--auto-cancel-after-failures`)} flag.
 
@@ -442,7 +441,6 @@ export const AllCypressErrors = {
         The --ci-build-id flag is used to either group or parallelize multiple runs together.
 
         https://on.cypress.io/incorrect-ci-build-id-usage`
-    /* eslint-enable indent */
   },
   RECORD_KEY_MISSING: () => {
     return errTemplate`\
@@ -487,7 +485,7 @@ export const AllCypressErrors = {
 
         https://on.cypress.io/recording-project-runs`
   },
-  CLOUD_INVALID_RUN_REQUEST: (arg1: {message: string, errors: string[], object: object}) => {
+  CLOUD_INVALID_RUN_REQUEST: (arg1: { message: string, errors: string[], object: object }) => {
     return errTemplate`\
         Recording this run failed. The request was invalid.
 
@@ -626,7 +624,7 @@ export const AllCypressErrors = {
         return AllCypressErrors.CLOUD_PROTOCOL_UPLOAD_NETWORK_FAILURE(firstError as Error & { url: string })
       }
 
-      return AllCypressErrors.CLOUD_PROTOCOL_UPLOAD_HTTP_FAILURE(error.errors[0] as Error & { url: string, status: number, statusText: string, responseBody: string})
+      return AllCypressErrors.CLOUD_PROTOCOL_UPLOAD_HTTP_FAILURE(error.errors[0] as Error & { url: string, status: number, statusText: string, responseBody: string })
     }
 
     let systemErr = error.errors.find((err) => {
@@ -931,7 +929,7 @@ export const AllCypressErrors = {
 
       Instead the value was: ${fmt.stringify(value)}`
   },
-  RENAMED_CONFIG_OPTION: (arg1: {name: string, newName: string}) => {
+  RENAMED_CONFIG_OPTION: (arg1: { name: string, newName: string }) => {
     return errTemplate`\
         The ${fmt.highlight(arg1.name)} configuration option you have supplied has been renamed.
 
@@ -952,7 +950,7 @@ export const AllCypressErrors = {
         This server has been configured as your ${fmt.highlight(`baseUrl`)}, and tests will likely fail if it is not running.`
   },
   // TODO: test this
-  CANNOT_CONNECT_BASE_URL_RETRYING: (arg1: {attempt: number, baseUrl: string, remaining: number, delay: number}) => {
+  CANNOT_CONNECT_BASE_URL_RETRYING: (arg1: { attempt: number, baseUrl: string, remaining: number, delay: number }) => {
     switch (arg1.attempt) {
       case 1:
         return errTemplate`\
@@ -970,7 +968,7 @@ export const AllCypressErrors = {
     }
   },
   // TODO: test this
-  INVALID_REPORTER_NAME: (arg1: {name: string, paths: string[], error: Error}) => {
+  INVALID_REPORTER_NAME: (arg1: { name: string, paths: string[], error: Error }) => {
     return errTemplate`\
         Error loading the reporter: ${fmt.highlight(arg1.name)}
 
@@ -1016,15 +1014,15 @@ export const AllCypressErrors = {
 
         https://on.cypress.io/installing-cypress`
   },
-  FREE_PLAN_EXCEEDS_MONTHLY_TESTS: (arg1: {link: string, usedTestsMessage: string, limit: number}) => {
+  FREE_PLAN_EXCEEDS_MONTHLY_TESTS: (arg1: { link: string, usedTestsMessage: string, limit: number }) => {
     return errTemplate`\
         You've exceeded the limit of test results under your free plan this month. ${getUsedTestsMessage(arg1.limit, arg1.usedTestsMessage)}
 
         To continue recording tests this month you must upgrade your account. Please visit your billing to upgrade to another billing plan.
 
         ${fmt.off(arg1.link)}`
   },
-  FREE_PLAN_IN_GRACE_PERIOD_EXCEEDS_MONTHLY_TESTS: (arg1: {link: string, usedTestsMessage: string, gracePeriodMessage: string, limit: number}) => {
+  FREE_PLAN_IN_GRACE_PERIOD_EXCEEDS_MONTHLY_TESTS: (arg1: { link: string, usedTestsMessage: string, gracePeriodMessage: string, limit: number }) => {
     return errTemplate`\
         You've exceeded the limit of test results under your free plan this month. ${getUsedTestsMessage(arg1.limit, arg1.usedTestsMessage)}
 
@@ -1034,39 +1032,39 @@ export const AllCypressErrors = {
 
         ${fmt.off(arg1.link)}`
   },
-  PLAN_EXCEEDS_MONTHLY_TESTS: (arg1: {link: string, planType: string, usedTestsMessage: string, limit: number}) => {
+  PLAN_EXCEEDS_MONTHLY_TESTS: (arg1: { link: string, planType: string, usedTestsMessage: string, limit: number }) => {
     return errTemplate`\
         You've exceeded the limit of test results under your ${fmt.highlight(arg1.planType)} billing plan this month. ${getUsedTestsMessage(arg1.limit, arg1.usedTestsMessage)}
 
         To continue getting the full benefits of your current plan, please visit your billing to upgrade.
 
         ${fmt.off(arg1.link)}`
   },
-  FREE_PLAN_IN_GRACE_PERIOD_PARALLEL_FEATURE: (arg1: {link: string, gracePeriodMessage: string}) => {
+  FREE_PLAN_IN_GRACE_PERIOD_PARALLEL_FEATURE: (arg1: { link: string, gracePeriodMessage: string }) => {
     return errTemplate`\
         ${fmt.highlightSecondary(`Parallelization`)} is not included under your free plan.
 
         Your plan is now in a grace period, which means your tests will still run in parallel until ${fmt.highlight(arg1.gracePeriodMessage)}. Please upgrade your plan to continue running your tests in parallel in the future.
 
         ${fmt.off(arg1.link)}`
   },
-  PARALLEL_FEATURE_NOT_AVAILABLE_IN_PLAN: (arg1: {link: string}) => {
+  PARALLEL_FEATURE_NOT_AVAILABLE_IN_PLAN: (arg1: { link: string }) => {
     return errTemplate`\
         ${fmt.highlightSecondary(`Parallelization`)} is not included under your current billing plan.
 
         To run your tests in parallel, please visit your billing and upgrade to another plan with parallelization.
 
         ${fmt.off(arg1.link)}`
   },
-  PLAN_IN_GRACE_PERIOD_RUN_GROUPING_FEATURE_USED: (arg1: {link: string, gracePeriodMessage: string}) => {
+  PLAN_IN_GRACE_PERIOD_RUN_GROUPING_FEATURE_USED: (arg1: { link: string, gracePeriodMessage: string }) => {
     return errTemplate`\
         ${fmt.highlightSecondary(`Grouping`)} is not included under your free plan.
 
         Your plan is now in a grace period, which means your tests will still run with groups until ${fmt.highlight(arg1.gracePeriodMessage)}. Please upgrade your plan to continue running your tests with groups in the future.
 
         ${fmt.off(arg1.link)}`
   },
-  RUN_GROUPING_FEATURE_NOT_AVAILABLE_IN_PLAN: (arg1: {link: string}) => {
+  RUN_GROUPING_FEATURE_NOT_AVAILABLE_IN_PLAN: (arg1: { link: string }) => {
     return errTemplate`\
         ${fmt.highlightSecondary(`Grouping`)} is not included under your current billing plan.
 
@@ -1113,7 +1111,7 @@ export const AllCypressErrors = {
 
         CYPRESS_INTERNAL_ENV is reserved for internal use and cannot be modified.`
   },
-  CDP_VERSION_TOO_OLD: (minimumVersion: string, currentVersion: {major: number, minor: string | number}) => {
+  CDP_VERSION_TOO_OLD: (minimumVersion: string, currentVersion: { major: number, minor: string | number }) => {
     const phrase = currentVersion.major !== 0
       ? fmt.highlight(`${currentVersion.major}.${currentVersion.minor}`)
       : fmt.off('an older version')
@@ -1636,7 +1634,7 @@ interface GenericError extends Error {
   [key: string]: any
 }
 
-export const cloneErr = function (err: CypressError | GenericError, options: {html?: boolean} = {}) {
+export const cloneErr = function (err: CypressError | GenericError, options: { html?: boolean } = {}) {
   _.defaults(options, {
     html: false,
   })

packages/errors/src/errors.ts

@@ -3,7 +3,7 @@ import type { ErrorLike } from './errorTypes'
 
 export const stackLineRegex = /^\s*(at )?.*@?(?:\(?.*(?::\d+:\d+|<unknown>|\[native code\])+\)?)$/
 
-type MessageLines = [string[], string[]] & {messageEnded?: boolean}
+type MessageLines = [string[], string[]] & { messageEnded?: boolean }
 
 // returns tuple of [message, stack]
 export const splitStack = (stack: string) => {

packages/errors/src/stackUtils.ts

@@ -140,13 +140,13 @@ app.get('/base-list', async (req, res) => {
   }
 })
 
-app.get<{offset: number}>('/load-more/:offset', async (req, res) => {
+app.get<{ offset: number }>('/load-more/:offset', async (req, res) => {
   const rows = await getRows(req.params.offset)
 
   res.send(rows)
 })
 
-app.get<{offset: number}>('/load-more-base/:offset', async (req, res) => {
+app.get<{ offset: number }>('/load-more-base/:offset', async (req, res) => {
   const rows = await getRows(req.params.offset, true)
 
   res.send(rows)
@@ -166,7 +166,7 @@ app.get('/looks-good/:name', async (req, res) => {
   }
 })
 
-app.get<{name: string, type: string}>('/html/:name/:type', async (req, res) => {
+app.get<{ name: string, type: string }>('/html/:name/:type', async (req, res) => {
   const pathToFile = path.join(ERRORS_DIR, req.params.type, `${req.params.name}.html`)
 
   try {

packages/errors/test/support/error-comparison-tool.ts

@@ -185,7 +185,7 @@ const testVisualError = <K extends CypressErrorType> (errorGeneratorFn: () => Er
   }
 }
 
-const testVisualErrors = (whichError: CypressErrorType | '*', errorsToTest: {[K in CypressErrorType]: () => ErrorGenerator<K>}) => {
+const testVisualErrors = (whichError: CypressErrorType | '*', errorsToTest: { [K in CypressErrorType]: () => ErrorGenerator<K> }) => {
   // if we aren't testing all the errors
   if (whichError !== '*') {
     // then just test this individual error
@@ -291,7 +291,7 @@ const makeErr = () => {
 
   err.stack = err.stack?.split('\n').slice(0, 3).join('\n') ?? ''
 
-  return err as Error & {stack: string}
+  return err as Error & { stack: string }
 }
 
 process.on('uncaughtException', (err) => {