JavaScript 中 Vite 怎么在库模式(Library Mode)下打包发布通用的 NPM 组件库

冬芳小哥_9581

冬芳小哥_9581

2026-08-26

267人浏览

原创

vite 打包 typescript 组件库需启用库模式,配置 build.lib 指定 entry、name、formats(es/umd),external 排除 vue/react 等依赖,tsconfig 开启 declaration 生成 .d.ts,package.json 设置 main/module/types/exports/files 字段。

javascript 中 vite 怎么在库模式(library mode)下打包发布通用的 npm 组件库

在 JavaScript(或 TypeScript)中用 Vite 打包发布一个通用的 NPM 组件库,核心是启用 库模式(Library Mode),并确保产物支持多种模块系统(ESM / UMD)、附带类型声明、正确导出入口,且不把框架或运行时依赖打包进去。

配置 vite.config.ts 启用库模式

在 vite.config.ts 中设置 build.lib,明确指定:

  • entry:库的主入口文件路径,如 src/index.ts 或 packages/index.ts
  • name:UMD 全局变量名(仅影响 UMD 格式,例如挂载到 window.MyUI)
  • formats:推荐同时输出 ['es', 'umd'],覆盖现代 ESM 导入和传统环境
  • fileName:可按格式动态命名,如 (format) => `mylib.${format}.js`

同时通过 rollupOptions.external 排除运行时依赖(如 vue、react),避免重复打包;并在 output.globals 中映射其全局变量名(用于 UMD):

Vite
Vite

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

下载
rollupOptions: {
  external: ['vue'],
  output: {
    globals: { vue: 'Vue' }
  }
}

生成并输出类型声明文件(.d.ts)

Vite 默认不生成类型文件,需配合 TypeScript 配置:

  • 在 tsconfig.json 中开启:"declaration": true、"outDir": "./dist"、"declarationDir": "./dist/types"
  • 确保 "module": "ESNext" 和 "moduleResolution": "Node16",与 ESM 打包行为一致
  • 构建命令建议组合执行:vite build && tsc -p tsconfig.json --emitDeclarationOnly,或使用插件如 vite-plugin-dts 自动处理

完善 package.json 的导出字段

让其他项目能正确 import 组件、类型和样式,package.json 必须包含:

  • "main":指向 UMD 文件(如 ./dist/mylib.umd.js)
  • "module":指向 ESM 文件(如 ./dist/mylib.es.js)
  • "types" 或 "typings":指向主类型文件(如 ./dist/types/index.d.ts)
  • "exports":推荐用对象语法精确控制不同导入方式的解析路径
  • "files":只包含真正要发布的目录/文件(如 ["dist", "README.md", "package.json"])
  • "peerDependencies":声明运行时依赖(如 "vue": "^3.2.0"),避免用户安装冲突版本

组件库结构与入口设计建议

组件库不是单个组件,而是可灵活使用的集合:

  • 主入口 src/index.ts 应统一导出所有组件(export { Button, Input, Dialog })及 install 方法(用于 Vue 插件式注册)
  • 若支持按需导入,可额外提供 src/components/Button/index.ts 等子入口,并在 exports 中配置子路径
  • 样式资源建议单独导出(如 import 'mylib/dist/style.css'),或通过插件自动注入(如 @vitejs/plugin-vue 处理 <style></style>)

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

相关专题

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

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

2023.06.20

4286

5

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

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

2023.07.04

1089

3

js四舍五入
js四舍五入

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

2023.07.04

4204

6

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

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

2023.09.01

860

4

JavaScript转义字符
JavaScript转义字符

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

2023.09.04

1756

5

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

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

2023.09.04

3125

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

4053

6

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

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

2023.09.20

2600

5

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

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

2023.09.20

848

7

热门下载

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

精品课程

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

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.5万人学习