TypeScript 中 Vite 怎么配置 Tree Shaking 清理未引用的第三方库

轻辰君_1280

轻辰君_1280

2026-07-28

663人浏览

原创

tree shaking 在 typescript + vite 项目中需模块格式(esm)、构建模式(生产+压缩)、导入方式(按需)、副作用声明(sideeffects)四者协同;tsconfig 必设 "module": "esnext",禁用 commonjs,按需导入第三方库,vite 构建启用 minify 和 treeshake,并显式声明 sideeffects。

typescript 中 vite 怎么配置 tree shaking 清理未引用的第三方库

Tree Shaking 在 TypeScript + Vite 项目中不是“开个开关”就能自动生效的,它依赖一整套协同配置:模块格式、构建模式、导入方式、副作用声明,缺一不可。重点不在“怎么配”,而在于“哪些环节必须对齐”。

确保 TypeScript 输出为 ES 模块

这是 Tree Shaking 的前提。Vite 默认支持 ESM,但 TypeScript 编译器若输出 CommonJS,就会彻底阻断摇树。

  • 检查 tsconfig.json 中必须设为:
    "module": "esnext"(不能是 "commonjs" 或 "amd")
    "target": "es2020" 或更高(避免降级引入冗余 polyfill)
    "importsNotUsedAsValues": "remove"(移除仅用于类型导入的 import,防止污染模块图)
  • 禁用 "outDir" 或 "declaration" 不影响运行时,但若同时启用了 "composite": true,需确认引用路径未意外触发全量编译

规范第三方库的导入写法

即使配置正确,错误的导入方式也会让 Tree Shaking 失效——工具无法判断你是否“用到了”。

Add Typescript Best Practices
Add Typescript Best Practices

在 CLAUDE.md 中配置 TypeScript 最佳实践和代码风格规则

下载
  • ❌ 避免全量导入:
    import _ from 'lodash' → 会保留整个 lodash
    import * as THREE from 'three' → 无法分析具体使用了哪些导出
  • ✅ 改为按需导入:
    import debounce from 'lodash/debounce'
    import { Vector3, Mesh } from 'three'
  • ⚠️ 注意库本身是否提供 ESM 版本:
    优先选用 lodash-es 替代 lodash;
    查看包的 package.json 是否有 "exports": { ".": { "import": "./dist/index.mjs" } } 或 "module": "./dist/esm/index.js"

Vite 构建配置显式启用优化

Vite 生产构建默认开启 Tree Shaking,但部分关键项需确认或补全:

  • build.minify 必须启用(如 'terser' 或 true),否则压缩阶段不触发摇树清理
  • build.terserOptions.module 设为 true,确保 Terser 以 ESM 模式解析(Vite 4.3+ 默认已设)
  • build.rollupOptions.treeshake 可显式设为 true(非必需,但明确意图)
  • 若第三方库只有 CJS 版本,可加插件转换:
    安装 vite-plugin-commonjs 并在 vite.config.ts 中启用,再配合 treeshake: true

声明无副作用,释放摇树权限

Rollup(Vite 底层)默认保守:只要模块可能产生副作用,就整块保留。你需要主动“担保”。

  • 在项目根目录的 package.json 中添加:
    "sideEffects": false —— 表示所有源码文件无副作用(最激进,适合纯逻辑库)
    或更安全地:
    "sideEffects": ["*.css", "*.scss", "src/polyfills.ts"] —— 只列出真正有副作用的文件
  • 避免在模块顶层执行副作用操作,例如:
    ❌ console.log('init')、document.body.appendChild(...)、fetch('/api/init')
    ✅ 把这些移到函数内部或组件生命周期里

相关文章

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

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

下载

相关标签:

vite typescript js javascript

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

相关专题

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

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

2023.06.20

4546

5

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

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

2023.07.04

1129

3

js四舍五入
js四舍五入

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

2023.07.04

4484

6

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

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

2023.09.01

900

4

JavaScript转义字符
JavaScript转义字符

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

2023.09.04

1796

5

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

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

2023.09.04

3265

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

4233

6

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

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

2023.09.20

2760

5

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

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

2023.09.20

888

7

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
第二期_大前端线上班
第二期_大前端线上班

共345课时 | 80.5万人学习

WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.6万人学习