JavaScript 中 sideEffects 配置怎么写

云晨小哥_9980

云晨小哥_9980

2026-11-20

100人浏览

原创

在 package.json 中配置 sideeffects 字段,可以告诉打包工具哪些文件包含副作用。如果设为 false,表示所有模块都是纯函数式的,可以进行 tree shaking;如果设为数组,则列出包含副作用的文件路径(如 ["*.css"]),这些文件不会被移除。这样能显著减小最终打包体积。

JavaScript 中 sideEffects 配置怎么写

如何配置 sideEffects 为 false 以启用全局 Tree Shaking

当你的项目完全由纯 ES Module 组成且没有任何全局副作用时,可以将 sideEffects 设置为 false。这允许 Webpack、Vite 或 Rollup 等工具安全地删除未使用的导出代码。

JavaScript 中 sideEffects 配置怎么写

{
  "name": "my-pure-lib",
  "version": "1.0.0",
  "sideEffects": false,
  "main": "dist/index.js",
  "module": "src/index.js"
}

上述配置表明该库的所有 JS 文件都是无副作用的。只要确保导入的代码不修改全局原型链、不注入全局变量即可。例如,一个只包含纯函数的工具库:

// src/utils.js
export const add = (a, b) => a + b;

// src/index.js
export { add } from './utils';

运行构建后,如果消费者只使用了 add,其他未导出的函数将被彻底移除。

如何处理包含 CSS 或全局脚本的 sideEffects

许多库需要引入 CSS 文件或执行全局初始化代码,这些操作具有副作用,不能被 Tree Shaking 删除。此时需要在 sideEffects 数组中明确声明这些文件。

FilePond 灵活的 JavaScript 文件上传库
FilePond 灵活的 JavaScript 文件上传库

FilePond 是一个 JavaScript 文件上传库,支持通过拖拽、粘贴和 API 方式处理文件、目录、URL 和 Data URI。它包含内置的图像优化功能、异步分块上传功能,并提供了适用于 React、Vue、Angular 和 Svelte 的适配器。

下载

JavaScript 中 sideEffects 配置怎么写

{
  "name": "my-ui-kit",
  "version": "1.0.0",
  "sideEffects": [
    "*.css",
    "src/polyfill.js"
  ],
  "main": "dist/index.js",
  "module": "src/index.js"
}

在这个例子中,*.css 匹配所有 CSS 文件,src/polyfill.js 是特定的全局脚本。即使某个 CSS 文件未被任何组件直接 import,只要它被库的其他部分间接依赖或作为入口引入,它也会被保留。而其他的 JS 模块如果没有被使用,依然会被优化掉。

sideEffects 配置对未使用模块的具体影响

通过对比不同配置下的打包结果,可以清晰看到 sideEffects 的作用机制。以下是一个简单的验证场景:一个库包含三个模块,其中两个有副作用,一个是纯函数。

// package.json
{
  "sideEffects": ["*.css", "global.js"]
}

// global.js (有副作用)
console.log('Global init');

// pure.js (无副作用)
export const util = () => 'pure';

// unused.js (无副作用,但未使用)
export const deadCode = () => 'dead';

当用户仅导入 util 时:

  • global.js 会被保留,因为它在 sideEffects 列表中。
  • pure.js 会被保留,因为它是被引用的。
  • unused.js 会被移除,因为它既未被引用,也不在 sideEffects 列表中。

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

相关文章

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

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

下载

相关标签:

javascript java

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

相关专题

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

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

2023.06.20

6126

5

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

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

2023.07.04

1469

3

js四舍五入
js四舍五入

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

2023.07.04

6024

6

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

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

2023.09.01

1080

4

JavaScript转义字符
JavaScript转义字符

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

2023.09.04

2076

5

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

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

2023.09.04

4125

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

5473

6

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

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

2023.09.20

3620

5

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

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

2023.09.20

1168

7

热门下载

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

精品课程

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

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12.6万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.9万人学习