TreeShaking在利用Vite打包Monorepo多包项目时怎么通过配置package的main和module保证子包可摇树

夜宇大大_3752

夜宇大大_3752

2026-07-20

674人浏览

原创

tree shaking 能否生效,关键在于子包的 package.json 是否正确定义 exports/module 字段、声明 "type": "module",以及构建产物是否输出标准 esm 格式并采用具名导出;vite 仅是执行者,真正决定能否摇树的是子包自身的模块规范与导出方式。

treeshaking在利用vite打包monorepo多包项目时怎么通过配置package的main和module保证子包可摇树

TreeShaking 能否生效,关键不在于 Vite 本身,而在于 子包的 package.json 如何声明入口、模块类型,以及构建产物是否符合 ESM 规范。在 Monorepo 中,每个子包(如 packages/ui-components 或 packages/utils)必须被正确配置,才能让上层应用或其它子包在 import 时真正触发摇树。

明确 main 和 module 字段的分工

  • main: 指向 CommonJS 入口(如 dist/index.cjs.js),主要供 Node.js 环境或不支持 ESM 的打包器使用,不参与前端 TreeShaking。
  • module: 指向 ES Module 入口(如 dist/index.es.js),这是 Web 打包器(Vite、Rollup、Webpack)优先读取的字段,只有它被引用时,才可能触发 TreeShaking。
  • exports: 更现代、更精确的入口控制方式(推荐替代 main/module),可按条件区分环境、格式、子路径。

✅ 正确示例(子包 package.json):

{
  "name": "@my-org/utils",
  "version": "1.0.0",
  "type": "module",
  "main": "./dist/index.cjs.js",
  "module": "./dist/index.es.js",
  "types": "./dist/index.d.ts",
  "exports": {
    ".": {
      "import": "./dist/index.es.js",
      "require": "./dist/index.cjs.js"
    },
    "./date": {
      "import": "./dist/date.es.js",
      "require": "./dist/date.cjs.js"
    }
  },
  "files": ["dist"]
}

⚠️ 注意:"type": "module" 是必需的,否则 .js 文件默认按 CommonJS 解析,即使写了 export 也可能被忽略。

构建输出必须保留 ESM 结构

Vite 库模式(build.lib)默认生成 ESM + CJS 双格式,但需确保:

Vite
Vite

为开发、生产构建和库打包配置并优化 Vite。

下载
  • vite.config.ts 中启用 lib 构建,并显式指定 formats: ['es', 'cjs']
  • entry 是一个对象(支持多入口),且每个入口都导出具名/默认 export(避免 export * from 'xxx' 这类模糊导出)
  • 不要 rollupOptions.output.preserveModules: true(这会破坏摇树)

✅ 推荐配置片段:

// packages/utils/vite.config.ts
import { defineConfig } from 'vite'

export default defineConfig({
  build: {
    lib: {
      entry: {
        index: './src/index.ts',
        date: './src/date.ts',
      },
      formats: ['es', 'cjs'],
      fileName: (format, entryName) => `./dist/${entryName}.${format}.js`,
    },
    rollupOptions: {
      // 显式 external 非本包依赖(如 lodash),避免被打包进去干扰摇树
      external: ['lodash'],
      output: {
        exports: 'named', // 强制具名导出,利于摇树识别
      }
    }
  }
})

子包内部导出方式影响摇树效果

  • ✅ 好:具名导出 + 默认导出分离
    // src/index.ts
    export function formatDate() { /* ... */ }
    export function parseDate() { /* ... */ }
    export default { formatDate, parseDate }
  • ❌ 差:全部 export * from './xxx' 或 export default Object.assign(...)
    → Rollup/Vite 无法静态分析哪些导出被实际使用,导致整块保留。

上层项目引用时也要配合

在 apps/web-main 中,应使用具名导入,而非默认导入整个模块:

// ✅ 可摇树
import { formatDate } from '@my-org/utils'

// ❌ 不可摇树(整个 utils 包都会被打包)
import utils from '@my-org/utils'

如果子包还提供了子路径导出(如 "./date"),也应优先使用:

import { parseDate } from '@my-org/utils/date' // 直接命中子入口,更精准

类型声明与摇树无关,但影响开发体验

  • types 字段指向 .d.ts 文件(如 ./dist/index.d.ts)
  • 使用 vite-plugin-dts 自动生成类型,确保 .d.ts 与 .js 导出结构一致(尤其注意 export * 是否被正确映射)
  • 类型文件不会影响打包体积,但错误的类型声明可能导致 IDE 误判可用 API,间接阻碍正确导入方式

不复杂但容易忽略

相关专题

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

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

2023.06.20

4526

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

4444

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

2740

5

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

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

2023.09.20

888

7

热门下载

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

精品课程

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

共345课时 | 80.4万人学习

Webpack4.x---十天技能课堂
Webpack4.x---十天技能课堂

共20课时 | 2万人学习

两小时学会 Webpack
两小时学会 Webpack

共14课时 | 2.1万人学习