Visitar URL original
feat(deps): support `neverBundle: true` to externalize all dependencies · rolldown/tsdown@d30a730 · GitHub
Skip to content

Commit d30a730

Browse files
sxzzsxzz
committed
feat(deps): support neverBundle: true to externalize all dependencies
Externalize all non-relative imports as written, without resolving them. Subpath imports (`#`) are still resolved: kept external if they resolve into `node_modules`, bundled if they map to local files. Can be combined with `alwaysBundle` to opt specific imports back into the bundle. Deprecate `skipNodeModulesBundle` in favor of `deps.neverBundle: true`. Also migrate tsup's `skipNodeModulesBundle` to the new option in `tsdown-migrate`, and make external decisions resolve lazily so bare dependency imports are externalized without any resolution. Closes #993 Closes #1009
1 parent d84c54a commit d30a730

27 files changed

Lines changed: 662 additions & 162 deletions

‎__snapshots__/tsnapi/index.snapshot.d.ts‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ export interface CopyEntry {
2525
rename?: string | ((_: string, _: string, _: string) => string);
2626
}
2727
export interface DepsConfig {
28-
neverBundle?: ExternalOption;
28+
neverBundle?: true | ExternalOption;
2929
alwaysBundle?: Arrayable<string | RegExp> | NoExternalFn;
3030
onlyBundle?: Arrayable<string | RegExp> | false;
3131
onlyImport?: Arrayable<string | RegExp>;
@@ -96,13 +96,10 @@ export interface ReportOptions {
9696
brotli?: boolean;
9797
maxCompressSize?: number;
9898
}
99-
export interface ResolvedDepsConfig {
100-
neverBundle?: ExternalOption;
99+
export interface ResolvedDepsConfig extends Pick<DepsConfig, "neverBundle" | "skipNodeModulesBundle" | "resolveDepSubpath"> {
101100
alwaysBundle?: NoExternalFn;
102101
onlyBundle?: Array<string | RegExp> | false;
103102
onlyImport?: Array<string | RegExp>;
104-
skipNodeModulesBundle: boolean;
105-
resolveDepSubpath: boolean;
106103
dts: Pick<ResolvedDepsConfig, "alwaysBundle" | "neverBundle">;
107104
}
108105
export interface RolldownContext {

‎__snapshots__/tsnapi/plugins.snapshot.d.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* Generated by tsnapi — public API snapshot of `tsdown/plugins`
33
*/
44
// #region Functions
5-
export declare function DepsPlugin({ pkg, deps: { alwaysBundle: jsAlwaysBundle, onlyBundle, onlyImport, skipNodeModulesBundle, resolveDepSubpath: shouldResolveDepSubpath, dts }, logger, nameLabel, platform }: ResolvedConfig, _: TsdownBundle): Plugin;
5+
export declare function DepsPlugin({ pkg, deps: { neverBundle, alwaysBundle: jsAlwaysBundle, onlyBundle, onlyImport, skipNodeModulesBundle, resolveDepSubpath: shouldResolveDepSubpath, dts }, logger, nameLabel, platform }: ResolvedConfig, _: TsdownBundle): Plugin;
66
export declare function NodeProtocolPlugin(_: "strip" | true): Plugin;
77
export declare function ReportPlugin(_: ResolvedConfig, _?: boolean, _?: boolean): Plugin;
88
export declare function ShebangPlugin(_: Logger, _: string, _?: string, _?: boolean): Plugin;

‎docs/guide/faq.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ By default, tsdown bundles all imported modules. To exclude dependencies (e.g.,
5454
```ts
5555
export default defineConfig({
5656
deps: {
57-
skipNodeModulesBundle: true,
57+
neverBundle: true,
5858
},
5959
})
6060
```

‎docs/guide/how-it-works.md‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,12 @@ When you publish a library, your consumers install its `dependencies`, `peerDepe
3333

3434
**Key options:**
3535

36-
| Option | What it does |
37-
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
38-
| [`deps.onlyBundle`](../options/dependencies.md#deps-onlybundle) | Whitelist of dependencies allowed to be bundled. Any unlisted dependency that ends up in the bundle causes an error. Useful for catching accidental inlining in large projects. |
39-
| [`deps.neverBundle`](../options/dependencies.md#deps-neverbundle) | Explicitly mark additional packages as external (never bundled). |
40-
| [`deps.alwaysBundle`](../options/dependencies.md#deps-alwaysbundle) | Force specific packages to be bundled, even if they're in `dependencies`. |
41-
| [`deps.skipNodeModulesBundle`](../options/dependencies.md#deps-skipnodemodulesbundle) | Skip bundling everything from `node_modules`. |
42-
| [`deps.resolveDepSubpath`](../options/dependencies.md#deps-resolvedepsubpath) | Resolve external dependency subpath imports to their actual package-relative paths. |
36+
| Option | What it does |
37+
| ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
38+
| [`deps.onlyBundle`](../options/dependencies.md#deps-onlybundle) | Whitelist of dependencies allowed to be bundled. Any unlisted dependency that ends up in the bundle causes an error. Useful for catching accidental inlining in large projects. |
39+
| [`deps.neverBundle`](../options/dependencies.md#deps-neverbundle) | Explicitly mark additional packages as external (never bundled), or `true` to externalize all dependencies. |
40+
| [`deps.alwaysBundle`](../options/dependencies.md#deps-alwaysbundle) | Force specific packages to be bundled, even if they're in `dependencies`. |
41+
| [`deps.resolveDepSubpath`](../options/dependencies.md#deps-resolvedepsubpath) | Resolve external dependency subpath imports to their actual package-relative paths. |
4342

4443
See [Dependencies](../options/dependencies.md) for details.
4544

‎docs/guide/migrate-from-tsup.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -64,16 +64,16 @@ Some options have been renamed for clarity:
6464

6565
The following tsup options still work in tsdown for backward compatibility, but they emit deprecation warnings and **will be removed in a future version**. Migrate them to the preferred alternatives immediately.
6666

67-
| tsup (deprecated) | tsdown (preferred) | Notes |
68-
| -------------------------- | --------------------------------------- | --------------------------------- |
69-
| `entryPoints` | `entry` | Also deprecated in tsup itself |
70-
| `publicDir` | `copy` | Copy static files to output |
71-
| `bundle: false` | `unbundle: true` | Inverted to positive form |
72-
| `removeNodeProtocol: true` | `nodeProtocol: 'strip'` | More flexible with multiple modes |
73-
| `injectStyle: true` | `css: { inject: true }` | Moved into CSS namespace |
74-
| `external: [...]` | `deps: { neverBundle: [...] }` | Moved to deps namespace |
75-
| `noExternal: [...]` | `deps: { alwaysBundle: [...] }` | Moved to deps namespace |
76-
| `skipNodeModulesBundle` | `deps: { skipNodeModulesBundle: true }` | Moved to deps namespace |
67+
| tsup (deprecated) | tsdown (preferred) | Notes |
68+
| -------------------------- | ------------------------------- | --------------------------------- |
69+
| `entryPoints` | `entry` | Also deprecated in tsup itself |
70+
| `publicDir` | `copy` | Copy static files to output |
71+
| `bundle: false` | `unbundle: true` | Inverted to positive form |
72+
| `removeNodeProtocol: true` | `nodeProtocol: 'strip'` | More flexible with multiple modes |
73+
| `injectStyle: true` | `css: { inject: true }` | Moved into CSS namespace |
74+
| `external: [...]` | `deps: { neverBundle: [...] }` | Moved to deps namespace |
75+
| `noExternal: [...]` | `deps: { alwaysBundle: [...] }` | Moved to deps namespace |
76+
| `skipNodeModulesBundle` | `deps: { neverBundle: true }` | Externalize all dependencies |
7777

7878
tsdown also adds `deps.onlyBundle` for whitelisting allowed bundled packages.
7979

‎docs/options/dependencies.md‎

Lines changed: 43 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -32,30 +32,15 @@ export default defineConfig({
3232
alwaysBundle: ['some-package'],
3333
onlyBundle: ['cac', 'bumpp'],
3434
onlyImport: ['cac'],
35-
skipNodeModulesBundle: true,
3635
resolveDepSubpath: false,
3736
},
3837
})
3938
```
4039

4140
### `deps.skipNodeModulesBundle`
4241

43-
If you want to **skip bundling all dependencies from `node_modules`**, you can enable `skipNodeModulesBundle`:
44-
45-
```ts [tsdown.config.ts]
46-
import { defineConfig } from 'tsdown'
47-
48-
export default defineConfig({
49-
deps: {
50-
skipNodeModulesBundle: true,
51-
},
52-
})
53-
```
54-
55-
This will prevent `tsdown` from bundling any dependencies from `node_modules`, regardless of how they are referenced in your code.
56-
57-
::: warning
58-
`skipNodeModulesBundle` cannot be used together with `alwaysBundle`. These options are mutually exclusive.
42+
::: warning Deprecated
43+
`skipNodeModulesBundle` is deprecated. Use [`deps.neverBundle: true`](#externalizing-all-dependencies) instead.
5944
:::
6045

6146
### `deps.resolveDepSubpath`
@@ -145,6 +130,38 @@ export default defineConfig({
145130

146131
In this example, `lodash` and all packages under the `@my-scope` namespace will be treated as external.
147132

133+
#### Externalizing All Dependencies
134+
135+
Set `neverBundle` to `true` to externalize **all** dependencies:
136+
137+
```ts [tsdown.config.ts]
138+
import { defineConfig } from 'tsdown'
139+
140+
export default defineConfig({
141+
deps: {
142+
neverBundle: true,
143+
},
144+
})
145+
```
146+
147+
When enabled, every import that follows npm package naming conventions (e.g. `lodash`, `@scope/pkg/utils`) is marked as external **as written, without being resolved**. This is faster than the deprecated `skipNodeModulesBundle` option and even works when dependencies are not installed. Note the following behaviors:
148+
149+
- Package specifiers are preserved exactly as written; subpaths like `my-dep/utils` are not rewritten, and `resolveDepSubpath` has no effect.
150+
- Other non-relative imports — [subpath imports](https://nodejs.org/api/packages.html#subpath-imports) starting with `#` and path aliases like `~/utils` — are still resolved: if they resolve into `node_modules`, they are kept external with the original specifier; otherwise the resolved local file is bundled.
151+
152+
Unlike the deprecated `skipNodeModulesBundle` option, `neverBundle: true` can be combined with `alwaysBundle` to bundle a few selected dependencies while externalizing everything else:
153+
154+
```ts [tsdown.config.ts]
155+
import { defineConfig } from 'tsdown'
156+
157+
export default defineConfig({
158+
deps: {
159+
neverBundle: true,
160+
alwaysBundle: ['some-package'],
161+
},
162+
})
163+
```
164+
148165
### `deps.alwaysBundle`
149166

150167
The `alwaysBundle` option allows you to force certain dependencies to be bundled, even if they are listed in `dependencies`, `peerDependencies`, or `optionalDependencies`. For example:
@@ -185,13 +202,14 @@ export default defineConfig({
185202

186203
The following top-level options are deprecated. Please migrate to the `deps` namespace:
187204

188-
| Deprecated Option | New Option |
189-
| ----------------------- | ---------------------------- |
190-
| `external` | `deps.neverBundle` |
191-
| `noExternal` | `deps.alwaysBundle` |
192-
| `inlineOnly` | `deps.onlyBundle` |
193-
| `deps.onlyAllowBundle` | `deps.onlyBundle` |
194-
| `skipNodeModulesBundle` | `deps.skipNodeModulesBundle` |
205+
| Deprecated Option | New Option |
206+
| ---------------------------- | ------------------------ |
207+
| `external` | `deps.neverBundle` |
208+
| `noExternal` | `deps.alwaysBundle` |
209+
| `inlineOnly` | `deps.onlyBundle` |
210+
| `deps.onlyAllowBundle` | `deps.onlyBundle` |
211+
| `skipNodeModulesBundle` | `deps.neverBundle: true` |
212+
| `deps.skipNodeModulesBundle` | `deps.neverBundle: true` |
195213

196214
## Summary
197215

@@ -201,9 +219,8 @@ The following top-level options are deprecated. Please migrate to the `deps` nam
201219
- **Customization**:
202220
- Use `deps.onlyBundle` to whitelist dependencies allowed to be bundled, and throw an error for any others.
203221
- Use `deps.onlyImport` to whitelist packages the output is allowed to import at runtime.
204-
- Use `deps.neverBundle` to mark specific dependencies as external.
222+
- Use `deps.neverBundle` to mark specific dependencies as external, or set it to `true` to externalize all dependencies.
205223
- Use `deps.alwaysBundle` to force specific dependencies to be bundled.
206-
- Use `deps.skipNodeModulesBundle` to skip bundling all dependencies from `node_modules`.
207224
- Set `deps.resolveDepSubpath` to `false` to preserve external dependency subpath imports as written.
208225
- **Declaration Files**:
209226
- The bundling logic for declaration files is now the same as for JavaScript.

‎docs/zh-CN/guide/faq.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ tsdown -W -F my-package
5454
```ts
5555
export default defineConfig({
5656
deps: {
57-
skipNodeModulesBundle: true,
57+
neverBundle: true,
5858
},
5959
})
6060
```

‎docs/zh-CN/guide/how-it-works.md‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,12 @@ tsdown 读取你的 `package.json` 和 `tsconfig.json` 来推断合理的默认
3333

3434
**主要选项：**
3535

36-
| 选项 | 说明 |
37-
| ------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
38-
| [`deps.onlyBundle`](../options/dependencies.md#deps-onlybundle) | 允许打包的依赖白名单。任何不在列表中的依赖如果出现在 bundle 中将触发错误。适用于防止大型项目中的意外内联。 |
39-
| [`deps.neverBundle`](../options/dependencies.md#deps-neverbundle) | 显式将额外的包标记为外部依赖（不打包）。 |
40-
| [`deps.alwaysBundle`](../options/dependencies.md#deps-alwaysbundle) | 强制打包特定的包，即使它们在 `dependencies` 中。 |
41-
| [`deps.skipNodeModulesBundle`](../options/dependencies.md#deps-skipnodemodulesbundle) | 跳过打包所有来自 `node_modules` 的内容。 |
42-
| [`deps.resolveDepSubpath`](../options/dependencies.md#deps-resolvedepsubpath) | 将外部依赖的子路径导入解析为包内的实际相对路径。 |
36+
| 选项 | 说明 |
37+
| ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
38+
| [`deps.onlyBundle`](../options/dependencies.md#deps-onlybundle) | 允许打包的依赖白名单。任何不在列表中的依赖如果出现在 bundle 中将触发错误。适用于防止大型项目中的意外内联。 |
39+
| [`deps.neverBundle`](../options/dependencies.md#deps-neverbundle) | 显式将额外的包标记为外部依赖（不打包），设置为 `true` 时外部化所有依赖。 |
40+
| [`deps.alwaysBundle`](../options/dependencies.md#deps-alwaysbundle) | 强制打包特定的包，即使它们在 `dependencies` 中。 |
41+
| [`deps.resolveDepSubpath`](../options/dependencies.md#deps-resolvedepsubpath) | 将外部依赖的子路径导入解析为包内的实际相对路径。 |
4342

4443
详见[依赖](../options/dependencies.md)。
4544

‎docs/zh-CN/guide/migrate-from-tsup.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -64,16 +64,16 @@ npx tsdown-migrate packages/foo packages/bar
6464

6565
以下 tsup 选项在 tsdown 中仍然可用（向后兼容），但会发出弃用警告，**未来版本将会移除**。请立即迁移到推荐的替代方案。
6666

67-
| tsup（已弃用） | tsdown（推荐） | 说明 |
68-
| -------------------------- | --------------------------------------- | ---------------------- |
69-
| `entryPoints` | `entry` | 在 tsup 中也已弃用 |
70-
| `publicDir` | `copy` | 复制静态文件到输出目录 |
71-
| `bundle: false` | `unbundle: true` | 转换为正向表达 |
72-
| `removeNodeProtocol: true` | `nodeProtocol: 'strip'` | 更灵活，支持多种模式 |
73-
| `injectStyle: true` | `css: { inject: true }` | 移入 CSS 命名空间 |
74-
| `external: [...]` | `deps: { neverBundle: [...] }` | 移入 deps 命名空间 |
75-
| `noExternal: [...]` | `deps: { alwaysBundle: [...] }` | 移入 deps 命名空间 |
76-
| `skipNodeModulesBundle` | `deps: { skipNodeModulesBundle: true }` | 移入 deps 命名空间 |
67+
| tsup（已弃用） | tsdown（推荐） | 说明 |
68+
| -------------------------- | ------------------------------- | ---------------------- |
69+
| `entryPoints` | `entry` | 在 tsup 中也已弃用 |
70+
| `publicDir` | `copy` | 复制静态文件到输出目录 |
71+
| `bundle: false` | `unbundle: true` | 转换为正向表达 |
72+
| `removeNodeProtocol: true` | `nodeProtocol: 'strip'` | 更灵活，支持多种模式 |
73+
| `injectStyle: true` | `css: { inject: true }` | 移入 CSS 命名空间 |
74+
| `external: [...]` | `deps: { neverBundle: [...] }` | 移入 deps 命名空间 |
75+
| `noExternal: [...]` | `deps: { alwaysBundle: [...] }` | 移入 deps 命名空间 |
76+
| `skipNodeModulesBundle` | `deps: { neverBundle: true }` | 外部化所有依赖 |
7777

7878
tsdown 还新增了 `deps.onlyBundle`，用于白名单指定允许打包的依赖。
7979

0 commit comments

Comments
 (0)