chore: make the @packages/config 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. (#32612)

Author: AtofStryker

guides/esm-migration.md

@@ -33,7 +33,7 @@
 ##### Binary Packages
 
 - [ ] packages/app **PARTIAL** - low priority: frontend package
-- [ ] packages/config **PARTIAL** - entry point is JS
+- [x] packages/config ✅ **COMPLETED**
 - [ ] packages/data-context  **PARTIAL** - entry point is JS
 - [x] packages/driver ✅ **COMPLETED** - source complete, cypress tests need migration
 - [x] packages/electron ✅ **COMPLETED**

packages/config/.eslintignore

@@ -1,3 +1,5 @@
+**/cjs
+**/esm
 **/dist
 **/*.d.ts
 **/package-lock.json

packages/config/.gitignore

@@ -1 +1,2 @@
-src/**/*.js
+cjs/
+esm/

packages/config/index.js

@@ -3,12 +3,15 @@
   "version": "0.0.0-development",
   "description": "Config contains the configuration types and validation function used in the cypress electron application.",
   "private": true,
-  "main": "index.js",
-  "browser": "src/browser.ts",
+  "main": "cjs/index.js",
+  "browser": "esm/browser.js",
   "scripts": {
-    "build-prod": "tsc || echo 'built, with errors'",
-    "check-ts": "tsc --noEmit && yarn -s tslint",
-    "clean": "rimraf --glob './src/*.js' './src/**/*.js' './src/**/**/*.js' './test/!**__fixtures__**/**/*.js' || echo 'cleaned'",
+    "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",
     "clean-deps": "rimraf node_modules",
     "lint": "eslint --ext .js,.ts,.json, .",
     "test": "yarn test-unit",
@@ -42,11 +45,14 @@
     "@packages/ts": "0.0.0-development",
     "@packages/types": "0.0.0-development",
     "babel-plugin-tester": "^10.1.0",
+    "rimraf": "6.0.1",
     "vitest": "^3.2.4"
   },
   "files": [
-    "src"
+    "cjs/*",
+    "esm/*"
   ],
   "types": "src/index.ts",
+  "module": "esm/index.js",
   "nx": {}
 }

packages/config/package.json

@@ -49,7 +49,7 @@ export async function addToCypressConfig (filePath: string, code: string, toAdd:
     traverse(ast, addToCypressConfigPlugin(toAdd).visitor)
 
     return print(ast).code
-  } catch (e) {
+  } catch (e: any) {
     debug(`Error adding properties to %s: %s`, filePath, e.stack)
     throw new Error(`Unable to automerge with the config file`)
   }
@@ -125,7 +125,7 @@ export async function addTestingTypeToCypressConfig (options: AddTestingTypeToCy
     return {
       result: resultStatus,
     }
-  } catch (e) {
+  } catch (e: any) {
     return {
       result: 'NEEDS_MERGE',
       error: e,

packages/config/src/ast-utils/addToCypressConfig.ts

@@ -1,7 +1,5 @@
 import os from 'os'
 import path from 'path'
-
-// @ts-ignore
 import pkg from '@packages/root'
 import type { AllCypressErrorNames } from '@packages/errors'
 import type { TestingType } from '@packages/types'
@@ -485,7 +483,7 @@ const runtimeOptions: Array<RuntimeConfigOption> = [
     // having the final config that has the e2e property flattened/compacted
     // we may not be able to get the value to ignore.
     name: 'additionalIgnorePattern',
-    defaultValue: (options: Record<string, any> = {}) => options.testingType === 'component' ? defaultSpecPattern.e2e : [],
+    defaultValue: (options: Record<string, any> = {}): string | any[] => options.testingType === 'component' ? defaultSpecPattern.e2e : [],
     validation: validate.isStringOrArrayOfStrings,
     isInternal: true,
   }, {

packages/config/src/options.ts

@@ -20,9 +20,9 @@ import {
   setSupportFileAndFolder,
   mergeDefaults,
 } from '../../src/project/utils'
+import { resetIssuedWarnings } from '../../src/browser'
 import path from 'node:path'
 import { Config } from '../../src/project/types'
-import { resetIssuedWarnings } from '../../src/browser'
 
 const debug = Debug('test')
 

packages/config/test/project/utils.spec.ts

@@ -0,0 +1,19 @@
+{
+  "include": [
+    "src/*.ts"
+  ],
+  "exclude": [
+    "test"
+  ],
+  "compilerOptions": {
+    "strict": true,
+    "noImplicitAny": true,
+    "esModuleInterop": true,
+    "noUncheckedIndexedAccess": true,
+    "skipLibCheck": true,
+    "resolveJsonModule": true,
+    "types": [
+      "node"
+    ]
+  }
+}

packages/config/tsconfig.base.json

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