库作者支持 tree shaking 的核心做法是发布 es module (esm) 格式的构建产物,并确保代码中不存在副作用(side effects)。具体而言,需要在 package.json 的 sideeffects 字段中声明哪些文件包含副作用,并将入口指向 esm 文件。这样打包工具(如 webpack、vite)才能安全地移除未使用的导出函数或类,从而减小最终应用的体积。

如何配置 package.json 以启用 Tree Shaking
在 package.json 中正确设置 sideEffects 和 module 字段是第一步。如果库中的某些文件(如样式文件或全局补丁)会修改全局环境,必须将它们列入 sideEffects 数组;否则,打包工具可能会误删这些关键文件。同时,通过 module 字段指定 ESM 入口,引导现代构建工具使用可分析的模块结构而非 CommonJS。

{
"name": "my-utils",
"version": "1.0.0",
"main": "dist/index.cjs.js",
"module": "src/index.js",
"sideEffects": ["./src/style.css", "./src/polyfill.js"]
}
上述配置中,module 指向源码目录下的 index.js,假设该文件使用 export 语法。而 sideEffects 明确指出了 style.css 和 polyfill.js 具有副作用,即使它们未被直接导入,也不会被移除。其余 JS 文件若无副作用,则默认可被安全地摇树优化。
立即学习“Java免费学习笔记(深入)”;
编写无副作用的代码规范
除了配置文件,代码本身必须符合纯函数或无副作用原则。避免在模块顶层执行赋值操作、修改原型链或调用可能改变外部状态的 API。例如,不要在文件顶部直接调用 console.log 或向全局对象添加属性,除非你希望它始终运行。对于需要注册插件或扩展原型的场景,应将其封装在函数内部,仅在显式调用时执行。

// ❌ 有副作用:模块加载时立即执行
const globalConfig = { debug: true };
globalThis.myLib = globalConfig;
// ✅ 无副作用:仅定义导出
export function getConfig() {
return { debug: false };
}
export function setDebug(flag) {
// 逻辑处理,不修改全局状态
return flag;
}
在上面的示例中,左侧代码会在导入时修改 globalThis,导致打包工具无法安全地移除该模块,即使开发者从未使用它。右侧代码仅导出函数,没有任何顶层执行逻辑,因此可以被完全摇树。若用户只导入 getConfig,setDebug 将被剔除。
如何处理带有副作用的特定功能
当库必须提供某些全局行为(如自动注入 polyfill 或注册自定义元素)时,作者需让用户显式导入这些文件以触发副作用。此时,应在 sideEffects 中列出这些文件,并建议用户按需导入。例如,若库提供一个 init.js 用于初始化全局状态,用户只需在应用入口引入 import 'my-lib/init',打包工具便会保留该文件,而其他未使用的部分仍可被优化。


















