TypeScript 中 Vite 怎么配置库模式打包通用的 JavaScript 模块

冬浩君_6733

冬浩君_6733

2026-07-31

991人浏览

原创

用 vite 打包 typescript 库需启用库模式,配置 build.lib 指定入口、名称和 formats(es/umd),external 排除运行时依赖,并在 tsconfig.json 中开启 declaration、declarationdir 和 outdir;package.json 需设置 main、module、types、exports 和 files 字段以正确暴露模块与类型。

typescript 中 vite 怎么配置库模式打包通用的 javascript 模块

用 Vite 打包 TypeScript 库,核心是启用 库模式(lib mode),并配合正确的 TypeScript 编译与导出配置。它不是开发应用,而是产出可被其他项目直接 import 的通用 JS 模块(ESM + UMD),同时附带类型声明文件。

配置 vite.config.ts 为库模式

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

  • entry:指向你的库主入口文件(如 src/index.ts)
  • name:生成 UMD 全局变量名(仅对 UMD 格式生效,比如 window.MyLib)
  • formats:推荐同时输出 ['es', 'umd'],覆盖现代 ESM 导入和传统 CommonJS/UMD 场景
  • external:把 Vue、React、lodash 等运行时依赖排除在打包结果外,避免重复引入(通常写进 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 生成 .d.ts 声明文件

Vite 默认不生成类型声明,需在 tsconfig.json 中开启:

Typescript Strict
Typescript Strict

{ "answer": "深度 TypeScript 严格模式工作流——渐进式启用、编译器标志、类型边界、类型收窄、泛型、工具类型及安全重构。" }

下载
  • "declaration": true —— 启用声明文件生成
  • "declarationDir": "./dist/types" —— 指定输出目录(与打包产物分离更清晰)
  • "outDir": "./dist" —— 必须设置,否则 declaration 不生效
  • "module": "ESNext" 和 "moduleResolution": "Node16" —— 保证与 ESM 打包行为一致

构建后,Vite 会自动把 .d.ts 文件输出到 dist/types,再通过 package.json 的 types 字段暴露出去。

package.json 中关键字段要对齐

用户安装你的包后,靠这些字段决定导入哪个文件、是否能获得类型提示:

  • "main" → 指向 UMD 文件(如 ./dist/mylib.umd.js),供 require() 或 script 标签使用
  • "module" → 指向 ESM 文件(如 ./dist/mylib.es.js),供 import 使用
  • "types" → 指向主声明文件(如 ./dist/types/index.d.ts)
  • "exports"(推荐)→ 更精确控制不同导入方式的解析路径,例如:
    "exports": {
      ".": {
        "import": "./dist/mylib.es.js",
        "require": "./dist/mylib.umd.js",
        "types": "./dist/types/index.d.ts"
      }
    }
  • "files" → 明确声明发布到 npm 的文件列表(如 ["dist"]),避免 src 或测试文件误发

本地调试建议加软链接支持

开发中想在另一个项目里试用未发布的库,可用 npm link:

  • 在库项目根目录执行:npm link
  • 在测试项目中执行:npm link your-package-name

注意:若库用了 exports 字段,确保测试项目 Node 版本 ≥ 12.20,并且没有因路径别名或 monorepo 工具干扰解析。遇到类型不识别,检查 types 路径是否正确指向 .d.ts 文件。

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

相关文章

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

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

下载

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

相关专题

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

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

2023.06.20

4426

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

4344

6

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

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

2023.09.01

880

4

JavaScript转义字符
JavaScript转义字符

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

2023.09.04

1776

5

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

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

2023.09.04

3185

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

4153

6

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

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

2023.09.20

2680

5

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

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

2023.09.20

868

7

热门下载

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

精品课程

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

共0课时 | 0人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.6万人学习

TypeScript——十天技能课堂
TypeScript——十天技能课堂

共21课时 | 1.7万人学习