JavaScript 中怎么在 package.json 中正确声明无副作用文件

大强大大_7662

大强大大_7662

2026-09-28

989人浏览

原创

在 package.json 中通过 "sideeffects" 字段声明无副作用文件:设为 false 表示全包无副作用;设为数组如 ["*.css", "src/init.js"] 显式列出有副作用文件;true 或不写则禁止摇树。css 等资源需显式声明,否则样式丢失;类型文件 .d.ts 无需处理;动态 import 不受控制。

javascript 中怎么在 package.json 中正确声明无副作用文件

在 package.json 中正确声明无副作用(side-effect-free)文件,核心是通过 "sideEffects" 字段告诉打包工具(如 Webpack、Rollup、Vite)哪些模块可以安全地被摇树(tree-shake),哪些不能。这直接影响最终打包体积和运行时行为。

什么是“无副作用”?

一个模块若只导出值(如函数、常量、类型),且执行时不会修改全局状态、不触发网络请求、不操作 DOM、不产生日志或副作用 I/O,就可视为“无副作用”。例如:

  • export const PI = 3.14159;
  • export function add(a, b) { return a + b; }
  • export default class Utils { ... }(仅定义,未 new 或调用)

但若模块顶部写了 console.log('init')、localStorage.setItem(...) 或 require('./polyfill'),它就有副作用,不能被随意移除。

如何在 package.json 中配置 sideEffects

"sideEffects" 是一个布尔值或字符串数组,位于 package.json 的顶层:

Aria2 Json Rpc
Aria2 Json Rpc

通过 JSON‑RPC 2.0 与 aria2 下载管理器交互,使用自然语言命令管理下载、查询状态并控制任务。适用于 aria2、下载管理或种子操作。

下载
  • "sideEffects": false:表示整个包所有模块都无副作用,可被完全摇树。适用于纯函数式工具库(如 lodash-es 的部分子集、date-fns)。
  • "sideEffects": ["*.css", "*.scss", "src/init.js"]:显式列出有副作用的文件路径(支持 glob 模式)。其余文件默认视为无副作用。
  • "sideEffects": true(默认行为):等价于不写该字段,即所有文件都可能有副作用,禁止摇树导入的模块。

⚠️ 注意:"sideEffects": false 不代表“不执行”,而是“执行也不影响程序逻辑”,所以必须确保你声明的每个文件真的满足条件。

常见误用与建议

以下情况容易出错,需特别注意:

  • CSS/资源文件必须显式列出:即使你只用 import './index.css',Webpack 也会因副作用机制保留它 —— 所以要把 "*.css" 加入 sideEffects 数组,否则样式会丢失。
  • 入口文件(如 index.js)若有副作用,不能依赖 false:比如 index.js 自动注册全局插件或 polyfill,此时应设为 ["index.js"] 或更精确路径。
  • TypeScript 类型文件(.d.ts)不影响运行时,无需声明:它们不参与打包,sideEffects 对其无意义。
  • 动态 import() 不受此字段控制:该字段只影响静态 import 的摇树判断。

验证是否生效

配置后,可通过以下方式确认效果:

  • 用 Webpack 构建后查看生成的 bundle,搜索已导入但未使用的导出是否被剔除;
  • 在项目中只 import { debounce } from 'your-lib',检查打包结果里 throttle 是否不存在;
  • 使用 rollup --treeshake=verbose 查看摇树日志;
  • Vite 用户可开启 build.rollupOptions.treeshake: 'recommended' 并观察产物大小变化。

不复杂但容易忽略 —— 一个准确的 sideEffects 声明,能让使用者获得更小、更干净的打包结果。

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

相关文章

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

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

下载

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

相关专题

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

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

2023.06.20

4406

5

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

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

2023.07.04

1109

3

js四舍五入
js四舍五入

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

2023.07.04

4324

6

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

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

2023.09.01

880

4

JavaScript转义字符
JavaScript转义字符

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

2023.09.04

1776

5

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

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

2023.09.04

3185

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

4133

6

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

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

2023.09.20

2660

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