讲师中心 微信公众号
AI工具推荐 视频效率加速

TreeShaking中组件库在打包发布到npm时怎么配置exports属性以同时支持CommonJS兜底和ESM高效摇树

星磊酱_9037

星磊酱_9037

发布时间:2026-07-21 15:59:36

|

861人浏览过

|

来源于php中文网

原创

要让组件库在 npm 上同时支持 CommonJS 兜底和 ESM 高效 Tree Shaking,关键是用 exports 字段精准控制不同环境下的入口路径,并确保 ESM 路径本身具备可摇树结构:ESM 入口需命名导出、扁平化、无默认聚合;CJS 入口兜底;types 同步映射;sideEffects 显式声明;产物目录按格式严格分离。

treeshaking中组件库在打包发布到npm时怎么配置exports属性以同时支持commonjs兜底和esm高效摇树

要让组件库在 npm 上同时支持 CommonJS 兜底和 ESM 高效 Tree Shaking,关键不是“兼容两种格式”,而是**用 exports 字段精准控制不同环境下的入口路径,并确保 ESM 路径本身具备可摇树结构**。Node.js 从 v12.20+ 开始支持 exports,现代打包工具(Rollup/Vite/Tsup)和 bundler(Webpack 5+/Vite)都能正确解析它。

exports 字段必须分环境声明,不能混用 main/module

main 和 module 是旧式双入口方案,已被 exports 取代。继续保留它们不仅冗余,还可能引发解析冲突(比如某些工具优先读 main 而忽略 exports)。正确写法是只用 exports,明确区分:

  • ESM 环境(推荐、支持 Tree Shaking):通过 "import" 条件指向纯 ESM 入口(如 dist/index.esm.js 或 dist/index.mjs)
  • CommonJS 环境(兜底、不摇树):通过 "require" 条件指向 CJS 入口(如 dist/index.cjs.js)
  • 类型声明需同步映射:用 "types" 或 "typesVersions" 指向统一的 .d.ts 文件(通常放在 dist/index.d.ts),确保 TypeScript 不因格式切换丢失类型

ESM 入口必须是命名导出 + 单文件粒度

Tree Shaking 能生效,靠的是静态分析 import/export 关系。如果 ESM 入口是 export default {...} 或聚合对象导出,摇树会失效。正确结构是:

  • 每个功能函数/组件单独一个文件(如 src/button/index.ts),使用 export const Button = ...
  • 入口文件 src/index.ts 只做重新导出:export { Button } from './button'; export { Icon } from './icon';
  • 打包后 ESM 产物保持扁平化命名导出结构,不打包成默认对象

package.json 中 sideEffects 必须显式声明

即使所有模块都用 ESM,若存在副作用(如样式注入、全局 polyfill、console.log),打包工具会保守保留整个模块。解决方式:

Expanso yaml-to-json
Expanso yaml-to-json

使用 Expanso Edge 管道将 YAML 输入转换为 JSON 格式。

下载
  • 设 "sideEffects": false 表示整个库无副作用,最激进优化
  • 若部分文件有副作用(如 src/styles/index.css),则写成 "sideEffects": ["*.css", "*.scss"],仅排除这些文件
  • 注意:sideEffects 仅对 ESM 导入路径生效;CJS 兜底路径(require)不参与摇树,所以副作用不影响 CJS 使用者

构建产物目录需严格分离格式,且 exports 指向明确

不要把 ESM 和 CJS 文件混放在同一目录下(如都放 dist/),避免字段误配。建议结构:

  • dist/esm/index.js(ESM 格式,无 require,含 export)
  • dist/cjs/index.js(CJS 格式,含 module.exports)
  • dist/index.d.ts(统一类型声明)

对应 exports 配置示例:

"exports": {
  ".": {
    "import": "./dist/esm/index.js",
    "require": "./dist/cjs/index.js",
    "types": "./dist/index.d.ts"
  }
}

这样,import { Button } from 'your-lib' 走 ESM 路径并可摇树;const { Button } = require('your-lib') 走 CJS 路径,完全兜底。

热门AI工具

更多
超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

花生AI
花生AI Hot

一款AI视频创作工具,主要用于B站推出的AI视频创作工具,适合需要提升相关任务效率的用户。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

5706

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

1369

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

5624

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

1040

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

1996

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

3905

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

5153

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

3380

2023.09.20

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

0

2026.11.06

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 21.3万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn