JS 中 package.json 中的 sideEffects 字段怎么配置以告诉打包工具哪些文件有副作用

夏强吖_3879

夏强吖_3879

2026-10-13

480人浏览

原创

sideeffects 字段是向构建工具声明副作用文件的白名单,数组形式列出需保留的 css、polyfill 等文件;纯工具库可设为 false 以启用激进 tree shaking;不配置则默认全保留,导致体积膨胀。

js 中 package.json 中的 sideeffects 字段怎么配置以告诉打包工具哪些文件有副作用

配置 sideEffects 字段,本质是向 Webpack 等构建工具提供一份“副作用白名单”,明确哪些文件**必须保留**,其余未被引用的代码才可安全删除。它不是开关,而是精准声明。

用数组列出真实有副作用的文件或通配模式

这是最常用、最稳妥的方式,适用于大多数项目:

  • "*.css" 和 "*.scss":匹配所有 CSS/Sass 文件(包括 src/ 下和 node_modules/ 中的),确保样式不被误删
  • "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

Wjs Uploading Video
Wjs Uploading Video

将一个或多个视频上传至YouTube。当用户想“上传到YouTube”“发YouTube”“批量上传”“upload to YouTube”“post videos to YouTube”或发布到YouTube时使用此技能。

下载

这表示整个包无任何副作用,构建工具将激进删除所有未使用的导出。但务必确认:

  • 模块顶层没有执行 localStorage.setItem、document.write 等隐式副作用
  • 没有通过 import './index.css' 这类方式加载资源——一旦设为 false,这类导入也会被删掉

不声明 sideEffects 等于全部保留

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

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

避开常见坑点

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

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

相关文章

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

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

下载

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

相关专题

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

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

2023.06.20

4826

5

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

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

2023.07.04

1209

3

js四舍五入
js四舍五入

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

2023.07.04

4764

6

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

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

2023.09.01

940

4

JavaScript转义字符
JavaScript转义字符

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

2023.09.04

1856

5

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

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

2023.09.04

3425

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

4453

6

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

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

2023.09.20

2920

5

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

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

2023.09.20

928

7

热门下载

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

精品课程

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

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12.2万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.6万人学习