chore: bundle the root package.json as an installable package (#32544)

* chore: bundle the root package.json as an installable package

* Update packages/root/README.md

Co-authored-by: Jennifer Shehane <[email protected]>

* Update guides/esm-migration.md

Co-authored-by: Jennifer Shehane <[email protected]>

* Update packages/root/README.md

Co-authored-by: Jennifer Shehane <[email protected]>

---------

Co-authored-by: Jennifer Shehane <[email protected]>

Author: AtofStryker

.circleci/src/workflows/workflows/@main.yml

@@ -5,7 +5,7 @@ linux-x64:
       - equal: [ develop, << pipeline.git.branch >> ]
       # use the following branch as well to ensure that v8 snapshot cache updates are fully tested
       - equal: [ 'update-v8-snapshot-cache-on-develop', << pipeline.git.branch >> ]
-      - equal: [ 'chore/merge_gql_package_w_data_context', << pipeline.git.branch >> ]
+      - equal: [ 'chore/bundle_package_root', << pipeline.git.branch >> ]
       - matches:
           pattern: /^release\/\d+\.\d+\.\d+$/
           value: << pipeline.git.branch >>

.circleci/workflows.yml

@@ -3718,7 +3718,7 @@ workflows:
             - update-v8-snapshot-cache-on-develop
             - << pipeline.git.branch >>
         - equal:
-            - chore/merge_gql_package_w_data_context
+            - chore/bundle_package_root
             - << pipeline.git.branch >>
         - matches:
             pattern: /^release\/\d+\.\d+\.\d+$/
@@ -3775,7 +3775,7 @@ workflows:
             - update-v8-snapshot-cache-on-develop
             - << pipeline.git.branch >>
         - equal:
-            - chore/merge_gql_package_w_data_context
+            - chore/bundle_package_root
             - << pipeline.git.branch >>
         - matches:
             pattern: /^release\/\d+\.\d+\.\d+$/
@@ -3843,7 +3843,7 @@ workflows:
             - update-v8-snapshot-cache-on-develop
             - << pipeline.git.branch >>
         - equal:
-            - chore/merge_gql_package_w_data_context
+            - chore/bundle_package_root
             - << pipeline.git.branch >>
         - matches:
             pattern: /^release\/\d+\.\d+\.\d+$/
@@ -4331,7 +4331,7 @@ workflows:
             - update-v8-snapshot-cache-on-develop
             - << pipeline.git.branch >>
         - equal:
-            - chore/merge_gql_package_w_data_context
+            - chore/bundle_package_root
             - << pipeline.git.branch >>
         - matches:
             pattern: /^release\/\d+\.\d+\.\d+$/
@@ -5168,7 +5168,7 @@ workflows:
             - update-v8-snapshot-cache-on-develop
             - << pipeline.git.branch >>
         - equal:
-            - chore/merge_gql_package_w_data_context
+            - chore/bundle_package_root
             - << pipeline.git.branch >>
         - matches:
             pattern: /^release\/\d+\.\d+\.\d+$/

.cursor/BUGBOT.md

@@ -131,7 +131,7 @@ Essential rules for reviewing code changes in the Cypress monorepo.
   - Focus: Scaffolding logic, template accuracy, project initialization
 
 ### Utility Packages (Lower Priority)
-- **@packages/root**: Root package (dummy package)
+- **@packages/root**: Root package
   - Focus: Monorepo setup, package coordination
 - **@packages/example**: Example project
   - Focus: Example accuracy, documentation quality, test examples

guides/esm-migration.md

@@ -55,7 +55,7 @@
 - [x] packages/reporter ✅ **COMPLETED**
 - [ ] packages/resolve-dist **PARTIAL** - entry point is JS
 - [ ] packages/rewriter **PARTIAL** - entry point is JS
-- [ ] packages/root
+- [x] packages/root ✅ **COMPLETED**
 - [x] packages/runner ✅ **COMPLETED**
 - [ ] packages/scaffold-config **PARTIAL** - entry point is JS
 - [ ] packages/server **PARTIAL** - many source/test files in JS. highest priority

packages/root/.gitignore

@@ -0,0 +1,2 @@
+index.js
+index.mjs

packages/root/README.md

@@ -0,0 +1,5 @@
+# Purpose
+
+Bundles the monorepo root `package.json` as an installable package, allowing `@packages/root` to be installed in any context without having an absolute reference to the root `package.json`
+
+In order to accomplish this, `rollup` is used to bundle the `package.json`, as packages may be interpreted in place or be installed inside the `node_modules` directory. This package builds an `index.mjs` file for packages using `vite`/ ES Modules and an `index.js` file for any CommonJS entry points.

packages/root/index.js

@@ -0,0 +1,3 @@
+import pkg from '../../package.json'
+
+export default pkg

packages/root/index.ts

@@ -1,7 +1,20 @@
 {
   "name": "@packages/root",
   "version": "0.0.0-development",
-  "description": "dummy package pointing at the root package",
+  "description": "bundles the root package.json as an installable package",
   "main": "index.js",
+  "scripts": {
+    "build": "yarn build:cjs && yarn build:esm",
+    "build:cjs": "rimraf index.js && rollup -c rollup.config.mjs -f cjs -o index.js",
+    "build:esm": "rimraf index.mjs && rollup -c rollup.config.mjs -f esm -o index.mjs",
+    "build:prod": "yarn build"
+  },
+  "devDependencies": {
+    "@rollup/plugin-json": "^6.1.0",
+    "rimraf": "^6.0.1",
+    "rollup": "^4.52.0",
+    "typescript": "^5.6.3"
+  },
+  "module": "index.mjs",
   "nx": {}
 }

packages/root/package.json

@@ -0,0 +1,7 @@
+import json from '@rollup/plugin-json'
+
+export default {
+  input: 'index.ts',
+  // inlines the root package.json into the bundle
+  plugins: [json()],
+}