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

TreeShaking中sideEffects配置为false时怎么告诉打包工具所有文件皆可安心摇树

云杰姑娘_7575

云杰姑娘_7575

发布时间:2026-07-24 12:50:43

|

774人浏览过

|

来源于php中文网

原创

当 "sideEffects": false 写在项目根目录的 package.json 中,表示本项目所有模块均为纯 ES 模块,导入时无任何副作用(如改全局变量、操作 DOM 等),打包工具可安全剔除未被引用的导出;但需确保代码真实无副作用,否则会导致功能异常,并配合 production 模式、ES 模块配置及正确白名单(如 "*.css")才能生效。

treeshaking中sideeffects配置为false时怎么告诉打包工具所有文件皆可安心摇树

当 "sideEffects": false 写在项目根目录的 package.json 中,就等于向 Webpack、Vite 等现代打包工具明确声明:**本项目所有模块都是“纯”的 ES 模块,导入它们不会触发任何外部影响(比如改全局变量、操作 DOM、发起请求、注册插件等)**。工具据此推断——只要某个模块的导出没被任何地方 import 过,整个模块文件就可以安全剔除。

它生效的前提是“纯模块”真实存在

这个配置不是魔法开关,而是你对代码行为的诚实承诺。如果实际有副作用却标了 false,打包后功能可能直接异常。所以需确保:

  • 所有源码使用标准 ES6 import/export,不混用 require 或 module.exports
  • 没有顶层语句执行副作用,例如:document.body.classList.add('loaded')、console.log('init')、localStorage.setItem('flag', '1')
  • 类或工具函数文件只做定义和导出,不自动执行逻辑;初始化类实例、挂载插件等动作应放在显式调用的函数中,并由业务代码主动触发

CSS、字体、SVG 等资源必须显式排除

"sideEffects": false 会一并移除未被 JS 引用的 CSS 文件(哪怕你在 HTML 中 link 了),因为打包工具默认按 JS 模块图分析。解决方法是把它们加进白名单:

VitePress Generator
VitePress Generator

使用 VitePress 快速生成静态网站,支持安装依赖、初始化项目、本地预览、构建和部署。

下载
  • 如果你用 import './index.css' 方式加载样式,就得写:"sideEffects": ["*.css", "*.scss", "*.svg"]
  • 若只有个别 JS 文件含副作用(如 src/init.ts 注册了全局指令),就精确列出:"sideEffects": ["src/init.ts", "*.css"]
  • 路径匹配的是构建后的产物路径(即经 Babel/TS 编译后的 .js 文件路径),不是源码里的 .ts 路径

配合构建配置才能真正触发剔除

即使 package.json 写对了,以下配置缺一不可:

  • Webpack:必须启用 mode: 'production';开发模式下 Tree Shaking 默认关闭
  • 开启 optimization.usedExports: true(标记未使用导出)和 minimize: true(交由 Terser 实际删除)
  • Babel 配置中设 "modules": false,防止 import 被转成 require 导致静态分析失效
  • TypeScript 的 compilerOptions.module 设为 "ESNext" 或 "ES2020",且不启用 isolatedModules: false

验证是否真被摇掉最简单的方法

别只看配置,动手测:

  • 在某个工具类里加一个明显不用的函数:export function _UNUSED_HELPER() { alert('I should be gone'); }
  • 执行生产构建(npm run build)
  • 打开 dist/bundle.js,搜索 _UNUSED_HELPER 或 unused harmony export 字样
  • 若搜不到,说明已成功剔除;若还在,检查它是否被间接引用,或所在文件因副作用未被分析

热门AI工具

更多
Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

超级简历WonderCV

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

豆包大模型

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

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

WorkBuddy

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

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

DeepSeek

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

Seko
Seko Hot

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

PixPix
PixPix Hot

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

相关专题

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

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

4926

2023.06.20

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

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

1229

2023.07.04

js四舍五入
js四舍五入

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

4864

2023.07.04

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

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

960

2023.09.01

JavaScript转义字符
JavaScript转义字符

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

1876

2023.09.04

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

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

3485

2023.09.04

如何启用JavaScript
如何启用JavaScript

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

4533

2023.09.12

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

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

2980

2023.09.20

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

0

2026.10.16

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Webpack4.x---十天技能课堂
Webpack4.x---十天技能课堂

共20课时 | 2.1万人学习

两小时学会 Webpack
两小时学会 Webpack

共14课时 | 2.1万人学习

Node.js-前端工程化必学
Node.js-前端工程化必学

共19课时 | 3.6万人学习

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

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