chore: make the @packages/errors an independent bundle without needed ts-node to register entrypoint. Both ESM and CJS distributions are built and types are used as source to be compatible with older styles of commonjs bundling. Types are not shipped with the package. (#32610)

Author: AtofStryker

guides/esm-migration.md

@@ -37,7 +37,7 @@
 - [ ] packages/data-context  **PARTIAL** - entry point is JS
 - [x] packages/driver ✅ **COMPLETED** - source complete, cypress tests need migration
 - [x] packages/electron ✅ **COMPLETED**
-- [ ] packages/error **PARTIAL** - entry point is JS
+- [x] packages/error ✅ **COMPLETED**
 - [x] packages/eslint-config ✅ **COMPLETED**
 - [ ] packages/example
 - [ ] packages/extension

packages/errors/.gitignore

@@ -0,0 +1,2 @@
+cjs
+esm

packages/errors/index.js

@@ -2,18 +2,23 @@
   "name": "@packages/errors",
   "version": "0.0.0-development",
   "description": "Error definitions and utilities for Cypress",
-  "main": "index.js",
-  "browser": "src/index.ts",
+  "main": "cjs/index.js",
+  "module": "esm/index.js",
+  "browser": "esm/index.js",
+  "files": [
+    "cjs/*",
+    "esm/*"
+  ],
+  "types": "src/index.ts",
   "scripts": {
-    "build": "../../scripts/run-if-ci.sh tsc || echo 'type errors'",
-    "build-prod": "tsc",
-    "check-ts": "tsc --noEmit && yarn -s tslint",
-    "clean": "rimraf --glob './src/*.js' './src/**/*.js' './src/**/**/*.js' './test/**/*.js' || echo 'cleaned'",
-    "clean-deps": "rimraf node_modules",
+    "build": "yarn build:esm && yarn build:cjs",
+    "build-prod": "yarn build",
+    "build:cjs": "rimraf cjs && tsc -p tsconfig.cjs.json",
+    "build:esm": "rimraf esm && tsc -p tsconfig.esm.json",
+    "check-ts": "tsc -p tsconfig.cjs.json --noEmit && yarn -s tslint -p tsconfig.cjs.json",
+    "clean": "rimraf cjs esm",
     "lint": "eslint",
-    "pretest": "yarn clean",
     "test": "yarn test-unit",
-    "posttest": "yarn build",
     "test-unit": "vitest run",
     "test-debug": "vitest --inspect-brk --no-file-parallelism --test-timeout=0",
     "tslint": "tslint --config ../ts/tslint.json --project ."
@@ -31,8 +36,6 @@
     "@packages/server": "0.0.0-development",
     "@packages/ts": "0.0.0-development",
     "@packages/types": "0.0.0-development",
-    "@types/chai": "4.2.15",
-    "@types/mocha": "8.2.2",
     "@types/node": "22.18.0",
     "@types/pngjs": "^6.0.1",
     "ansi-styles": "^5",
@@ -45,11 +48,6 @@
     "vitest": "^3.2.4",
     "xvfb-maybe": "^0.2.1"
   },
-  "files": [
-    "src",
-    "dist"
-  ],
-  "types": "src/index.ts",
   "lint-staged": {
     "**/*.{js,jsx,ts,tsx,json}": "eslint --fix"
   },

packages/errors/package.json

@@ -1572,7 +1572,7 @@ export const getError = function <Type extends keyof AllCypressErrorObj> (type:
   return err
 }
 
-export const logWarning = function <Type extends keyof AllCypressErrorObj> (type: Type, ...args: Parameters<AllCypressErrorObj[Type]>) {
+export const logWarning = function <Type extends keyof AllCypressErrorObj> (type: Type, ...args: Parameters<AllCypressErrorObj[Type]>): null {
   const err = getError(type, ...args)
 
   logError(err, 'magenta')

packages/errors/src/errors.ts

@@ -99,7 +99,7 @@ describe('visual error templates', () => {
 
         const consoleLogOutput = getConsoleLogOutput()
 
-       expect(consoleLogOutput).toMatchFileSnapshot(`./__snapshots__/${filename}.ansi`)
+        await expect(consoleLogOutput).toMatchFileSnapshot(`./__snapshots__/${filename}.ansi`)
       })
     }
   }

packages/errors/test/visualSnapshotErrors.spec.ts

@@ -1,5 +1,4 @@
 {
-  "extends": "../ts/tsconfig.json",
   "include": [
     "src",
   ],
@@ -8,5 +7,8 @@
     "noImplicitAny": true,
     "noImplicitReturns": false,
     "noUncheckedIndexedAccess": true,
+    "skipLibCheck": true,
+    "resolveJsonModule": true,
+    "esModuleInterop": true
   }
 }

packages/errors/tsconfig.json renamed to packages/errors/tsconfig.base.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./cjs",
+    "target": "ES2022",
+    "module": "CommonJS",
+    "moduleResolution": "node"
+  }
+}

packages/errors/tsconfig.cjs.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./esm",
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "node"
+  }
+}

packages/errors/tsconfig.esm.json

@@ -1,17 +1,17 @@
 import _ from 'lodash'
-const Promise = require('bluebird')
-const pkg = require('@packages/root')
-const api = require('./api').default
-const user = require('./user')
-const system = require('../util/system')
-const { stripPath } = require('./strip_path')
+import Bluebird from 'bluebird'
+import pkg from '@packages/root'
+import api from './api'
+import user from './user'
+import system from '../util/system'
+import { stripPath } from './strip_path'
 
 export = {
   getErr (err: Error) {
     return {
       name: stripPath(err.name),
       message: stripPath(err.message),
-      stack: stripPath(err.stack),
+      stack: stripPath(err.stack as string),
     }
   },
 
@@ -42,7 +42,7 @@ export = {
     }
 
     try {
-      const [body, authToken] = await Promise.all([
+      const [body, authToken] = await Bluebird.all([
         this.getBody(err),
         this.getAuthToken(),
       ])