README.zh-CN.md
May 6, 2026 · View on GitHub
unplugin-dts
一款用于在 库模式 中从 .ts(x) 或 .vue 源文件生成类型文件(*.d.ts)的 Unplugin 插件。
它始于 vite-plugin-dts,在用 unplugin 重写后,它变得更加通用了。
中文 | English
安装
pnpm i -D unplugin-dts
只在 Vite 中使用(不再推荐):
pnpm i -D vite-plugin-dts
快速开始
import dts from 'unplugin-dts/vite'
export default defineConfig({
plugins: [dts()],
})
支持 Vite、Rollup、Rolldown、Webpack、Rspack 和 Esbuild。详细的构建工具配置请查看使用文档。
文档
- 使用 - 安装与各构建工具配置
- 选项 - 完整的插件选项参考
- 常见问题 - 常见问题与解决方案
- 迁移指南 (v4 → v5) - 从 vite-plugin-dts v4 迁移
贡献者
感谢他们的所做的一切贡献!
示例
克隆项目然后执行下列命令:
pnpm run test:ts
然后检查 examples/ts/types 目录。
examples 目录下同样有 Vue 和 React 的案例。
一个使用该插件的真实项目:Vexip UI。
授权
MIT 授权。