Merge pull request #1699 from glimmerjs/cjs-womp

Re-enable CJS for @glimmer/compiler (used by babel plugin)
glimmerjs · Feb 8, 2025 · 52e4509 · 52e4509
2 parents 72ce402 + 3bb89eb
commit 52e4509
Show file tree

Hide file tree

Showing 7 changed files with 86 additions and 18 deletions.
diff --git a/.meta-updater/main.mjs b/.meta-updater/main.mjs
@@ -84,6 +84,13 @@ export default () =>
                   types: './dist/dev/index.d.ts',
                   default: './dist/dev/index.js',
                 },
+                ...(pkg['repo-meta']?.supportcjs
+                  ? {
+                      require: {
+                        default: './dist/dev/index.cjs',
+                      },
+                    }
+                  : {}),
                 default: {
                   types: './dist/prod/index.d.ts',
                   default: './dist/prod/index.js',

diff --git a/packages/@glimmer-workspace/build/lib/config.d.ts b/packages/@glimmer-workspace/build/lib/config.d.ts
@@ -5,6 +5,7 @@ export interface PackageInfo {
   readonly name: string;
   readonly root: string;
   readonly exports: string;
+  readonly publishConfig: object;
   readonly devDependencies: Record<string, string>;
 }
 
@@ -27,6 +28,7 @@ export interface PackageJSON {
   readonly types: string;
   readonly private: boolean;
   readonly name: string;
+  readonly publishConfig: object;
 }
 
 type SimpleExternal = { [P in string]: 'inline' | 'external' };

diff --git a/packages/@glimmer-workspace/build/lib/config.js b/packages/@glimmer-workspace/build/lib/config.js
@@ -215,6 +215,7 @@ export class Package {
       return new Package({
         name: json.name,
         exports: resolve(root, json.exports),
+        publishConfig: json.publishConfig,
         root,
         devDependencies: json['devDependencies'] ?? {},
       });
@@ -226,6 +227,7 @@ export class Package {
             name: json.name,
             exports: path,
             root,
+            publishConfig: json.publishConfig,
             devDependencies: json['devDependencies'] ?? {},
           });
         }
@@ -299,6 +301,13 @@ export class Package {
     return this.#package.root;
   }
 
+  /**
+   * @returns {object}
+   */
+  get publishConfig() {
+    return this.#package.publishConfig;
+  }
+
   /**
    * @returns {import("rollup").RollupOptions[] | import("rollup").RollupOptions}
    */
@@ -308,6 +317,10 @@ export class Package {
     builds.push(...this.rollupESM({ env: 'dev' }));
     builds.push(...this.rollupESM({ env: 'prod' }));
 
+    if (JSON.stringify(this.publishConfig).includes('require')) {
+      builds.push(...this.rollupCJS({ env: 'dev' }));
+    }
+
     return builds;
   }
 
@@ -327,6 +340,38 @@ export class Package {
     });
   }
 
+  /**
+   * NOTE: CJS is intended for node environments where code duplication
+   * doesn't matter so much.
+   * In particular, only meant for:
+   * - @glimmer/compiler
+   *
+   * @param {RollupConfigurationOptions} options
+   * @returns {RollupOptions[]}
+   */
+  rollupCJS({ env }) {
+    return this.#shared('cjs', env).map(
+      (options) =>
+        /** @satisfies {RollupOptions} */ ({
+          ...options,
+          plugins: [
+            nodeResolve({ extensions: ['.js', '.ts'] }),
+            ...this.replacements(env),
+            rollupSWC({
+              swc: {
+                jsc: {
+                  parser: {
+                    syntax: 'typescript',
+                  },
+                  target: 'es2022',
+                },
+              },
+            }),
+          ],
+        })
+    );
+  }
+
   /**
    * @typedef {object} RollupConfigurationOptions
    * @property {'dev' | 'prod'} env

diff --git a/packages/@glimmer/compiler/package.json b/packages/@glimmer/compiler/package.json
@@ -9,6 +9,9 @@
   },
   "type": "module",
   "exports": "./index.ts",
+  "repo-meta": {
+    "supportcjs": true
+  },
   "publishConfig": {
     "access": "public",
     "exports": {
@@ -17,6 +20,9 @@
           "types": "./dist/dev/index.d.ts",
           "default": "./dist/dev/index.js"
         },
+        "require": {
+          "default": "./dist/dev/index.cjs"
+        },
         "default": {
           "types": "./dist/prod/index.d.ts",
           "default": "./dist/prod/index.js"

diff --git a/repo-metadata/lib/types.d.ts b/repo-metadata/lib/types.d.ts
@@ -66,6 +66,11 @@ export interface RepoMetaForPackage {
    * Whether this package has buildable entry points and therefore needs to be built.
    */
   built?: true;
+
+  /**
+   * Whether this package has to support CJS (usually for legacy reasons)
+   */
+  supportcjs?: true;
 }
 
 type RepoMetaEnv = 'node' | 'console' | 'qunit' | 'decorator:classic';
@@ -79,6 +84,7 @@ export interface PackageInfo {
   entryPoints?: PackageEntryPoints;
   'repo-meta'?: {
     strictness?: 'strict' | 'loose';
+    supportcjs?: boolean;
     env?: RepoMetaEnv[];
     lint?: string[];
     built: boolean;

diff --git a/repo-metadata/lib/update.ts b/repo-metadata/lib/update.ts
@@ -90,6 +90,7 @@ const packagesMetadata = packages.map((pkg) => {
     if (repoMeta.lint) meta.lint = Array.isArray(repoMeta.lint) ? repoMeta.lint : [repoMeta.lint];
     if (repoMeta.env) meta.env = repoMeta.env;
     if (repoMeta.built) meta.built = repoMeta.built;
+    if (repoMeta.supportcjs) meta.supportcjs = repoMeta.supportcjs;
   }
 
   if (Object.keys(entryPoints).length > 0) {

diff --git a/repo-metadata/metadata.json b/repo-metadata/metadata.json
@@ -167,11 +167,12 @@
     {
       "root": "packages/@glimmer/compiler",
       "name": "@glimmer/compiler",
-      "version": "0.94.2",
+      "version": "0.94.3",
       "type": "module",
       "private": false,
       "repo-meta": {
-        "built": true
+        "built": true,
+        "supportcjs": true
       },
       "entryPoints": {
         ".": [[["default"], "./index.ts"]]
@@ -274,7 +275,7 @@
     {
       "root": "packages/@glimmer/destroyable",
       "name": "@glimmer/destroyable",
-      "version": "0.94.2",
+      "version": "0.94.3",
       "type": "module",
       "private": false,
       "repo-meta": {
@@ -300,7 +301,7 @@
     {
       "root": "packages/@glimmer/encoder",
       "name": "@glimmer/encoder",
-      "version": "0.93.2",
+      "version": "0.93.3",
       "type": "module",
       "private": false,
       "repo-meta": {
@@ -313,7 +314,7 @@
     {
       "root": "packages/@glimmer/global-context",
       "name": "@glimmer/global-context",
-      "version": "0.93.1",
+      "version": "0.93.2",
       "type": "module",
       "private": false,
       "repo-meta": {
@@ -366,7 +367,7 @@
     {
       "root": "packages/@glimmer/manager",
       "name": "@glimmer/manager",
-      "version": "0.94.2",
+      "version": "0.94.3",
       "type": "module",
       "private": false,
       "repo-meta": {
@@ -393,7 +394,7 @@
     {
       "root": "packages/@glimmer/node",
       "name": "@glimmer/node",
-      "version": "0.94.2",
+      "version": "0.94.3",
       "type": "module",
       "private": false,
       "repo-meta": {
@@ -406,7 +407,7 @@
     {
       "root": "packages/@glimmer/opcode-compiler",
       "name": "@glimmer/opcode-compiler",
-      "version": "0.94.2",
+      "version": "0.94.3",
       "type": "module",
       "private": false,
       "repo-meta": {
@@ -419,7 +420,7 @@
     {
       "root": "packages/@glimmer/owner",
       "name": "@glimmer/owner",
-      "version": "0.93.1",
+      "version": "0.93.2",
       "type": "module",
       "private": false,
       "repo-meta": {
@@ -445,7 +446,7 @@
     {
       "root": "packages/@glimmer/program",
       "name": "@glimmer/program",
-      "version": "0.94.2",
+      "version": "0.94.3",
       "type": "module",
       "private": false,
       "repo-meta": {
@@ -471,7 +472,7 @@
     {
       "root": "packages/@glimmer/reference",
       "name": "@glimmer/reference",
-      "version": "0.94.2",
+      "version": "0.94.3",
       "type": "module",
       "private": false,
       "repo-meta": {
@@ -497,7 +498,7 @@
     {
       "root": "packages/@glimmer/runtime",
       "name": "@glimmer/runtime",
-      "version": "0.94.2",
+      "version": "0.94.3",
       "type": "module",
       "private": false,
       "repo-meta": {
@@ -510,7 +511,7 @@
     {
       "root": "packages/@glimmer/syntax",
       "name": "@glimmer/syntax",
-      "version": "0.94.2",
+      "version": "0.94.3",
       "type": "module",
       "private": false,
       "repo-meta": {
@@ -536,7 +537,7 @@
     {
       "root": "packages/@glimmer/util",
       "name": "@glimmer/util",
-      "version": "0.94.2",
+      "version": "0.94.3",
       "type": "module",
       "private": false,
       "repo-meta": {
@@ -562,7 +563,7 @@
     {
       "root": "packages/@glimmer/validator",
       "name": "@glimmer/validator",
-      "version": "0.94.2",
+      "version": "0.94.3",
       "type": "module",
       "private": false,
       "repo-meta": {
@@ -589,7 +590,7 @@
     {
       "root": "packages/@glimmer/vm",
       "name": "@glimmer/vm",
-      "version": "0.94.2",
+      "version": "0.94.3",
       "type": "module",
       "private": false,
       "repo-meta": {
@@ -602,7 +603,7 @@
     {
       "root": "packages/@glimmer/vm-babel-plugins",
       "name": "@glimmer/vm-babel-plugins",
-      "version": "0.93.1",
+      "version": "0.93.2",
       "type": "module",
       "private": false,
       "repo-meta": {
@@ -615,7 +616,7 @@
     {
       "root": "packages/@glimmer/wire-format",
       "name": "@glimmer/wire-format",
-      "version": "0.94.2",
+      "version": "0.94.3",
       "type": "module",
       "private": false,
       "repo-meta": {