JavaScript 中怎么通过 package.json 的 sideEffects 属性标记无副作用代码

大宇姑娘_4978

大宇姑娘_4978

2026-08-07

366人浏览

原创

sideeffects是package.json中用于声明模块副作用的白名单字段:设为false表示全包无副作用可安全摇树,true表示全包有副作用禁用摇树,数组则仅列出有副作用的文件路径或glob模式(如"*.css"),未列出者默认可移除。

javascript 中怎么通过 package.json 的 sideeffects 属性标记无副作用代码

在 JavaScript 项目中,sideEffects 是 package.json 中一个用于告知打包工具(如 Webpack、Rollup)哪些模块**可以安全地被摇树(tree-shake)** 的字段。它不标记“无副作用代码”,而是明确告诉打包器:**哪些文件或模式是“有副作用”的**;其余未列出的文件,默认视为“无副作用”,可被移除。

sideEffects 的作用逻辑

它本质是一个白名单机制:

  • 如果设为 false:整个包被视为无副作用,所有未被引用的导出(包括默认导出、命名导出)都可被删除。
  • 如果设为 true:整个包被视为有副作用,禁止任何摇树(等价于关闭 tree-shaking)。
  • 如果设为字符串数组(最常用):仅数组中列出的路径或 glob 模式对应文件被视为有副作用;其他文件即使没被引用,也可安全移除。

常见 sideEffects 数组写法

典型值示例(适用于大多数纯函数库):

OpenJDK 24
OpenJDK 24

OpenJDK 24 Windows x64 官方参考实现(24+36),适合 Windows 环境进行 Java 开发、编译、运行和版本兼容性验证。

下载
"sideEffects": [
  "./src/styles.css",
  "./dist/*.css",
  "*.d.ts",
  "*.json"
]

说明:

  • "./src/styles.css":明确 CSS 文件有副作用(执行即注入样式),不能删。
  • "*.d.ts":类型声明文件不影响运行时,但需保留供 TS 使用;实际打包时不会被包含,写在这里只是惯例,不影响行为。
  • "*.json":JSON 导入可能触发副作用(如读取配置、影响环境),保守起见常列入。
  • "./dist/*.css":若构建产物含 CSS,也需声明,避免被误删。

必须注意的关键细节

sideEffects 只对 **ES 模块(ESM)导入/导出** 生效;CommonJS(require)不受影响。

  • 确保你的包发布的是 ESM 格式("type": "module" 或 "exports" 字段正确配置)。
  • 入口文件(如 index.js)若本身执行了副作用(如修改全局对象、注册插件、发起请求),就必须出现在 sideEffects 列表中,否则会被删掉。
  • 数组中的路径是相对于 package.json 的位置,支持 glob(如 "src/**/*.css"),但不支持正则表达式。
  • Webpack 5+ 默认启用此字段;Rollup 需配合 treeshake: { moduleSideEffects: 'no' } 等配置才能完全尊重它。

验证是否生效的小技巧

快速检查 tree-shaking 是否按预期工作:

  • 在项目中只 import 一个函数:import { foo } from 'your-lib';
  • 构建后查看打包产物(如 dist/main.js),搜索未用到的导出(如 bar)是否还存在;
  • 若存在,检查该导出所在文件是否被 sideEffects 错误包含,或该文件本身有隐式副作用(如顶层 console.log、localStorage.setItem)。

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

相关文章

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

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

下载

相关标签:

javascript java js json

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系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

1189

3

js四舍五入
js四舍五入

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

2023.07.04

4744

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