JavaScript 中怎么在 package.json 中配置 sideEffects 提升优化效果

浅涛大大_1596

浅涛大大_1596

2026-09-30

995人浏览

原创

正确配置 sideeffects 是 tree shaking 生效的关键,需用数组声明有副作用的文件(如 "*.css"、"src/polyfills.js"),纯工具库可设为 false,不声明则默认全部保留导致摇树失效。

javascript 中怎么在 package.json 中配置 sideeffects 提升优化效果

在 package.json 中正确配置 sideEffects,是让 Tree Shaking 发挥实效的关键一步。它不是开关,而是“副作用白名单”——告诉构建工具哪些文件必须保留,其余未使用代码才能被安全移除。

明确声明哪些文件有副作用

最常用也最稳妥的方式是用数组列出真实存在副作用的文件或通配模式:

  • "*.css" 和 "*.scss":匹配所有 CSS/Sass 文件,确保样式不被误删
  • "src/polyfills.js":保留全局垫片脚本,避免运行时缺失 API
  • "*.svg" 或 "fonts/*.woff2":如果字体、图标通过 import 加载,也要列出来
  • 路径需准确:用 "*.css" 能匹配 src/a.css 和 node_modules/lib/style.css;但 "src/**/*.css" 就不会命中 node_modules 下的样式

纯工具库可设为 false

如果你开发的是像 lodash-es 这类只导出函数、不操作全局、不引入样式或资源的工具包,可以写:

"sideEffects": false

这表示整个包无任何副作用,构建工具会激进删除所有未使用的导出。但注意:

Json Schema Toolkit
Json Schema Toolkit

使用 JSON Schema 验证 JSON 数据,从示例 JSON 生成 schema,并将其转换为 TypeScript 接口、Python 数据类或 Markdown 文档。

下载
  • 一旦设为 false,连 import './index.css' 都会被删掉
  • 务必确认项目中没有隐式副作用(比如模块顶层执行了 localStorage.setItem)

不写 sideEffects 等于全部保留

如果不声明该字段,构建工具默认 "sideEffects": true,即每个文件都可能有副作用。结果就是 Tree Shaking 基本失效,打包体积难以下降。

尤其要注意第三方库:如果它自己的 package.json 没配 sideEffects,哪怕你只 import { debounce } from 'lodash-es',整个 lodash-es 的代码也可能全被打进去。

避开常见坑点

这些细节看似小,却常导致样式丢失、polyfill 失效、全局方法不可用:

  • CSS 导入必须出现在模块顶层,且不能包裹在函数或条件中(否则构建工具无法静态分析)
  • 动态导入 import() 和 require() 不受 sideEffects 控制,也无法被 Tree Shaking 分析,尽量不用在核心逻辑里
  • 第三方库的副作用由它自己声明,你无法替它改;若遇到老库没配 sideEffects,可考虑替换或用别名 + resolve.alias 引导到已优化版本

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

相关专题

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

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

2023.06.20

4366

5

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

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

2023.07.04

1089

3

js四舍五入
js四舍五入

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

2023.07.04

4264

6

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

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

2023.09.01

860

4

JavaScript转义字符
JavaScript转义字符

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

2023.09.04

1756

5

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

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

2023.09.04

3145

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

4093

6

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

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

2023.09.20

2640

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万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.6万人学习