【亲测免费】 vite-plugin-dts 技术文档

vite-plugin-dts 技术文档

vite-plugin-dts 是一个专为 Vite 设计的插件，它在 Vite 运行于库模式时，自动从 .ts(x) 或 .vue 源文件生成类型声明文件（.d.ts）。

安装指南

要安装 vite-plugin-dts，您可以通过以下命令执行：

pnpm install vite-plugin-dts -D

这条命令将该插件添加到您的项目作为开发依赖。

项目使用说明

一旦安装完成，您需要配置 Vite 的 vite.config.ts 文件来启用此插件。基本的配置示例如下：

import { defineConfig } from 'vite';
import { resolve } from 'path';
import dts from 'vite-plugin-dts';

export default defineConfig({
  build: {
    lib: {
      entry: resolve(__dirname, 'src/index.ts'),
      name: 'MyLib',
      formats: ['es'],
      fileName: 'my-lib',
    },
  },
  plugins: [dts()],
});

如果您希望所有声明文件合并为一个单独的文件，可以这样做：

plugins: [dts({ rollupTypes: true })],

API 使用文档

配置选项

vite-plugin-dts 提供了多种可自定义的选项以满足不同的需求：

• root: 指定根目录。
• outDir: 输出声明文件的目录，默认跟随 Vite 的配置或 Rollup 的 outDir。
• rollupTypes: 是否滚动生成类型文件，适用于合并声明。
• staticImport: 控制是否转换动态导入为静态导入。
• 更多复杂配置项如 compilerOptions, tsconfigPath, resolvers 等，请参考项目文档或源码注释获取详细信息。

项目安装方式

再次强调，项目的安装是通过包管理器进行的，具体为：

pnpm i vite-plugin-dts -D

确保您是在项目的根目录运行上述命令，并且已经初始化了一个npm/yarn/pnpm环境。

注意事项

在使用过程中，务必关注源代码的结构和类型系统的一致性。如果遇到类型错误，检查 tsconfig.json 的配置，确保正确的 include 和 exclude 规则被设置，以避免编译阶段的问题。对于更高级的使用场景，比如处理特定的路径映射或优化声明文件的生成逻辑，仔细阅读项目的FAQ和提供的API选项。

此文档旨在提供快速入门指导和基础使用说明。对于更详细的配置和应用场景，请访问项目GitHub页面查阅最新文档和示例。