JavaScript 中 Tree Shaking 怎么配置 package.json 声明

老强君_7079

老强君_7079

2026-09-17

880人浏览

原创

tree shaking 依赖打包工具对 es 模块的静态分析,需在 package.json 中通过 "exports" 字段(优先设 "import")或 "type": "module" 正确声明 esm 入口;避免仅用 "main" 或已弃用的 "module" 字段,否则将导致摇树失效。

javascript 中 tree shaking 怎么配置 package.json 声明

Tree Shaking 不是通过 package.json 配置实现的,而是由打包工具(如 Webpack、Vite、Rollup)在构建时,基于 ES 模块的静态结构分析,自动剔除未使用的导出(exports)。但 package.json 中的某些字段会影响 Tree Shaking 是否生效,关键在于**正确声明模块入口**,让打包工具能识别你发布的代码是 ES Module 格式。

✅ 必须设置 "type": "module" 或提供 "exports" 字段

如果你的包本身是用 ES 模块(.js 文件含 export/import)编写的,并希望使用者能正常 Tree Shake,需明确告诉工具:“这个包的默认入口支持静态分析”:

  • 推荐方式:使用 "exports" 字段精确声明不同环境下的入口,且优先指定 "import" 字段指向 ESM 文件(如 "./dist/index.js")
  • 兼容方式:若整个包是纯 ESM,可在根目录 package.json 中写 "type": "module"(注意这会要求所有 .js 文件按 ESM 解析,可能影响 CommonJS 用户)

⚠️ 避免覆盖或误导的字段

以下字段若配置不当,会破坏 Tree Shaking:

Feishu calendar sync, local ics to json data for AI agent
Feishu calendar sync, local ics to json data for AI agent

将ICS日历文件转为JSON格式,用于飞书日历导入导出及数据集成。

下载
  • "main" 指向一个 UMD 或 CommonJS 打包产物(如 index.cjs)→ 打包工具无法静态分析,Tree Shaking 失效
  • "module" 字段虽曾被 Webpack 支持,但它是非标准字段,已被现代工具(如 Vite、Rollup)逐步弃用;依赖它不如用标准 "exports"
  • 未声明 "exports",仅靠 "main" 和 "module" → 工具可能 fallback 到 CommonJS 入口,失去摇树能力

? 示例:推荐的 package.json 片段

假设你构建后输出了 ESM 格式的 dist/index.js 和 CJS 格式的 dist/index.cjs:

{
  "name": "my-lib",
  "type": "commonjs",
  "main": "./dist/index.cjs",
  "exports": {
    "import": "./dist/index.js",
    "require": "./dist/index.cjs"
  },
  "types": "./dist/index.d.ts"
}

这样配置后,当用户用 import { foo } from 'my-lib' 时,Vite/Webpack(v5+)会优先解析 "import" 入口,启用 Tree Shaking;而 require('my-lib') 仍可工作。

? 补充提醒

  • 你的源码必须用 export / import(不是 module.exports),否则即使入口是 ESM,也没有可摇的“树”
  • 确保构建工具(如 Rollup/Vite)输出的是真正的 ESM(format: 'es'),而不是带 __esModule 的模拟模块
  • 用户项目里也要开启生产模式(mode: 'production')和 optimization.usedExports: true(Webpack)等配合选项

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

javascript java js json

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.06.20

4506

5

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

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

2023.07.04

1129

3

js四舍五入
js四舍五入

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

2023.07.04

4424

6

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

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

2023.09.01

900

4

JavaScript转义字符
JavaScript转义字符

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

2023.09.04

1796

5

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

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

2023.09.04

3245

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

4213

6

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

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

2023.09.20

2720

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

868

7

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12.1万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.6万人学习