JavaScript 中 Vite 怎么配置库模式打包输出通用模块

秋明大大_6341

秋明大大_6341

2026-08-14

661人浏览

原创

关键是要配置库模式(lib mode)及配套typescript与导出声明:在vite.config.ts中设置build.lib指定entry、name、formats(['es','umd'])和external;tsconfig.json启用declaration、declarationdir与outdir;package.json补充main、module、types、exports和files字段。

javascript 中 vite 怎么配置库模式打包输出通用模块

用 Vite 打包一个可被其他项目直接 import 的 JavaScript 库,关键不是写代码,而是配置好库模式(lib mode)和配套的 TypeScript、导出声明。它不生成网页,而是产出 ESM + UMD 两种格式的 JS 文件,附带类型定义(.d.ts),并确保第三方依赖不被打进去。

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

在 vite.config.ts 中设置 build.lib,明确入口、名称和输出格式:

  • entry:指向你的主入口文件,比如 src/index.ts
  • name:UMD 模式下挂载到全局的变量名,如 MyLib(浏览器中可通过 window.MyLib 访问)
  • formats:至少包含 ['es', 'umd'];若需支持 Node.js,可加 'cjs'
  • external:列出所有运行时依赖(如 vue、react),避免打包进产物;它们应作为 peerDependencies 存在

示例片段:

import { defineConfig } from 'vite'
import { resolve } from 'path'

export default defineConfig({
  build: {
    lib: {
      entry: resolve(__dirname, 'src/index.ts'),
      name: 'MyLib',
      fileName: (format) => `mylib.${format}.js`,
      formats: ['es', 'umd']
    },
    rollupOptions: {
      external: ['vue', 'react', 'react-dom'],
      output: {
        globals: {
          vue: 'Vue',
          react: 'React',
          'react-dom': 'ReactDOM'
        }
      }
    }
  }
})

让 TypeScript 生成类型声明文件

Vite 默认不生成 .d.ts,必须在 tsconfig.json 中显式开启:

javascript-pro
javascript-pro

专注现代 ECMAScript、异步编程、性能优化和全栈的 JavaScript 专家,适用于现代开发

下载
  • "declaration": true —— 启用声明文件生成
  • "declarationDir": "./dist/types" —— 类型文件单独输出到 dist/types/
  • "outDir": "./dist" —— 必须设置,否则 declaration 不生效
  • "module": "ESNext" 和 "moduleResolution": "Node16" —— 匹配 ESM 打包行为,避免类型解析错乱

完善 package.json 的导出字段

仅靠打包还不够,npm 需要明确知道怎么加载你的模块。在 package.json 中补充这些字段:

  • "main":指向 UMD 版本,如 "dist/mylib.umd.js"
  • "module":指向 ESM 版本,如 "dist/mylib.es.js"
  • "types":指向类型入口,如 "dist/types/index.d.ts"
  • "exports":推荐使用,更精确控制不同环境下的入口(例如区分 require/import、开发/生产)
  • "files":只发布必要目录,如 ["dist", "package.json", "README.md"],避免源码泄露

验证打包结果是否可用

运行 vite build 后检查 dist/ 目录:

  • 是否有 mylib.es.js 和 mylib.umd.js
  • dist/types/ 下是否有对应结构的 .d.ts 文件
  • 在另一个项目里尝试 import MyLib from 'your-lib-name' 或 require('your-lib-name'),确认能正常解析且类型提示可用

不复杂但容易忽略——漏掉 external 会导致体积膨胀,没配 types 字段会让使用者失去类型支持,exports 缺失则可能在某些 bundler 下 fallback 到错误入口。

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

相关文章

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

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

下载

相关标签:

javascript java vite

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

相关专题

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

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

2023.06.20

4366

5

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

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

2023.07.04

1109

3

js四舍五入
js四舍五入

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

2023.07.04

4284

6

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

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

2023.09.01

880

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

3165

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

4113

6

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

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

2023.09.20

2640

5

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

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

2023.09.20

868

7

热门下载

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

精品课程

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

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.6万人学习