讲师中心 微信公众号
AI工具推荐 视频效率加速

JavaScript 中怎么用 Vite 构建库模式输出符合规范的包

梦杰姑娘_7959

梦杰姑娘_7959

发布时间:2026-09-29 12:45:47

|

791人浏览过

|

来源于php中文网

原创

Vite库模式需正确配置build.lib入口与formats(如['es','cjs']),搭配exports字段、类型声明和package.json元信息,确保ESM/CJS兼容、Tree-shaking支持与类型提示。

javascript 中怎么用 vite 构建库模式输出符合规范的包

用 Vite 构建库(Library Mode)输出符合规范的包,核心是正确配置 build.lib 选项,并搭配合理的入口、导出与类型声明。它不是简单改个 mode 就能发布到 npm,需兼顾 ESM/CJS 兼容性、Tree-shaking 支持、类型提示和包元信息。

配置 build.lib 入口与格式

Vite 库模式通过 build.lib 指定入口文件和构建目标格式。推荐显式指定 formats,避免默认只输出 esm:

  • entry:指向一个纯导出的模块(如 src/index.ts),不包含 HTML 或副作用逻辑
  • formats:至少包含 ['es', 'cjs'];es 供现代 bundler(如 Vite、Webpack)原生导入,cjs 兼容 Node.js 和旧版工具链
  • fileName:可按格式自定义输出名(如 package.json 中的 "main" 对应 cjs,"module" 或 "exports" 对应 es)

示例 vite.config.ts:

export default defineConfig({
  build: {
    lib: {
      entry: resolve(__dirname, 'src/index.ts'),
      name: 'MyLib',
      formats: ['es', 'cjs'],
      fileName: (format) => `index.${format === 'es' ? 'mjs' : 'cjs'}`
    }
  }
})

导出方式要适配多种消费场景

库的 package.json 导出字段决定使用者如何 import。推荐使用 "exports" 字段(Node.js 12.20+ / npm 12+),比 "main" + "module" 更精确且安全:

立即学习“Java免费学习笔记(深入)”;

deep-java-review
deep-java-review

Java项目代码review工具。分析Git变更+完整调用链路上下文,推断业务需求,进行多维度评分和分类汇总,生成完整PRD文档。包含细粒度Java代码审查清单(Null安全、异常处理、Streams、并发、equals/hashCode、资源管理、API设计、性能、MyBatis/ORM、事务边界、SQL/DD...

下载
  • "exports": { ".": { "import": "./dist/index.mjs", "require": "./dist/index.cjs" } }
  • 若需支持子路径导入(如 import { util } from 'mylib/util'),在 exports 中添加对应条目,并确保 src/util.ts 有独立构建或通过条件导出处理
  • 避免在入口文件中直接 console.log 或执行副作用代码——库应“纯净”,只做导出

生成并内联 TypeScript 类型声明

Vite 默认不生成 .d.ts,需借助 rollup-plugin-dts 或更推荐的方式:用 vue-tsc(非 Vue 项目也可用)或 tsc --emitDeclarationOnly 单独生成类型文件,再复制进 dist:

  • 在 tsconfig.json 中设置 "declaration": true、"outDir": "dist"、"rootDir": "src"
  • 运行 tsc --emitDeclarationOnly --declarationMap false 生成 dist/index.d.ts
  • 在 package.json 中声明 "types": "dist/index.d.ts",确保 IDE 和消费者能自动加载类型

注意:不要把 node_modules 或未导出的内部模块类型暴露出去,可通过 "skipLibCheck": true 和精细的 include/exclude 控制。

补全包元信息与发布准备

一个可发布的包还需几个关键字段:

  • "type": "module":若主入口是 ESM(.mjs 或 exports.import 指向 .mjs),必须加此字段,否则 Node.js 会以 CJS 解析
  • "files":明确列出要发布到 npm 的目录/文件(如 ["dist", "package.json", "README.md"]),防止源码或锁文件被误发
  • "sideEffects": false 或数组形式:告知 Webpack 等工具该包无副作用,支持安全的 Tree-shaking
  • 测试构建产物:用 npm pack 生成 tarball,解压检查 dist 结构、类型文件是否存在、exports 是否指向正确路径

不复杂但容易忽略。

热门AI工具

更多
PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

相关专题

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

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

4326

2023.06.20

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

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

1089

2023.07.04

js四舍五入
js四舍五入

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

4224

2023.07.04

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

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

860

2023.09.01

JavaScript转义字符
JavaScript转义字符

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

1756

2023.09.04

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

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

3125

2023.09.04

如何启用JavaScript
如何启用JavaScript

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

4073

2023.09.12

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

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

2620

2023.09.20

PixTV AI视频生成与无限画布创作
PixTV AI视频生成与无限画布创作

PixTV专题整理AI视频与视觉内容创作相关功能使用教程,涵盖AI生图、视频生成、无限画布、多模型创作、素材管理、声音音乐及视频剪辑等功能,帮助用户快速掌握PixTV从创意到成片的完整制作方法。

0

2026.09.29

热门下载

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

精品课程

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

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.6万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn