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

JavaScript 中 Tree Shaking 怎么通过 package.json 中的 sideEffects 字段精确声明副作用

星晨同学_5915

星晨同学_5915

发布时间:2026-09-10 12:03:25

|

903人浏览过

|

来源于php中文网

原创

Tree Shaking 能安全剔除未使用导出的前提是模块无副作用,sideEffects 字段用于白名单式声明真正有副作用的文件路径或 glob 模式,设为 false 或 [] 表示全包无副作用,推荐用字符串数组精确列出如 "./index.js"、"*.css" 等;路径须与实际 import 解析路径一致,否则会导致误删。

javascript 中 tree shaking 怎么通过 package.json 中的 sideeffects 字段精确声明副作用

Tree Shaking 能安全剔除未使用的导出,前提是模块**没有副作用**。而 sideEffects 字段就是告诉打包工具(如 Webpack、Rollup):“这个包/这些文件是否会产生副作用”。它不是用来“标记副作用”,而是**精确声明哪些文件 *确实有副作用*,其余默认无副作用**——这是实现精准摇树的关键。

sideEffects 字段的本质:白名单式声明

它的值是一个数组,列出所有**含有副作用的文件路径或 glob 模式**。不在列表中的文件,会被视为纯模块(pure),可被安全删除未使用代码。

  • 设为 false:整个包完全无副作用,所有未引用的导出均可摇掉(最激进,也最安全,但需确保真实无副作用)
  • 设为 []:等价于 false,明确表示空白名单
  • 设为字符串数组(推荐):只列出真正有副作用的文件,例如:
    "sideEffects": ["./src/index.js", "./dist/style.css", "*.scss"]

常见副作用场景与对应写法

副作用通常指:执行时会改变全局状态、注入样式、注册全局变量、触发网络请求等,而非仅导出函数/类。

Comprehensive Three.js 3D graphics reference
Comprehensive Three.js 3D graphics reference

详细的 Three.js 3D 图形参考,涵盖场景设置、相机、几何体、材质、光照、动画、控制器、加载器、数学工具和调试。

下载
  • CSS / 预处理器文件:引入即执行注入样式(如 import './index.scss')
    → 写入 "*.css"、"*.scss" 或具体路径如 "./styles/main.css"
  • 入口文件含副作用逻辑:如 index.js 中直接调用 setup() 或修改 window
    → 明确列出 "./index.js",避免它被误删
  • polyfill 或全局补丁:如 core-js/stable 或自定义 Array.prototype.xxx
    → 列出对应模块路径,如 "./polyfills.js"
  • 字体、图片等资源(若 loader 触发副作用):较少见,但若资源加载过程有运行时行为,也可列入

避坑要点:路径必须匹配实际导入路径

Webpack/Rollup 匹配的是你 import 语句中写的路径(解析后的真实路径),不是源码目录结构。

立即学习“Java免费学习笔记(深入)”;

  • 如果你写 import 'my-lib/dist/index.css',那 sideEffects 应包含 "dist/index.css",而非 "src/index.css"
  • 使用别名(alias)时,按别名解析后的路径写;使用 exports 字段时,按最终解析到的文件路径写
  • 路径支持 glob,但注意 Webpack v5+ 对 ** 支持有限,建议用 "*.css" 或明确子目录如 "styles/**/*.css"

验证是否生效:看打包产物 + 启用 --display-modules

启用 Webpack 的 --display-modules 或分析工具(如 webpack-bundle-analyzer),观察:

  • 未被 import 的模块是否从产物中消失?
  • 你声明为 sideEffects 的 CSS 文件是否仍存在?即使没被 JS 引用,只要在 sideEffects 列表里,它就不会被摇掉
  • 如果某 CSS 消失了,检查它是否漏写了路径,或 import 路径与 sideEffects 声明不一致

热门AI工具

更多
墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

豆包大模型

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

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

WorkBuddy

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

PixPix
PixPix Hot

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

DeepSeek

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

SkildArt
SkildArt Hot

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

相关专题

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

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

4326

2023.06.20

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

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

1089

2023.07.04

js四舍五入
js四舍五入

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

4224

2023.07.04

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

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

860

2023.09.01

JavaScript转义字符
JavaScript转义字符

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

1756

2023.09.04

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

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

3125

2023.09.04

如何启用JavaScript
如何启用JavaScript

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

4073

2023.09.12

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

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

2620

2023.09.20

PixTV AI视频生成与无限画布创作
PixTV AI视频生成与无限画布创作

PixTV专题整理AI视频与视觉内容创作相关功能使用教程,涵盖AI生图、视频生成、无限画布、多模型创作、素材管理、声音音乐及视频剪辑等功能,帮助用户快速掌握PixTV从创意到成片的完整制作方法。

0

2026.09.29

热门下载

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

精品课程

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

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.5万人学习

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

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