feat: provide cjs pkg entrypoints

relates google#340 google#399 google#282 google#197

Author: antongolub

.github/workflows/test.yml

@@ -78,3 +78,24 @@ jobs:
         timeout-minutes: 1
         env:
           FORCE_COLOR: 3
+
+  smoke-node:
+    runs-on: ubuntu-latest
+    needs: build
+    strategy:
+      matrix:
+        node-version: [ 12, 14, 16, 18, 20 ]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+      - uses: actions/download-artifact@v4
+        with:
+          name: build
+      - name: cjs smoke test
+        run: npm run test:smoke:cjs
+      - name: mjs smoke test
+        if: matrix.node-version != '12'
+        run: npm run test:smoke:mjs

package-lock.json

@@ -22,31 +22,53 @@
     }
   },
   "exports": {
-    ".": "./build/index.js",
-    "./globals": "./build/globals.js",
-    "./cli": "./build/cli.js",
-    "./core": "./build/core.js",
+    ".": {
+      "import": "./build/index.js",
+      "require": "./build/index.cjs",
+      "types": "./build/index.d.ts",
+      "default": "./build/index.js"
+    },
+    "./globals": {
+      "import": "./build/globals.js",
+      "require": "./build/globals.cjs",
+      "types": "./build/globals.d.ts",
+      "default": "./build/globals.js"
+    },
+    "./cli": {
+      "import": "./build/cli.js",
+      "require": "./build/cli.cjs",
+      "types": "./build/cli.d.ts",
+      "default": "./build/cli.js"
+    },
+    "./core": {
+      "import": "./build/core.js",
+      "require": "./build/core.cjs",
+      "types": "./build/core.d.ts",
+      "default": "./build/core.js"
+    },
     "./package.json": "./package.json"
   },
   "bin": {
     "zx": "./build/cli.js"
   },
   "engines": {
-    "node": ">= 16.0.0"
+    "node": ">= 12.0.0"
   },
   "scripts": {
     "fmt": "prettier --write .",
     "fmt:check": "prettier --check .",
     "build": "npm run build:js && npm run build:dts",
     "build:check": "tsc",
-    "build:js": "node scripts/build-js.mjs --format=esm --entry=src/*.ts && npm run build:vendor",
-    "build:vendor": "node scripts/build-js.mjs --format=esm --entry=src/vendor.ts --bundle=all --banner",
+    "build:js": "node scripts/build-js.mjs --format=cjs --hybrid --entry=src/*.ts && npm run build:vendor",
+    "build:vendor": "node scripts/build-js.mjs --format=cjs --entry=src/vendor.ts --bundle=all",
     "build:dts": "tsc --project tsconfig.prod.json && node scripts/build-dts.mjs",
     "test": "npm run build && npm run test:unit && npm run test:types",
     "test:unit": "node ./test/all.test.js",
     "test:types": "tsd",
     "test:smoke:bun": "bun test ./test/smoke/bun.test.js",
     "test:smoke:win32": "node ./test/smoke/win32.test.js",
+    "test:smoke:cjs": "node ./test/smoke/node.test.cjs",
+    "test:smoke:mjs": "node ./test/smoke/node.test.mjs",
     "coverage": "c8 -x build/vendor.js -x 'test/**' -x scripts --check-coverage npm test",
     "circular": "madge --circular src/*",
     "version": "cat package.json | fx .version"
@@ -60,27 +82,31 @@
     "@types/minimist": "^1.2.5",
     "@types/node": ">=20.11.30",
     "@types/which": "^3.0.3",
-    "@webpod/ps": "^0.0.0-beta.3",
     "@webpod/ingrid": "^0.0.0-beta.3",
+    "@webpod/ps": "^0.0.0-beta.3",
     "c8": "^9.1.0",
     "chalk": "^5.3.0",
+    "create-require": "^1.1.1",
     "depseek": "^0.4.1",
     "dts-bundle-generator": "^9.3.1",
     "esbuild": "^0.20.2",
     "esbuild-node-externals": "^1.13.0",
     "esbuild-plugin-entry-chunks": "^0.1.12",
+    "esbuild-plugin-hybrid-export": "^0.2.0",
+    "esbuild-plugin-transform-hook": "^0.0.0",
     "fs-extra": "^11.2.0",
     "fx": "*",
     "globby": "^14.0.1",
     "madge": "^6.1.0",
     "minimist": "^1.2.8",
+    "node-abort-controller": "^3.1.1",
     "node-fetch-native": "^1.6.4",
     "prettier": "^3.2.5",
     "tsd": "^0.31.0",
     "typescript": "^5.4.4",
     "which": "^4.0.0",
     "yaml": "^2.4.1",
-    "zurk": "^0.1.2"
+    "zurk": "^0.1.4"
   },
   "publishConfig": {
     "registry": "https://wombat-dressing-room.appspot.com"

package.json

@@ -18,6 +18,8 @@ import path from 'node:path'
 import esbuild from 'esbuild'
 import { nodeExternalsPlugin } from 'esbuild-node-externals'
 import { entryChunksPlugin } from 'esbuild-plugin-entry-chunks'
+import { hybridExportPlugin } from 'esbuild-plugin-hybrid-export'
+import { transformHookPlugin } from 'esbuild-plugin-transform-hook'
 import minimist from 'minimist'
 import glob from 'fast-glob'
 
@@ -33,7 +35,7 @@ const argv = minimist(process.argv.slice(2), {
     target: 'node12',
     cwd: process.cwd(),
   },
-  boolean: ['minify', 'sourcemap', 'banner'],
+  boolean: ['minify', 'sourcemap', 'banner', 'hybrid'],
   string: ['entry', 'external', 'bundle', 'license', 'format', 'map', 'cwd'],
 })
 const {
@@ -44,19 +46,29 @@ const {
   sourcemap,
   license,
   format,
+  hybrid,
   cwd: _cwd,
 } = argv
 
-const plugins = []
+const plugins = [transformHookPlugin({
+  hooks: [{
+    on: 'end',
+    pattern: /\.cjs/,
+    transform(contents) {
+      return contents
+        .replaceAll('"node:', '"')
+        .replaceAll('require("stream/promises")', 'require("stream").promises')
+        .replaceAll('require("fs/promises")', 'require("fs").promises')
+        .replaceAll('}).prototype', '}).prototype || {}')
+    }
+  }]
+})]
 const cwd = Array.isArray(_cwd) ? _cwd[_cwd.length - 1] : _cwd
 const entries = entry.split(/,\s?/)
 const entryPoints = entry.includes('*')
   ? await glob(entries, { absolute: false, onlyFiles: true, cwd, root: cwd })
   : entries.map((p) => path.relative(cwd, path.resolve(cwd, p)))
 
-console.log('cwd=', cwd)
-console.log('entryPoints=', entryPoints)
-
 const _bundle = bundle !== 'none' && !process.argv.includes('--no-bundle')
 const _external = _bundle ? external.split(',') : undefined // https://github.com/evanw/esbuild/issues/1466
 
@@ -70,6 +82,14 @@ if (bundle === 'src') {
   plugins.push(nodeExternalsPlugin())
 }
 
+if (hybrid) {
+  plugins.push(hybridExportPlugin({
+    loader: 'import',
+    to: 'build',
+    toExt: '.js'
+  }))
+}
+
 const formats = format.split(',')
 const banner =
   argv.banner && bundle === 'all'
@@ -95,7 +115,7 @@ const esmConfig = {
   target: 'esnext',
   format: 'esm',
   outExtension: {
-    // '.js': '.mjs'
+    '.js': '.mjs'
   },
   plugins,
   legalComments: license,
@@ -111,12 +131,18 @@ const cjsConfig = {
   format: 'cjs',
   banner: {},
   outExtension: {
-    // '.js': '.cjs'
+    '.js': '.cjs'
+  },
+  // https://github.com/evanw/esbuild/issues/1633
+  define: {
+    'import.meta.url': 'import_meta_url'
   },
+  inject: ['./scripts/import.meta.url-polyfill.js']
 }
 
 for (const format of formats) {
   const config = format === 'cjs' ? cjsConfig : esmConfig
+  console.log('config=', config)
 
   await esbuild.build(config).catch(() => process.exit(1))
 }

scripts/build-js.mjs

@@ -0,0 +1,3 @@
+export const import_meta_url =
+  typeof document === 'undefined' ? new (require('url'.replace('', '')).URL)('file:' + __filename).href :
+    (document.currentScript && document.currentScript.src || new URL('main.js', document.baseURI).href)

scripts/import.meta.url-polyfill.js

@@ -14,7 +14,6 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import { createRequire } from 'node:module'
 import { basename, dirname, extname, join, resolve } from 'node:path'
 import url from 'node:url'
 import {
@@ -26,8 +25,9 @@ import {
   minimist,
   fs,
 } from './index.js'
-import { randomId } from './util.js'
 import { installDeps, parseDeps } from './deps.js'
+import { randomId } from './util.js'
+import { createRequire } from './vendor.js'
 
 function printUsage() {
   // language=txt
@@ -56,9 +56,9 @@ const argv = minimist(process.argv.slice(2), {
   boolean: ['version', 'help', 'quiet', 'verbose', 'install', 'repl'],
   alias: { e: 'eval', i: 'install', v: 'version', h: 'help' },
   stopEarly: true,
-})
+});
 
-await (async function main() {
+(async function main() {
   const globals = './globals.js'
   await import(globals)
   if (argv.verbose) $.verbose = true

src/cli.ts

@@ -28,9 +28,17 @@ import {
 import * as yaml from 'yaml'
 import * as _fs from 'fs-extra'
 import type { fetch } from 'node-fetch-native'
+import { AbortController } from 'node-abort-controller'
 
 export { exec, buildCmd } from 'zurk/spawn'
 
+import _createRequire  from 'create-require'
+import { URL } from 'url'
+
+export const createRequire = (_createRequire) as unknown as (filename: string | URL) => NodeRequire
+
+global.AbortController = global.AbortController || AbortController
+
 export { fetch as nodeFetch } from 'node-fetch-native'
 export type RequestInfo = Parameters<typeof fetch>[0]
 export type RequestInit = Parameters<typeof fetch>[1]

src/vendor.ts

@@ -15,11 +15,14 @@
 import assert from 'node:assert'
 import fs from 'node:fs/promises'
 import { test, describe } from 'node:test'
-import { globby } from 'globby'
+import { globby } from '../build/index.js'
 
 describe('extra', () => {
   test('every file should have a license', async () => {
-    const files = await globby(['**/*.{js,mjs,ts}'], {
+    const files = await globby([
+      '**/*.{js,mjs,ts}',
+      '!**/*-polyfill.js'
+    ], {
       gitignore: true,
       onlyFiles: true,
       cwd: process.cwd(),