[test] Add make test-dist-esm-plain-esbuild-compat.

Author: lgarron

.github/workflows/build.yml

@@ -32,6 +32,7 @@ jobs:
       - run: npm install
       - run: make build
       - run: make test-dist-esm-node-import
+      - run: make test-dist-esm-plain-esbuild-compat
       - run: make test-dist-esm-perf
       - run: make build-site-twizzle
       - run: make build-site-experiments

Makefile

@@ -2,7 +2,7 @@
 # https://github.com/lgarron/Makefile-scripts
 
 # Note: the first command becomes the default `make` target.
-NPM_COMMANDS = build build-esm build-bundle-global build-types build-bin build-sites build-site-twizzle build-site-experiments build-site-typedoc build-search-worker generate-js generate-js-parsers generate-js-svg dev link clean test test-dist-esm-node-import test-dist-esm-parcel test-dist-esm-perf test-dist-experiments test-dist-not-imported-from-src test-import-restrictions test-jest test-tsc format setup initial-setup lint prepack postpublish
+NPM_COMMANDS = build build-esm build-bundle-global build-types build-bin build-sites build-site-twizzle build-site-experiments build-site-typedoc build-search-worker generate-js generate-js-parsers generate-js-svg dev link clean test test-dist-esm-node-import test-dist-esm-parcel test-dist-esm-perf test-dist-esm-plain-esbuild-compat test-dist-experiments test-dist-not-imported-from-src test-import-restrictions test-jest test-tsc format setup initial-setup lint prepack postpublish
 
 .PHONY: $(NPM_COMMANDS)
 $(NPM_COMMANDS):

package.json

@@ -120,10 +120,11 @@
     "dev": "npm run initial-setup && node ./script/build/main.js sites dev",
     "link": "npm run build && npm link",
     "clean": "rm -rf dist .temp coverage src/cubing/search/search-worker-inside-generated* ./alg ./bluetooth ./kpuzzle ./notation ./protocol ./puzzle-geometry ./puzzles ./scramble ./search ./stream ./twisty",
-    "test": "npm run test-jest && npm run lint && npm run test-import-restrictions && npm run test-tsc # keep test.yml in sync with this",
+    "test": "npm run test-jest && npm run lint && npm run test-import-restrictions && npm run test-tsc # keep test.yml & build.yml in sync with this",
     "test-dist-esm-node-import": "node script/test/dist/esm/node-import/main.mjs",
     "test-dist-esm-parcel": "node ./script/test/dist/esm/parcel/main.js",
     "test-dist-esm-perf": "node script/test/dist/esm/perf/*.mjs",
+    "test-dist-esm-plain-esbuild-compat": "node script/test/dist/esm/plain-esbuild-compat/main.js",
     "test-dist-experiments": "node ./script/test/dist/experiments/main.js",
     "test-dist-not-imported-from-src": "node ./script/test/dist/not-imported-from-src/main.js",
     "test-import-restrictions": "node ./script/test/import-restrictions/main.js",
@@ -133,7 +134,7 @@
     "setup": "npm install",
     "initial-setup": "node ./script/initial-setup/main.js",
     "lint": "npx eslint --ext=js,ts src script",
-    "prepack": "npm run clean && npm run build && npm run test-dist-esm-node-import",
+    "prepack": "npm run clean && npm run build && npm run test-dist-esm-node-import && npm run test-dist-esm-plain-esbuild-compat",
     "postpublish": "echo -e '\n\nConsider updating `cdn.cubing.net` if you have access:\nhttps://github.com/cubing/cdn.cubing.net/blob/main/docs/maintenance.md#updating-cdncubingnet-to-a-new-cubing-version\n'"
   },
   "keywords": [

script/build/index.js

@@ -16,6 +16,7 @@ import { exists, mkdir, readFile, writeFile } from "fs";
 import { basename, join } from "path";
 import { promisify } from "util";
 import { execPromise, spawnPromise } from "../lib/execPromise.js";
+import { packageEntryPoints } from "../lib/packages.js";
 import { writeSyncUsingTempFile } from "./temp.js";
 
 const PARALLEL = false;
@@ -33,20 +34,6 @@ const ESM_CLASS_PRIVATE_ESBUILD_SUPPORTED = PUBLISH_WITH_PRIVATE_FIELDS
     }
   : {};
 
-const LIBRARY_ENTRY_POINTS = [
-  "src/cubing/alg/index.ts",
-  "src/cubing/bluetooth/index.ts",
-  "src/cubing/kpuzzle/index.ts",
-  "src/cubing/notation/index.ts",
-  "src/cubing/protocol/index.ts",
-  "src/cubing/puzzle-geometry/index.ts",
-  "src/cubing/puzzles/index.ts",
-  "src/cubing/scramble/index.ts",
-  "src/cubing/stream/index.ts",
-  "src/cubing/search/index.ts",
-  "src/cubing/twisty/index.ts",
-];
-
 const external = ["three", "comlink"];
 
 function plugins(dev) {
@@ -265,7 +252,7 @@ export const esmTarget = {
   buildSelf: async (dev) => {
     await esbuild.build({
       // TODO: construct entry points based on `exports` (see `staticPackageMetadataTarget`) and add tests.
-      entryPoints: LIBRARY_ENTRY_POINTS,
+      entryPoints: packageEntryPoints,
       outdir: "dist/esm",
       format: "esm",
       target: "es2020",
@@ -355,7 +342,7 @@ export const typesTarget = {
     }
     await spawnPromise("npx", [
       "tsup",
-      ...LIBRARY_ENTRY_POINTS,
+      ...packageEntryPoints,
       "--dts-only",
       "--out-dir",
       "dist/types",

script/lib/packages.js

@@ -0,0 +1,19 @@
+import { join } from "path";
+
+export const packageNames = [
+  "alg",
+  "bluetooth",
+  "kpuzzle",
+  "notation",
+  "protocol",
+  "puzzle-geometry",
+  "puzzles",
+  "scramble",
+  "stream",
+  "search",
+  "twisty",
+];
+
+export const packageEntryPoints = packageNames.map((p) =>
+  join("src/cubing/", p, "/index.ts"),
+);

script/test/dist/esm/plain-esbuild-compat/main.js

@@ -0,0 +1,26 @@
+import { join } from "path";
+import { stdout } from "process";
+import { execPromise } from "../../../../lib/execPromise.js";
+import { needFolder } from "../../../../lib/need-folder.js";
+import { packageNames } from "../../../../lib/packages.js";
+
+const OUT_DIR = "./.temp/plain-esbuild-compat";
+
+needFolder(
+  new URL("../../../../../dist/esm", import.meta.url).pathname,
+  "make build-esm",
+);
+
+const dist_entries = packageNames
+  .map((e) => join("dist/esm/", e, "/index.js"))
+  .join(" ");
+console.log(
+  `npx esbuild --bundle --splitting --outdir="${OUT_DIR}" --format=esm --minify ${dist_entries}`,
+);
+stdout.write(
+  "Testing that the ESM build can be transpiled by `esbuild` with default compat settings...",
+);
+await execPromise(
+  `npx esbuild --bundle --splitting --outdir="${OUT_DIR}" --format=esm --minify ${dist_entries}`,
+);
+console.log(" ✅ Success!");