feat(scripts): Rework bundle script to support bundling yarn plugins (#3519)

* add script to bundle yarn plugins

* update bundle command to treat platform as a preset selector, including yarn

* docs(changeset):

* dedupe packages in lockfile

* Apply suggestions from code review

Co-authored-by: Tommy Nguyen <4123478+tido64@users.noreply.github.com>

* add missing yarn bundle setting and code review feedback

---------

Co-authored-by: Tommy Nguyen <4123478+tido64@users.noreply.github.com>

Author: JasonVMo

.changeset/mean-lions-hammer.md

@@ -0,0 +1,2 @@
+---
+---

scripts/package.json

@@ -13,6 +13,7 @@
     "lint": "rnx-kit-scripts lint"
   },
   "dependencies": {
+    "@yarnpkg/cli": "^4.6.0",
     "esbuild": "^0.25.0",
     "eslint": "^9.0.0",
     "fast-glob": "^3.2.7",

scripts/src/commands/bundle.js

@@ -1,53 +1,155 @@
 // @ts-check
 
+import { getDynamicLibs } from "@yarnpkg/cli";
 import * as fs from "node:fs";
 
-const defaultOptions = {
-  minify: false,
-  platform: "node",
+/**
+ * @typedef {import("esbuild").BuildOptions} BuildOptions
+ * @typedef {BuildOptions["platform"]} Platform
+ * @typedef {{ node?: string }} Engines
+ * @typedef {{ name: string, main: string, dependencies?: Record<string, string>, peerDependencies?: Record<string, string>, engines?: Record<string, string> }} Manifest
+ * @typedef {{ minify?: boolean, platform?: string, sourceMap?: boolean }} BundleOptions
+ * @typedef {(manifest: Manifest) => Partial<BuildOptions>} OptionPreset
+ */
+
+const defaultTarget = "es2021";
+const defaultNodeTarget = "node16.17";
+
+/**
+ * @param {Manifest} manifest
+ * @returns {Partial<BuildOptions>}
+ */
+function presetBase(manifest) {
+  const { dependencies, peerDependencies } = manifest;
+  return {
+    external: [
+      ...(dependencies ? Object.keys(dependencies) : []),
+      ...(peerDependencies ? Object.keys(peerDependencies) : []),
+      "./package.json",
+    ],
+    conditions: ["typescript"],
+  };
+}
+
+/**
+ * @param {Manifest} manifest
+ * @returns {Partial<BuildOptions>}
+ */
+function nodePreset(manifest) {
+  return {
+    ...presetBase(manifest),
+    banner: { js: "#!/usr/bin/env node" },
+    platform: "node",
+    target: getNodeTarget(manifest),
+  };
+}
+
+/**
+ * @param {Manifest} manifest
+ * @returns {Partial<BuildOptions>}
+ */
+function browserPreset(manifest) {
+  return {
+    ...presetBase(manifest),
+    platform: "browser",
+    target: defaultTarget,
+  };
+}
+
+/**
+ * @param {Manifest} manifest
+ * @returns {Partial<BuildOptions>}
+ */
+function neutralPreset(manifest) {
+  return {
+    ...presetBase(manifest),
+    platform: "neutral",
+    target: defaultTarget,
+  };
+}
+
+/**
+ * @param {Manifest} manifest
+ * @returns {Partial<BuildOptions>}
+ */
+function yarnPreset(manifest) {
+  const name = manifest.name;
+  return {
+    banner: {
+      js: [
+        `/* eslint-disable */`,
+        `//prettier-ignore`,
+        `module.exports = {`,
+        `name: ${JSON.stringify(name)},`,
+        `factory: function (require) {`,
+      ].join(`\n`),
+    },
+    globalName: `plugin`,
+    format: "iife",
+    footer: {
+      js: [`return plugin;`, `}`, `};`].join(`\n`),
+    },
+    resolveExtensions: [`.tsx`, `.ts`, `.jsx`, `.mjs`, `.js`, `.css`, `.json`],
+    external: [...getDynamicLibs().keys()],
+    platform: "node",
+    target: getNodeTarget(manifest),
+    supported: {
+      /*
+      Yarn plugin-runtime did not support builtin modules prefixed with "node:".
+      See https://github.com/yarnpkg/berry/pull/5997
+      As a solution, and for backwards compatibility, esbuild should strip these prefixes.
+      */
+      "node-colon-prefix-import": false,
+      "node-colon-prefix-require": false,
+    },
+  };
+}
+
+/** @type {Record<string, OptionPreset>} */
+const presets = {
+  node: nodePreset,
+  browser: browserPreset,
+  neutral: neutralPreset,
+  yarn: yarnPreset,
 };
 
 /**
  * @param {unknown} platform
- * @returns {"browser" | "neutral" | "node"}
+ * @param {Manifest} manifest
+ * @returns {Partial<BuildOptions>}
  */
-function ensureValidPlatform(platform) {
-  switch (platform) {
-    case "browser":
-    case "neutral":
-    case "node":
-      return platform;
+function platformOptions(platform, manifest) {
+  const platformKey = typeof platform === "string" ? platform : "node";
+  const preset = presets[platformKey] || presets.node;
+  return preset(manifest);
+}
 
-    default:
-      return "node";
-  }
+/**
+ * @param {Manifest} manifest
+ * @returns {string}
+ */
+function getNodeTarget(manifest) {
+  const enginesNode = manifest.engines?.node;
+  const match = enginesNode?.match(/(\d+)\.(\d+)/);
+  return match ? `node${match[1]}.${match[2]}` : defaultNodeTarget;
 }
 
 /**
  * @param {Record<string, unknown> | undefined} options
  */
 export async function bundle(options) {
-  const { minify, platform } = { ...defaultOptions, ...options };
-  const targetPlatform = ensureValidPlatform(platform);
+  const { minify, platform, sourceMap } = options || {};
 
-  const manifest = fs.readFileSync("package.json", { encoding: "utf-8" });
-  const { main, dependencies, peerDependencies } = JSON.parse(manifest);
+  const manifestFile = fs.readFileSync("package.json", { encoding: "utf-8" });
+  const manifest = JSON.parse(manifestFile);
 
   const esbuild = await import("esbuild");
   await esbuild.build({
+    ...platformOptions(platform, manifest),
     bundle: true,
-    outfile: main,
-    external: [
-      ...(dependencies ? Object.keys(dependencies) : []),
-      ...(peerDependencies ? Object.keys(peerDependencies) : []),
-      "./package.json",
-    ],
-    conditions: ["typescript"],
-    banner:
-      targetPlatform === "node" ? { js: "#!/usr/bin/env node" } : undefined,
+    outfile: manifest.main,
     entryPoints: ["src/index.ts"],
-    target: targetPlatform === "node" ? "node16.17.0" : "es2021",
-    platform: targetPlatform,
     minify: Boolean(minify),
+    sourcemap: Boolean(sourceMap),
   });
 }