JS 中怎么用 Vite 实现现代库模式(Library Mode)打包发布

梦宇大大_4061

梦宇大大_4061

2026-10-15

536人浏览

原创

核心是启用build.lib配置,配合入口、导出与类型声明,支持script引入和esm/node import;需设external排除依赖、tsc生成.d.ts、package.json配置main/module/types/exports/files,并本地验证后发布。

js 中怎么用 vite 实现现代库模式(library mode)打包发布

用 Vite 实现现代库模式打包发布,核心是启用 build.lib 配置,配合合理的入口、导出与类型声明,让库既能在浏览器中直接 script 引入,也能被 Node/ESM 项目正常 import。整个过程不依赖 Webpack,体积小、构建快、开箱即用。

1. 初始化项目并设置库入口

创建项目时建议文件夹名与将来 npm 包名一致(如 my-utils),然后手动创建入口文件:

  • 在 src/index.ts(或 .js)中导出全部 API,例如:
    export { debounce, throttle, deepClone } from './helpers'
  • 确保入口文件是单一、明确的模块,Vite 会以此为起点进行 tree-shaking 和格式生成

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

关键配置项必须包含 build.lib 和 rollupOptions.external:

  • entry 指向你的主入口路径(如 resolve(__dirname, 'src/index.ts'))
  • name 是 UMD 全局变量名(如 MyUtils),仅影响 umd 格式
  • fileName 支持函数写法,可区分格式:
    fileName: (format) => `my-utils.${format}.js`
  • external 列出运行时不打包的依赖(如 ['vue', 'lodash']),避免重复打包
  • globals 为 UMD 提供全局变量映射(如 { vue: 'Vue' })

3. 生成类型声明文件(.d.ts)

Vite 默认不生成类型,需借助 tsc 单独处理:

  • 新建 tsconfig.build.json,开启 "declaration": true 和 "emitDeclarationOnly": true
  • 指定 "include" 为源码路径(如 ["src/**/*.ts"])
  • 在 package.json 的 build 脚本中串联:
    "build": "vite build && tsc -p tsconfig.build.json"
  • 最终产出的 .d.ts 文件需通过 "types" 字段在 package.json 中声明

4. 完善 package.json 发布元信息

除了常规字段,以下几项直接影响用户如何引入你的库:

  • "main":指向 UMD 版本(如 lib/my-utils.umd.js)
  • "module":指向 ESM 版本(如 lib/my-utils.es.js)
  • "types":指向类型入口(如 lib/my-utils.d.ts)
  • "exports"(推荐):更精确控制不同导入方式的解析路径:
    "exports": { ".": { "import": "./lib/my-utils.es.js", "require": "./lib/my-utils.umd.js", "types": "./lib/my-utils.d.ts" } }
  • "files":显式声明要发布的目录(如 ["lib"]),避免误发源码或测试文件

5. 本地验证与发布

发布前务必本地测试两种主流用法:

  • 在 HTML 中用 <script type="module"></script> 引入 ESM 版本,检查能否调用
  • 在另一个 npm 项目中 npm link 或 yarn link 本地链接,测试 import 和类型提示
  • 确认无误后执行 npm login → npm publish
  • 首次发布注意包名未被占用(可用 npm info your-pkg-name 查询)

相关文章

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

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

下载

相关标签:

javascript js vite

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

相关专题

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

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

2023.06.20

4846

5

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

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

2023.07.04

1209

3

js四舍五入
js四舍五入

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

2023.07.04

4764

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

3445

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

4473

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