在 npm 项目中,使用 bundled dependency 的核心做法是在 package.json 的 bundleddependencies 字段中列出需要打包进发布包的依赖名称。这样当其他项目通过 npm install 安装你的包时,这些依赖会作为你包的一部分被直接下载到 node_modules/your-package/node_modules/ 目录下,而不会去安装全局或父级项目的依赖。这通常用于解决依赖冲突、确保特定版本兼容性或分发包含原生模块的包。

如何配置 bundledDependencies 字段
要在项目中启用捆绑依赖,只需在 package.json 中添加 bundledDependencies 数组即可。该数组应包含所有需要被捆绑的依赖项的名称字符串。例如,如果你希望将 lodash 和 axios 捆绑在你的包中,配置如下:
{
"name": "my-bundled-package",
"version": "1.0.0",
"dependencies": {
"lodash": "^4.17.21",
"axios": "^1.4.0"
},
"bundledDependencies": [
"lodash",
"axios"
]
}当你运行 npm pack 生成 .tgz 文件后,解压查看内部结构,你会发现 lodash 和 axios 的文件夹直接位于包的根目录下的 node_modules 中。这意味着安装者无需再单独安装这两个包,它们已经“内置”在你的包里了。

立即学习“Java免费学习笔记(深入)”;
bundledDependencies 与 dependencies 的区别
理解 bundledDependencies 的关键在于它与 dependencies 的关系。dependencies 声明了你的包运行时所需的所有依赖,而 bundledDependencies 只是从 dependencies 中挑选出那些需要被物理捆绑的部分。如果一个依赖只在 dependencies 中列出,但不在 bundledDependencies 中,那么它将被视为普通依赖,安装者需要自行安装它。如果某个依赖既不在 dependencies 也不在 bundledDependencies 中,但在代码中被 require,则会报错找不到模块。
// my-bundled-package/index.js
const _ = require('lodash'); // 来自 bundled lodash
const axios = require('axios'); // 来自 bundled axios
// const externalLib = require('external-lib'); // 如果 external-lib 未捆绑且未声明,会报错
module.exports = {
process: () => _.merge({}, { a: 1 })
};这种机制允许你精确控制哪些依赖被隔离在你的包作用域内。例如,你可以捆绑一个特定版本的 debug 库,而不受用户项目中可能存在的不同版本影响。这在构建工具链或需要严格环境控制的库中非常有用。

捆绑依赖在安装后的实际路径结构
当另一个项目安装了你带有 bundled dependencies 的包时,文件系统结构会发生变化。假设项目 A 安装了包 B(B 有 bundled dependencies),则 B 的捆绑依赖会出现在 project-A/node_modules/package-B/node_modules/ 下,而不是 project-A/node_modules/ 下。这确保了 B 的依赖不会被提升(hoisted)到顶层,从而避免了版本冲突。
project-A/
└── node_modules/
└── package-B/
├── index.js
├── package.json
└── node_modules/
├── lodash/
│ ├── index.js
│ └── package.json
└── axios/
├── index.js
└── package.json这种嵌套结构是 npm 处理 bundled dependencies 的标准行为。它保证了包 B 的代码始终引用其自己的依赖副本,即使项目 A 也依赖于不同版本的 lodash。开发者在调试此类问题时,应首先检查 node_modules 的嵌套层级,确认依赖是否确实被捆绑在了预期位置。


















