feat: external support RegExp and not external sub path of package (#673)

XGHeaven · web-flow · commit 9f732e5cd066 · 2025-04-17T12:01:37.000+08:00
* feat: external support RegExp and not external sub path of package

* fix: remove duplicate push
diff --git a/.changeset/dry-pots-buy.md b/.changeset/dry-pots-buy.md
@@ -0,0 +1,5 @@
+---
+'@ice/pkg': major
+---
+
+feat: external support RegExp and not external sub path of package
diff --git a/.github/workflows/release-next.yml b/.github/workflows/release-next.yml
@@ -1,4 +1,4 @@
-name: Release
+name: Release Next
 
 on:
   push:
diff --git a/packages/pkg/src/helpers/builtinModules.ts b/packages/pkg/src/helpers/builtinModules.ts
@@ -1,43 +1,112 @@
 // Copy from https://github.com/sindresorhus/builtin-modules#readme
 export const builtinNodeModules = [
+  'node:assert',
   'assert',
+  'node:assert/strict',
+  'assert/strict',
+  'node:async_hooks',
   'async_hooks',
+  'node:buffer',
   'buffer',
+  'node:child_process',
   'child_process',
+  'node:cluster',
   'cluster',
+  'node:console',
   'console',
+  'node:constants',
   'constants',
+  'node:crypto',
   'crypto',
+  'node:dgram',
   'dgram',
+  'node:diagnostics_channel',
+  'diagnostics_channel',
+  'node:dns',
   'dns',
+  'node:dns/promises',
+  'dns/promises',
+  'node:domain',
   'domain',
+  'node:events',
   'events',
+  'node:fs',
   'fs',
+  'node:fs/promises',
+  'fs/promises',
+  'node:http',
   'http',
+  'node:http2',
   'http2',
+  'node:https',
   'https',
+  'node:inspector',
   'inspector',
+  'node:inspector/promises',
+  'inspector/promises',
+  'node:module',
   'module',
+  'node:net',
   'net',
+  'node:os',
   'os',
+  'node:path',
   'path',
+  'node:path/posix',
+  'path/posix',
+  'node:path/win32',
+  'path/win32',
+  'node:perf_hooks',
   'perf_hooks',
+  'node:process',
   'process',
-  'punycode',
+  'node:querystring',
   'querystring',
+  'node:quic',
+  'node:readline',
   'readline',
+  'node:readline/promises',
+  'readline/promises',
+  'node:repl',
   'repl',
+  'node:sea',
+  'node:sqlite',
+  'node:stream',
   'stream',
+  'node:stream/consumers',
+  'stream/consumers',
+  'node:stream/promises',
+  'stream/promises',
+  'node:stream/web',
+  'stream/web',
+  'node:string_decoder',
   'string_decoder',
+  'node:test',
+  'node:test/reporters',
+  'node:timers',
   'timers',
+  'node:timers/promises',
+  'timers/promises',
+  'node:tls',
   'tls',
+  'node:trace_events',
   'trace_events',
+  'node:tty',
   'tty',
+  'node:url',
   'url',
+  'node:util',
   'util',
+  'node:util/types',
+  'util/types',
+  'node:v8',
   'v8',
+  'node:vm',
   'vm',
+  'node:wasi',
   'wasi',
+  'node:worker_threads',
   'worker_threads',
+  'node:zlib',
   'zlib',
 ];
diff --git a/packages/pkg/src/helpers/getRollupOptions.ts b/packages/pkg/src/helpers/getRollupOptions.ts
@@ -216,44 +216,57 @@ function getRollupOutputs({
   }));
 }
 
+const BUILTIN_EXTERNAL_MAP: Record<string, string[]> = {
+  'builtin:normal': [
+    'core-js',
+    'regenerator-runtime',
+  ],
+  'builtin:node': builtinNodeModules,
+}
+
 function getExternalsAndGlobals(
   bundleTaskConfig: BundleTaskConfig,
   pkg: PkgJson,
 ): [(id?: string) => boolean, Record<string, string>] {
-  let externals: string[] = [];
-  let globals: Record<string, string> = {};
+  // TODO: unique externals after all pushed
+  const exactExternals: string[] = [];
+  const regexpExternals: RegExp[] = [];
+  const globals: Record<string, string> = {};
 
-  const builtinExternals = [
-    'react/jsx-runtime',
-    'core-js',
-    'regenerator-runtime',
-  ];
+  const userExternals = bundleTaskConfig.externals ?? false;
 
-  const externalsConfig = bundleTaskConfig.externals ?? false;
-
-  switch (externalsConfig) {
-    case true:
-      externals = [
-        ...builtinNodeModules,
-        ...builtinExternals,
-        ...Object.keys(pkg.dependencies ?? {}),
-        ...Object.keys(pkg.peerDependencies ?? {}),
-      ];
-      break;
-    case false:
-      externals = [];
-      break;
-    default:
-      externals = Object.keys(externalsConfig);
-      globals = externalsConfig;
-      break;
+  if (userExternals === true) {
+    exactExternals.push(
+      ...BUILTIN_EXTERNAL_MAP['builtin:normal'],
+      ...BUILTIN_EXTERNAL_MAP['builtin:node'],
+      ...Object.keys(pkg.dependencies ?? {}),
+      ...Object.keys(pkg.peerDependencies ?? {}),
+    )
+  } else if (userExternals === false) {
+    // do nothing
+  } else if (Array.isArray(userExternals)) {
+    for (const item of userExternals) {
+      if (typeof item === 'string') {
+        if (item in BUILTIN_EXTERNAL_MAP) {
+          exactExternals.push(...BUILTIN_EXTERNAL_MAP[item]);
+        } else {
+          exactExternals.push(item);
+        }
+      } else if (item instanceof RegExp) {
+        regexpExternals.push(item);
+      } else if (typeof item === 'object') {
+        exactExternals.push(...Object.keys(item));
+        Object.assign(globals, item)
+      }
+    }
+  } else if (typeof userExternals === 'object') {
+    exactExternals.push(...Object.keys(userExternals));
+    Object.assign(globals, userExternals);
   }
 
-  const externalPredicate = new RegExp(`^(${externals.map(escapeStringRegexp).join('|')})($|/)`);
-
-  const externalFun = externals.length === 0
+  const externalFun = !exactExternals.length && !regexpExternals.length
     ? () => false
-    : (id: string) => externalPredicate.test(id);
+    : (id: string) => exactExternals.includes(id) || regexpExternals.some(reg => reg.test(id));
 
   return [externalFun, globals];
 }
diff --git a/packages/pkg/src/types.ts b/packages/pkg/src/types.ts
@@ -96,9 +96,11 @@ export interface BundleUserConfig {
    * Specify external dependencies.
    * "boolean" - whether to bundle all dependencies or not;
    * "object" - specific external dependencies.
-   * @default false All of dependencies will be bundled by default.
+   * "array" - specific external match logic
+   * "false" - all the dependencies will be bundled by default.
+   * @default false
    */
-  externals?: boolean | Record<string, string>;
+  externals?: boolean | Record<string, string> | (string | RegExp | Record<string, string>)[];
 
   /**
    * Minify JS and CSS bundle.
diff --git a/website/docs/reference/config.md b/website/docs/reference/config.md
@@ -373,10 +373,12 @@ export default defineConfig({
 
 #### externals
 
-+ 类型：`boolean | Record<string, string>`
-+ 默认值：`true`
++ 类型：`boolean | Record<string, string> | (string | RegExp | Record<string, string>)[]`
++ 默认值：`false`
 
-默认情况下，bundle 的产物包含所有依赖产物。该选项可修改这一结果。若想要 Bundle 不包含依赖产物，可如下配置：
+默认情况下，bundle 的产物包含所有依赖产物。该选项可修改这一结果。
+若想要 Bundle 不包含依赖产物，可以传入 `true`，其会解析 `package.json` 并将所有依赖 external 掉，包括 node 的依赖。
+适合针对 Node 环境的构建。
 
 ```ts title="build.config.mts"
 import { defineConfig } from '@ice/pkg';
@@ -388,7 +390,18 @@ export default defineConfig({
 });
 ```
 
-若想要自定义配置 externals，参考如下配置：
+若想要自定义配置 externals，则可以直接传入想要 external 的依赖，支持字符串和正则表达式。
+
+```ts title="build.config.mts"
+import { defineConfig } from '@ice/pkg';
+export default defineConfig({
+  bundle: {
+    externals: ['react', 'react-dom', /^@ice($|\/)/],
+  },
+});
+```
+
+如果你选择构建 umd 格式，默认情况下会根据一定的规则生成从全局对象上获取依赖的名字，如果你想自定义，则可以直接传入一个对象来配置。
 
 ```ts title="build.config.mts"
 import { defineConfig } from '@ice/pkg';
@@ -403,6 +416,8 @@ export default defineConfig({
 });
 ```
 
+当然，也可以进行混合使用。
+
 #### minify
 
 + 类型：`boolean | { js?: boolean | ((mode: string, command: string) => boolean | { options?: swc.JsMinifyOptions }); css?: boolean | ((mode: string, command: string) => boolean | { options?: cssnano.Options });}`

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@ice/pkg': major
 +---
++
 +feat: external support RegExp and not external sub path of package
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-name: Release`
	`1`	`+name: Release Next`
`2`	`2`
`3`	`3`	`on:`
`4`	`4`	`push:`