vite-plugin-dts 1.6.0 → 1.6.1

package/README.md

@@ -1,213 +1,214 @@
-# vite-plugin-dts
-
-**English** | [中文](./README.zh-CN.md)
-
-A vite plugin that generates declaration files (`*.d.ts`) from `.ts(x)` or `.vue` source files when using vite in [library mode](https://vitejs.dev/guide/build.html#library-mode).
-
-## Install
-
-```sh
-pnpm add vite-plugin-dts -D
-```
-
-## Usage
-
-In `vite.config.ts`:
-
-```ts
-import { resolve } from 'path'
-import { defineConfig } from 'vite'
-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()]
-})
-```
-
-In your component:
-
-```vue
-<template>
-  <div></div>
-</template>
-
-<script lang="ts">
-// using defineComponent for inferring types
-import { defineComponent } from 'vue'
-
-export default defineComponent({
-  name: 'Component'
-})
-</script>
-```
-
-```vue
-<script setup lang="ts">
-// Need to access the defineProps returned value to
-// infer types although you never use the props directly
-const props = defineProps<{
-  color: 'blue' | 'red'
-}>()
-</script>
-
-<template>
-  <div>{{ color }}</div>
-</template>
-```
-
-## Options
-
-```ts
-import type { ts, Diagnostic } from 'ts-morph'
-
-interface TransformWriteFile {
-  filePath?: string
-  content?: string
-}
-
-export interface PluginOptions {
-  // Depends on the root directory
-  // Defaults base on your vite config root options
-  root?: string
-
-  // Declaration files output directory
-  // Can be specified a array to output to multiple directories
-  // Defaults base on your vite config output options
-  outputDir?: string | string[]
-
-  // Manually set the root path of the entry files
-  // The output path of each file will be caculated base on it
-  // Defaults is the smallest public path for all files
-  entryRoot?: string
-
-  // Project init compilerOptions using by ts-morph
-  // Default: null
-  compilerOptions?: ts.CompilerOptions | null
-
-  // Project init tsconfig.json file path by ts-morph
-  // Plugin also resolve incldue and exclude files from tsconfig.json
-  // Default: 'tsconfig.json'
-  tsConfigFilePath?: string
-
-  // Set which paths should exclude when transform aliases
-  // If it's regexp, it will test the original import path directly
-  // Default: []
-  aliasesExclude?: (string | RegExp)[]
-
-  // Whether transform file name '.vue.d.ts' to '.d.ts'
-  // Default: false
-  cleanVueFileName?: boolean
-
-  // Whether transform dynamic import to static
-  // Force true when `rollupTypes` is effective
-  // eg. 'import('vue').DefineComponent' to 'import { DefineComponent } from "vue"'
-  // Default: false
-  staticImport?: boolean
-
-  // Manual set include glob
-  // Defaults base on your tsconfig.json include option
-  include?: string | string[]
-
-  // Manual set exclude glob
-  // Defaults base on your tsconfig.json exclude option, be 'node_module/**' when empty
-  exclude?: string | string[]
-
-  // Whether generate types entry file
-  // When true will from package.json types field if exists or `${outputDir}/index.d.ts`
-  // Force true when `rollupTypes` is effective
-  // Default: false
-  insertTypesEntry?: boolean
-
-  // Set to rollup declaration files after emit
-  // Power by `@microsoft/api-extractor`, it will start a new program which takes some time
-  // Default: false
-  rollupTypes?: boolean
-
-  // Whether copy .d.ts source files into outputDir
-  // Default: true
-  copyDtsFiles?: boolean
-
-  // Whether emit nothing when has any diagnostic
-  // Default: false
-  noEmitOnError?: boolean
-
-  // Whether skip typescript diagnostics
-  // Skip type diagnostics means that type errors will not interrupt the build process
-  // But for the source files with type errors will not be emitted
-  // Default: true
-  skipDiagnostics?: boolean
-
-  // Whether log diagnostic informations
-  // Not effective when `skipDiagnostics` is true
-  // Default: false
-  logDiagnostics?: boolean
-
-  // After emit diagnostic hook
-  // According to the length to judge whether there is any type error
-  // Default: () => {}
-  afterDiagnostic?: (diagnostics: Diagnostic[]) => void | Promise<void>
-
-  // Before declaration file be writed hook
-  // You can transform declaration file-path and content through it
-  // Default: () => {}
-  beforeWriteFile?: (filePath: string, content: string) => void | TransformWriteFile
-
-  // After build hook
-  // It wil be called after all declaration files are written
-  // Default: () => {}
-  afterBuild?: () => void | Promise<void>
-}
-```
-
-## Example
-
-Clone and run the following script:
-
-```sh
-pnpm run test:e2e
-```
-
-Then check `example/types`.
-
-## FAQ
-
-Here are some FAQ's and solutions.
-
-### Missing some declaration files after build
-
-By default `skipDiagnostics` option is `true`, which means that type diagnostic will be skipped during the build process (some projects may have diagnostic tools such as `vue-tsc`). If there are some files with type errors which interrupt the build process, these files will not be emitted (declaration files won't be generated).
-
-If your project doesn't use type diagnostic tools, you can set `skipDiagnostics: false` and `logDiagnostics: true` to turn on the diagnostic and log features of this plugin. It will help you check the type errors during build and log error information to the terminal.
-
-### Take type error when using both `script` and `setup-script` in vue component
-
-This is usually caused by using `defineComponent` function in both `script` and `setup-script`. When `vue/compiler-sfc` compiles these files, the default export result from `script` gets merged with the parameter object of `defineComponent` from `setup-script`. This is incompatible with parameters and types returned from `defineComponent`, which results in a type error.
-
-Here is a simple [example](https://github.com/qmhc/vite-plugin-dts/blob/main/example/components/BothScripts.vue), you should remove the `defineComponent` which in `script` and export a native object directly.
-
-### Take errors that unable to infer types from packages which under `node_modules`
-
-This is a exist issue when TypeScript inferring types from packages which under `node_modules` through soft links (pnpm), you can refer to this [issue](https://github.com/microsoft/TypeScript/issues/42873). Currently has a workaround that add `baseUrl` to your `tsconfig.json` and specify the `paths` for these packages:
-
-```json
-{
-  "compilerOptions": {
-    "baseUrl": ".",
-    "paths": {
-      "third-lib": ["node_modules/third-lib"]
-    }
-  }
-}
-```
-
-## License
-
-MIT License.
+# vite-plugin-dts
+
+**English** | [中文](./README.zh-CN.md)
+
+A vite plugin that generates declaration files (`*.d.ts`) from `.ts(x)` or `.vue` source files when using vite in [library mode](https://vitejs.dev/guide/build.html#library-mode).
+
+## Install
+
+```sh
+pnpm add vite-plugin-dts -D
+```
+
+## Usage
+
+In `vite.config.ts`:
+
+```ts
+import { resolve } from 'path'
+import { defineConfig } from 'vite'
+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()]
+})
+```
+
+In your component:
+
+```vue
+<template>
+  <div></div>
+</template>
+
+<script lang="ts">
+// using defineComponent for inferring types
+import { defineComponent } from 'vue'
+
+export default defineComponent({
+  name: 'Component'
+})
+</script>
+```
+
+```vue
+<script setup lang="ts">
+// Need to access the defineProps returned value to
+// infer types although you never use the props directly
+const props = defineProps<{
+  color: 'blue' | 'red'
+}>()
+</script>
+
+<template>
+  <div>{{ color }}</div>
+</template>
+```
+
+## Options
+
+```ts
+import type { ts, Diagnostic } from 'ts-morph'
+
+interface TransformWriteFile {
+  filePath?: string
+  content?: string
+}
+
+export interface PluginOptions {
+  // Depends on the root directory
+  // Defaults base on your vite config root options
+  root?: string
+
+  // Declaration files output directory
+  // Can be specified a array to output to multiple directories
+  // Defaults base on your vite config output options
+  outputDir?: string | string[]
+
+  // Manually set the root path of the entry files
+  // The output path of each file will be caculated base on it
+  // Defaults is the smallest public path for all files
+  entryRoot?: string
+
+  // Project init compilerOptions using by ts-morph
+  // Default: null
+  compilerOptions?: ts.CompilerOptions | null
+
+  // Project init tsconfig.json file path by ts-morph
+  // Plugin also resolve incldue and exclude files from tsconfig.json
+  // Default: 'tsconfig.json'
+  tsConfigFilePath?: string
+
+  // Set which paths should exclude when transform aliases
+  // If it's regexp, it will test the original import path directly
+  // Default: []
+  aliasesExclude?: (string | RegExp)[]
+
+  // Whether transform file name '.vue.d.ts' to '.d.ts'
+  // Default: false
+  cleanVueFileName?: boolean
+
+  // Whether transform dynamic import to static
+  // Force true when `rollupTypes` is effective
+  // eg. 'import('vue').DefineComponent' to 'import { DefineComponent } from "vue"'
+  // Default: false
+  staticImport?: boolean
+
+  // Manual set include glob
+  // Defaults base on your tsconfig.json include option
+  include?: string | string[]
+
+  // Manual set exclude glob
+  // Defaults base on your tsconfig.json exclude option, be 'node_module/**' when empty
+  exclude?: string | string[]
+
+  // Whether generate types entry file
+  // When true will from package.json types field if exists or `${outputDir}/index.d.ts`
+  // Force true when `rollupTypes` is effective
+  // Default: false
+  insertTypesEntry?: boolean
+
+  // Set to rollup declaration files after emit
+  // Power by `@microsoft/api-extractor`, it will start a new program which takes some time
+  // Default: false
+  rollupTypes?: boolean
+
+  // Whether copy .d.ts source files into outputDir
+  // Default: true
+  copyDtsFiles?: boolean
+
+  // Whether emit nothing when has any diagnostic
+  // Default: false
+  noEmitOnError?: boolean
+
+  // Whether skip typescript diagnostics
+  // Skip type diagnostics means that type errors will not interrupt the build process
+  // But for the source files with type errors will not be emitted
+  // Default: true
+  skipDiagnostics?: boolean
+
+  // Whether log diagnostic informations
+  // Not effective when `skipDiagnostics` is true
+  // Default: false
+  logDiagnostics?: boolean
+
+  // After emit diagnostic hook
+  // According to the length to judge whether there is any type error
+  // Default: () => {}
+  afterDiagnostic?: (diagnostics: Diagnostic[]) => void | Promise<void>
+
+  // Before declaration file be writed hook
+  // You can transform declaration file-path and content through it
+  // The file will be skipped when return exact false
+  // Default: () => {}
+  beforeWriteFile?: (filePath: string, content: string) => void | false | TransformWriteFile
+
+  // After build hook
+  // It wil be called after all declaration files are written
+  // Default: () => {}
+  afterBuild?: () => void | Promise<void>
+}
+```
+
+## Example
+
+Clone and run the following script:
+
+```sh
+pnpm run test:e2e
+```
+
+Then check `example/types`.
+
+## FAQ
+
+Here are some FAQ's and solutions.
+
+### Missing some declaration files after build
+
+By default `skipDiagnostics` option is `true`, which means that type diagnostic will be skipped during the build process (some projects may have diagnostic tools such as `vue-tsc`). If there are some files with type errors which interrupt the build process, these files will not be emitted (declaration files won't be generated).
+
+If your project doesn't use type diagnostic tools, you can set `skipDiagnostics: false` and `logDiagnostics: true` to turn on the diagnostic and log features of this plugin. It will help you check the type errors during build and log error information to the terminal.
+
+### Take type error when using both `script` and `setup-script` in vue component
+
+This is usually caused by using `defineComponent` function in both `script` and `setup-script`. When `vue/compiler-sfc` compiles these files, the default export result from `script` gets merged with the parameter object of `defineComponent` from `setup-script`. This is incompatible with parameters and types returned from `defineComponent`, which results in a type error.
+
+Here is a simple [example](https://github.com/qmhc/vite-plugin-dts/blob/main/example/components/BothScripts.vue), you should remove the `defineComponent` which in `script` and export a native object directly.
+
+### Take errors that unable to infer types from packages which under `node_modules`
+
+This is a exist issue when TypeScript inferring types from packages which under `node_modules` through soft links (pnpm), you can refer to this [issue](https://github.com/microsoft/TypeScript/issues/42873). Currently has a workaround that add `baseUrl` to your `tsconfig.json` and specify the `paths` for these packages:
+
+```json
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "third-lib": ["node_modules/third-lib"]
+    }
+  }
+}
+```
+
+## License
+
+MIT License.

package/README.zh-CN.md

@@ -1,212 +1,213 @@
-# vite-plugin-dts
-
-**中文** | [English](./README.md)
-
-一款用于在 [库模式](https://cn.vitejs.dev/guide/build.html#library-mode) 中，从 `.ts(x)` 或 `.vue` 源文件生成类型文件（`.d.ts`）的 Vite 插件。
-
-## 安装
-
-```sh
-pnpm add vite-plugin-dts -D
-```
-
-## 使用
-
-在 `vite.config.ts`:
-
-```ts
-import { resolve } from 'path'
-import { defineConfig } from 'vite'
-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()]
-})
-```
-
-在你的组件中:
-
-```vue
-<template>
-  <div></div>
-</template>
-
-<script lang="ts">
-// 使用 defineComponent 来进行类型推断
-import { defineComponent } from 'vue'
-
-export default defineComponent({
-  name: 'Component'
-})
-</script>
-```
-
-```vue
-<script setup lang="ts">
-// 尽管没有直接使用 props，你仍需要接收 defineProps 的返回值
-const props = defineProps<{
-  color: 'blue' | 'red'
-}>()
-</script>
-
-<template>
-  <div>{{ color }}</div>
-</template>
-```
-
-## 选项
-
-```ts
-import type { ts, Diagnostic } from 'ts-morph'
-
-interface TransformWriteFile {
-  filePath?: string
-  content?: string
-}
-
-export interface PluginOptions {
-  // 执行的根目录
-  // 默认基于 vite 配置的 root 选项
-  root?: string
-
-  // 声明文件的输出目录
-  // 可以指定一个数组来输出到多个目录中
-  // 默认基于 vite 配置的输出目录
-  outputDir?: string | string[]
-
-  // 用于手动设置入口文件的根路径
-  // 在计算每个文件的输出路径时将基于该路径
-  // 默认为所有文件的最小公共路径
-  entryRoot?: string
-
-  // 提供给 ts-morph Project 初始化的 compilerOptions 选项
-  // 默认值: null
-  compilerOptions?: ts.CompilerOptions | null
-
-  // 提供给 ts-morph Project 初始化的 tsconfig.json 路径
-  // 插件也会读取 tsconfig.json 的 incldue 和 exclude 选项来解析文件
-  // 默认值: 'tsconfig.json'
-  tsConfigFilePath?: string
-
-  // 设置在转换别名时哪些路径需要排除
-  // 如果为正则，会直接使用 test 和原始路径进行比较
-  // 默认值: []
-  aliasesExclude?: (string | RegExp)[]
-
-  // 是否将 '.vue.d.ts' 文件名转换为 '.d.ts'
-  // 默认值: false
-  cleanVueFileName?: boolean
-
-  //是否将动态引入转换为静态
-  // 当开启打包类型文件时强制为 true
-  // eg. 'import('vue').DefineComponent' 转换为 'import { DefineComponent } from "vue"'
-  // 默认值: false
-  staticImport?: boolean
-
-  // 手动设置包含路径的 glob
-  // 默认基于 tsconfig.json 的 include 选项
-  include?: string | string[]
-
-  // 手动设置排除路径的 glob
-  // 默认基于 tsconfig.json 的 exclude 选线，未设置时为 'node_module/**'
-  exclude?: string | string[]
-
-  // 是否生成类型声明入口
-  // 当为 true 时会基于 package.json 的 types 字段生成，或者 `${outputDir}/index.d.ts`
-  // 当开启打包类型文件时强制为 true
-  // 默认值: false
-  insertTypesEntry?: boolean
-
-  // 设置是否在发出类型文件后将其打包
-  // 基于 `@microsoft/api-extractor`，由于这开启了一个新的进程，将会消耗一些时间
-  // 默认值: false
-  rollupTypes?: boolean
-
-  // 是否将源码里的 .d.ts 文件复制到 outputDir
-  // 默认值: true
-  copyDtsFiles?: boolean
-
-  // 出现类型诊断信息时不生成类型文件
-  // 默认值: false
-  noEmitOnError?: boolean
-
-  // 是否跳过类型诊断
-  // 跳过类型诊断意味着出现错误时不会中断打包进程的执行
-  // 但对于出现错误的源文件，将无法生成相应的类型文件
-  // 默认值: true
-  skipDiagnostics?: boolean
-
-  // 是否打印类型诊断信息
-  // 当跳过类型诊断时该属性将不会生效
-  // 默认值: false
-  logDiagnostics?: boolean
-
-  // 获取诊断信息后的钩子
-  // 可以根据参数 length 来判断有误类型错误
-  // 默认值: () => {}
-  afterDiagnostic?: (diagnostics: Diagnostic[]) => void | Promise<void>
-
-  // 类型声明文件被写入前的钩子
-  // 可以在钩子里转换文件路径和文件内容
-  // 默认值: () => {}
-  beforeWriteFile?: (filePath: string, content: string) => void | TransformWriteFile
-
-  // 构建后回调钩子
-  // 将会在所有类型文件被写入后调用
-  // 默认值: () => {}
-  afterBuild?: () => void | Promise<void>
-}
-```
-
-## 示例
-
-克隆项目然后执行下列命令：
-
-```sh
-pnpm run test:e2e
-```
-
-然后检查 `example/types` 目录。
-
-## 常见问题
-
-此处将收录一些常见的问题并提供一些解决方案。
-
-### 打包后出现类型文件缺失
-
-默认情况下 `skipDiagnostics` 选项的值为 `true`，这意味着打包过程中将跳过类型检查（一些项目通常有 `vue-tsc` 等的类型检查工具），这时如果出现存在类型错误的文件，并且这是错误会中断打包过程，那么这些文件对应的类型文件将不会被生成。
-
-如果您的项目没有依赖外部的类型检查工具，这时候可以您可以设置 `skipDiagnostics: false` 和 `logDiagnostics: true` 来打开插件的诊断与输出功能，这将帮助您检查打包过程中出现的类型错误并将错误信息输出至终端。
-
-### Vue 组件中同时使用了 `script` 和 `setup-script` 后出现类型错误
-
-这通常是由于分别在 `script` 和 `setup-script` 中同时使用了 `defineComponent` 方法导致的。 `vue/compiler-sfc` 为这类文件编译时会将 `script` 中的默认导出结果合并到 `setup-script` 的 `defineComponent` 的参数定义中，而 `defineComponent` 的参数类型与结果类型并不兼容，这一行为将会导致类型错误。
-
-这是一个简单的[示例](https://github.com/qmhc/vite-plugin-dts/blob/main/example/components/BothScripts.vue)，您应该将位于 `script` 中的 `defineComponent` 方法移除，直接导出一个原始的对象。
-
-### 打包时出现了无法从 `node_modules` 的包中推断类型的错误
-
-这是 TypeScript 通过软链接 (pnpm) 读取 `node_modules` 中过的类型时会出现的一个已知的问题，可以参考这个 [issue](https://github.com/microsoft/TypeScript/issues/42873)，目前已有的一个解决方案，在你的 `tsconfig.json` 中添加 `baseUrl` 以及在 `paths` 添加这些包的路径：
-
-```json
-{
-  "compilerOptions": {
-    "baseUrl": ".",
-    "paths": {
-      "third-lib": ["node_modules/third-lib"]
-    }
-  }
-}
-```
-
-## 授权
-
-MIT 授权。
+# vite-plugin-dts
+
+**中文** | [English](./README.md)
+
+一款用于在 [库模式](https://cn.vitejs.dev/guide/build.html#library-mode) 中，从 `.ts(x)` 或 `.vue` 源文件生成类型文件（`.d.ts`）的 Vite 插件。
+
+## 安装
+
+```sh
+pnpm add vite-plugin-dts -D
+```
+
+## 使用
+
+在 `vite.config.ts`:
+
+```ts
+import { resolve } from 'path'
+import { defineConfig } from 'vite'
+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()]
+})
+```
+
+在你的组件中:
+
+```vue
+<template>
+  <div></div>
+</template>
+
+<script lang="ts">
+// 使用 defineComponent 来进行类型推断
+import { defineComponent } from 'vue'
+
+export default defineComponent({
+  name: 'Component'
+})
+</script>
+```
+
+```vue
+<script setup lang="ts">
+// 尽管没有直接使用 props，你仍需要接收 defineProps 的返回值
+const props = defineProps<{
+  color: 'blue' | 'red'
+}>()
+</script>
+
+<template>
+  <div>{{ color }}</div>
+</template>
+```
+
+## 选项
+
+```ts
+import type { ts, Diagnostic } from 'ts-morph'
+
+interface TransformWriteFile {
+  filePath?: string
+  content?: string
+}
+
+export interface PluginOptions {
+  // 执行的根目录
+  // 默认基于 vite 配置的 root 选项
+  root?: string
+
+  // 声明文件的输出目录
+  // 可以指定一个数组来输出到多个目录中
+  // 默认基于 vite 配置的输出目录
+  outputDir?: string | string[]
+
+  // 用于手动设置入口文件的根路径
+  // 在计算每个文件的输出路径时将基于该路径
+  // 默认为所有文件的最小公共路径
+  entryRoot?: string
+
+  // 提供给 ts-morph Project 初始化的 compilerOptions 选项
+  // 默认值: null
+  compilerOptions?: ts.CompilerOptions | null
+
+  // 提供给 ts-morph Project 初始化的 tsconfig.json 路径
+  // 插件也会读取 tsconfig.json 的 incldue 和 exclude 选项来解析文件
+  // 默认值: 'tsconfig.json'
+  tsConfigFilePath?: string
+
+  // 设置在转换别名时哪些路径需要排除
+  // 如果为正则，会直接使用 test 和原始路径进行比较
+  // 默认值: []
+  aliasesExclude?: (string | RegExp)[]
+
+  // 是否将 '.vue.d.ts' 文件名转换为 '.d.ts'
+  // 默认值: false
+  cleanVueFileName?: boolean
+
+  //是否将动态引入转换为静态
+  // 当开启打包类型文件时强制为 true
+  // eg. 'import('vue').DefineComponent' 转换为 'import { DefineComponent } from "vue"'
+  // 默认值: false
+  staticImport?: boolean
+
+  // 手动设置包含路径的 glob
+  // 默认基于 tsconfig.json 的 include 选项
+  include?: string | string[]
+
+  // 手动设置排除路径的 glob
+  // 默认基于 tsconfig.json 的 exclude 选线，未设置时为 'node_module/**'
+  exclude?: string | string[]
+
+  // 是否生成类型声明入口
+  // 当为 true 时会基于 package.json 的 types 字段生成，或者 `${outputDir}/index.d.ts`
+  // 当开启打包类型文件时强制为 true
+  // 默认值: false
+  insertTypesEntry?: boolean
+
+  // 设置是否在发出类型文件后将其打包
+  // 基于 `@microsoft/api-extractor`，由于这开启了一个新的进程，将会消耗一些时间
+  // 默认值: false
+  rollupTypes?: boolean
+
+  // 是否将源码里的 .d.ts 文件复制到 outputDir
+  // 默认值: true
+  copyDtsFiles?: boolean
+
+  // 出现类型诊断信息时不生成类型文件
+  // 默认值: false
+  noEmitOnError?: boolean
+
+  // 是否跳过类型诊断
+  // 跳过类型诊断意味着出现错误时不会中断打包进程的执行
+  // 但对于出现错误的源文件，将无法生成相应的类型文件
+  // 默认值: true
+  skipDiagnostics?: boolean
+
+  // 是否打印类型诊断信息
+  // 当跳过类型诊断时该属性将不会生效
+  // 默认值: false
+  logDiagnostics?: boolean
+
+  // 获取诊断信息后的钩子
+  // 可以根据参数 length 来判断有误类型错误
+  // 默认值: () => {}
+  afterDiagnostic?: (diagnostics: Diagnostic[]) => void | Promise<void>
+
+  // 类型声明文件被写入前的钩子
+  // 可以在钩子里转换文件路径和文件内容
+  // 当返回 false 时会跳过该文件
+  // 默认值: () => {}
+  beforeWriteFile?: (filePath: string, content: string) => void | false | TransformWriteFile
+
+  // 构建后回调钩子
+  // 将会在所有类型文件被写入后调用
+  // 默认值: () => {}
+  afterBuild?: () => void | Promise<void>
+}
+```
+
+## 示例
+
+克隆项目然后执行下列命令：
+
+```sh
+pnpm run test:e2e
+```
+
+然后检查 `example/types` 目录。
+
+## 常见问题
+
+此处将收录一些常见的问题并提供一些解决方案。
+
+### 打包后出现类型文件缺失
+
+默认情况下 `skipDiagnostics` 选项的值为 `true`，这意味着打包过程中将跳过类型检查（一些项目通常有 `vue-tsc` 等的类型检查工具），这时如果出现存在类型错误的文件，并且这是错误会中断打包过程，那么这些文件对应的类型文件将不会被生成。
+
+如果您的项目没有依赖外部的类型检查工具，这时候可以您可以设置 `skipDiagnostics: false` 和 `logDiagnostics: true` 来打开插件的诊断与输出功能，这将帮助您检查打包过程中出现的类型错误并将错误信息输出至终端。
+
+### Vue 组件中同时使用了 `script` 和 `setup-script` 后出现类型错误
+
+这通常是由于分别在 `script` 和 `setup-script` 中同时使用了 `defineComponent` 方法导致的。 `vue/compiler-sfc` 为这类文件编译时会将 `script` 中的默认导出结果合并到 `setup-script` 的 `defineComponent` 的参数定义中，而 `defineComponent` 的参数类型与结果类型并不兼容，这一行为将会导致类型错误。
+
+这是一个简单的[示例](https://github.com/qmhc/vite-plugin-dts/blob/main/example/components/BothScripts.vue)，您应该将位于 `script` 中的 `defineComponent` 方法移除，直接导出一个原始的对象。
+
+### 打包时出现了无法从 `node_modules` 的包中推断类型的错误
+
+这是 TypeScript 通过软链接 (pnpm) 读取 `node_modules` 中过的类型时会出现的一个已知的问题，可以参考这个 [issue](https://github.com/microsoft/TypeScript/issues/42873)，目前已有的一个解决方案，在你的 `tsconfig.json` 中添加 `baseUrl` 以及在 `paths` 添加这些包的路径：
+
+```json
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "third-lib": ["node_modules/third-lib"]
+    }
+  }
+}
+```
+
+## 授权
+
+MIT 授权。

package/dist/index.js

@@ -32,7 +32,7 @@ module.exports = dtsPlugin;
 dtsPlugin['default'] = dtsPlugin;
 
 // src/plugin.ts
-var import_path4 = require("path");
+var import_node_path4 = require("path");
 var import_fs_extra = __toESM(require("fs-extra"));
 var import_os = __toESM(require("os"));
 var import_chalk = __toESM(require("chalk"));
@@ -43,12 +43,12 @@ var import_vite2 = require("vite");
 var import_typescript = require("typescript");
 
 // src/transform.ts
-var import_path2 = require("path");
+var import_node_path2 = require("path");
 var import_vite = require("vite");
 
 // src/utils.ts
-var import_path = require("path");
-var import_fs = require("fs");
+var import_node_path = require("path");
+var import_node_fs = require("fs");
 function isNativeObj(value) {
   return Object.prototype.toString.call(value) === "[object Object]";
 }
@@ -92,7 +92,7 @@ function mergeObjects(sourceObj, targetObj) {
   return sourceObj;
 }
 function ensureAbsolute(path, root) {
-  return path ? (0, import_path.isAbsolute)(path) ? path : (0, import_path.resolve)(root, path) : root;
+  return path ? (0, import_node_path.isAbsolute)(path) ? path : (0, import_node_path.resolve)(root, path) : root;
 }
 function ensureArray(value) {
   return Array.isArray(value) ? value : value ? [value] : [];
@@ -118,16 +118,16 @@ function queryPublicPath(paths) {
   if (paths.length === 0) {
     return "";
   } else if (paths.length === 1) {
-    return (0, import_path.dirname)(paths[0]);
+    return (0, import_node_path.dirname)(paths[0]);
   }
-  let publicPath = (0, import_path.normalize)((0, import_path.dirname)(paths[0])) + import_path.sep;
+  let publicPath = (0, import_node_path.normalize)((0, import_node_path.dirname)(paths[0])) + import_node_path.sep;
   let publicUnits = publicPath.split(speRE);
   let index2 = publicUnits.length - 1;
   for (const path of paths.slice(1)) {
     if (!index2) {
       return publicPath;
     }
-    const dirPath = (0, import_path.normalize)((0, import_path.dirname)(path)) + import_path.sep;
+    const dirPath = (0, import_node_path.normalize)((0, import_node_path.dirname)(path)) + import_node_path.sep;
     if (dirPath.startsWith(publicPath)) {
       continue;
     }
@@ -144,7 +144,7 @@ function queryPublicPath(paths) {
         }
         index2 = i - 1;
         publicUnits = publicUnits.slice(0, index2 + 1);
-        publicPath = publicUnits.join(import_path.sep) + import_path.sep;
+        publicPath = publicUnits.join(import_node_path.sep) + import_node_path.sep;
         break;
       }
     }
@@ -152,13 +152,13 @@ function queryPublicPath(paths) {
   return publicPath.slice(0, -1);
 }
 function removeDirIfEmpty(dir) {
-  if (!(0, import_fs.existsSync)(dir)) {
+  if (!(0, import_node_fs.existsSync)(dir)) {
     return;
   }
   let onlyHasDir = true;
-  for (const file of (0, import_fs.readdirSync)(dir)) {
-    const abs = (0, import_path.resolve)(dir, file);
-    if ((0, import_fs.lstatSync)(abs).isDirectory()) {
+  for (const file of (0, import_node_fs.readdirSync)(dir)) {
+    const abs = (0, import_node_path.resolve)(dir, file);
+    if ((0, import_node_fs.lstatSync)(abs).isDirectory()) {
       if (!removeDirIfEmpty(abs)) {
         onlyHasDir = false;
       }
@@ -167,7 +167,7 @@ function removeDirIfEmpty(dir) {
     }
   }
   if (onlyHasDir) {
-    (0, import_fs.rmdirSync)(dir);
+    (0, import_node_fs.rmdirSync)(dir);
   }
   return onlyHasDir;
 }
@@ -244,7 +244,7 @@ function transformAliasImport(filePath, content, aliases, exclude = []) {
         if (exclude.some((e) => isRegExp(e) ? e.test(matchResult[1]) : String(e) === matchResult[1])) {
           return str;
         }
-        const truthPath = (0, import_path2.isAbsolute)(matchedAlias.replacement) ? (0, import_vite.normalizePath)((0, import_path2.relative)((0, import_path2.dirname)(filePath), matchedAlias.replacement)) : (0, import_vite.normalizePath)(matchedAlias.replacement);
+        const truthPath = (0, import_node_path2.isAbsolute)(matchedAlias.replacement) ? (0, import_vite.normalizePath)((0, import_node_path2.relative)((0, import_node_path2.dirname)(filePath), matchedAlias.replacement)) : (0, import_vite.normalizePath)(matchedAlias.replacement);
         return str.replace(
           isDynamic ? simpleDynamicImportRE : simpleStaticImportRE,
           `$1'${matchResult[1].replace(
@@ -272,8 +272,6 @@ function transferSetupPosition(content) {
 }
 
 // src/compile.ts
-var import_node_module = require("module");
-var import_meta = {};
 var exportDefaultRE = /export\s+default/;
 var exportDefaultClassRE = /(?:(?:^|\n|;)\s*)export\s+default\s+class\s+([\w$]+)/;
 var noScriptContent = "import { defineComponent } from 'vue'\nexport default defineComponent({})";
@@ -281,21 +279,20 @@ var index = 1;
 var compileRoot = null;
 var compiler;
 var vue;
-var _require = (0, import_node_module.createRequire)(import_meta.url);
 function requireCompiler() {
   if (!compiler) {
     if (compileRoot) {
       try {
-        compiler = _require(_require.resolve("vue/compiler-sfc", { paths: [compileRoot] }));
+        compiler = require(require.resolve("vue/compiler-sfc", { paths: [compileRoot] }));
       } catch (e) {
       }
     }
     if (!compiler) {
       try {
-        compiler = _require("vue/compiler-sfc");
+        compiler = require("vue/compiler-sfc");
       } catch (e) {
         try {
-          compiler = _require("@vue/compiler-sfc");
+          compiler = require("@vue/compiler-sfc");
         } catch (e2) {
           throw new Error("@vue/compiler-sfc is not present in the dependency tree.\n");
         }
@@ -308,13 +305,13 @@ function isVue3() {
   if (!vue) {
     if (compileRoot) {
       try {
-        vue = _require(_require.resolve("vue", { paths: [compileRoot] }));
+        vue = require(require.resolve("vue", { paths: [compileRoot] }));
       } catch (e) {
       }
     }
     if (!vue) {
       try {
-        vue = _require("vue");
+        vue = require("vue");
       } catch (e) {
         throw new Error("vue is not present in the dependency tree.\n");
       }
@@ -384,7 +381,7 @@ const _sfc_main = ${classMatch[1]}`;
 }
 
 // src/rollup.ts
-var import_path3 = require("path");
+var import_node_path3 = require("path");
 var import_api_extractor = require("@microsoft/api-extractor");
 var import_Collector = require("@microsoft/api-extractor/lib/collector/Collector");
 var import_MessageRouter = require("@microsoft/api-extractor/lib/collector/MessageRouter");
@@ -399,7 +396,7 @@ function rollupDeclarationFiles({
   fileName,
   compilerOptions
 }) {
-  const configObjectFullPath = (0, import_path3.resolve)(root, "api-extractor.json");
+  const configObjectFullPath = (0, import_node_path3.resolve)(root, "api-extractor.json");
   const packageJsonLookup = new import_node_core_library.PackageJsonLookup();
   const packageJsonFullPath = packageJsonLookup.tryGetPackageJsonFilePathFor(configObjectFullPath);
   if (!dtsRE.test(fileName)) {
@@ -422,7 +419,7 @@ function rollupDeclarationFiles({
       },
       dtsRollup: {
         enabled: true,
-        publicTrimmedFilePath: (0, import_path3.resolve)(outputDir, fileName)
+        publicTrimmedFilePath: (0, import_node_path3.resolve)(outputDir, fileName)
       },
       tsdocMetadata: {
         enabled: false
@@ -695,7 +692,7 @@ ${logPrefix} Start generate declaration files...`));
       const service = project.getLanguageService();
       const outputFiles = project.getSourceFiles().map(
         (sourceFile) => service.getEmitOutput(sourceFile, true).getOutputFiles().map((outputFile) => ({
-          path: (0, import_vite2.normalizePath)((0, import_path4.resolve)(root, outputFile.compilerObject.name)),
+          path: (0, import_vite2.normalizePath)((0, import_node_path4.resolve)(root, outputFile.compilerObject.name)),
           content: outputFile.getText()
         }))
       ).flat().concat(dtsOutputFiles);
@@ -718,9 +715,9 @@ ${logPrefix} Start generate declaration files...`));
           content = transformAliasImport(filePath, content, aliases, aliasesExclude);
           content = staticImport || rollupTypes ? transformDynamicImport(content) : content;
         }
-        filePath = (0, import_path4.resolve)(
+        filePath = (0, import_node_path4.resolve)(
           outputDir,
-          (0, import_path4.relative)(entryRoot, cleanVueFileName ? filePath.replace(".vue.d.ts", ".d.ts") : filePath)
+          (0, import_node_path4.relative)(entryRoot, cleanVueFileName ? filePath.replace(".vue.d.ts", ".d.ts") : filePath)
         );
         if (typeof beforeWriteFile === "function") {
           const result = beforeWriteFile(filePath, content);
@@ -731,7 +728,7 @@ ${logPrefix} Start generate declaration files...`));
             content = result.content ?? content;
           }
         }
-        await import_fs_extra.default.mkdir((0, import_path4.dirname)(filePath), { recursive: true });
+        await import_fs_extra.default.mkdir((0, import_node_path4.dirname)(filePath), { recursive: true });
         await import_fs_extra.default.writeFile(
           filePath,
           cleanVueFileName ? content.replace(/['"](.+)\.vue['"]/g, '"$1"') : content,
@@ -741,14 +738,14 @@ ${logPrefix} Start generate declaration files...`));
       });
       bundleDebug("output");
       if (insertTypesEntry || rollupTypes) {
-        const pkgPath = (0, import_path4.resolve)(root, "package.json");
+        const pkgPath = (0, import_node_path4.resolve)(root, "package.json");
         const pkg = import_fs_extra.default.existsSync(pkgPath) ? JSON.parse(await import_fs_extra.default.readFile(pkgPath, "utf-8")) : {};
         const types = pkg.types || pkg.typings;
-        let typesPath = types ? (0, import_path4.resolve)(root, types) : (0, import_path4.resolve)(outputDir, indexName);
+        let typesPath = types ? (0, import_node_path4.resolve)(root, types) : (0, import_node_path4.resolve)(outputDir, indexName);
         if (!import_fs_extra.default.existsSync(typesPath)) {
           const entry = entries[0];
-          const outputIndex = (0, import_path4.resolve)(outputDir, (0, import_path4.relative)(entryRoot, entry.replace(tsRE, ".d.ts")));
-          let filePath = (0, import_vite2.normalizePath)((0, import_path4.relative)((0, import_path4.dirname)(typesPath), outputIndex));
+          const outputIndex = (0, import_node_path4.resolve)(outputDir, (0, import_node_path4.relative)(entryRoot, entry.replace(tsRE, ".d.ts")));
+          let filePath = (0, import_vite2.normalizePath)((0, import_node_path4.relative)((0, import_node_path4.dirname)(typesPath), outputIndex));
           filePath = filePath.replace(dtsRE2, "");
           filePath = fullRelativeRE.test(filePath) ? filePath : `./${filePath}`;
           let content = `export * from '${filePath}'
@@ -783,7 +780,7 @@ export default ${libName}
             compilerOptions,
             outputDir,
             entryPath: typesPath,
-            fileName: (0, import_path4.basename)(typesPath)
+            fileName: (0, import_node_path4.basename)(typesPath)
           });
           const wroteFile = (0, import_vite2.normalizePath)(typesPath);
           wroteFiles.delete(wroteFile);
@@ -793,7 +790,7 @@ export default ${libName}
           wroteFiles.add(wroteFile);
           if (copyDtsFiles) {
             await runParallel(import_os.default.cpus().length, dtsOutputFiles, async ({ path, content }) => {
-              const filePath = (0, import_path4.resolve)(outputDir, (0, import_path4.basename)(path));
+              const filePath = (0, import_node_path4.resolve)(outputDir, (0, import_node_path4.basename)(path));
               await import_fs_extra.default.writeFile(filePath, content, "utf-8");
               wroteFiles.add((0, import_vite2.normalizePath)(filePath));
             });
@@ -804,12 +801,12 @@ export default ${libName}
       if (outputDirs.length > 1) {
         const dirs = outputDirs.slice(1);
         await runParallel(import_os.default.cpus().length, Array.from(wroteFiles), async (wroteFile) => {
-          const relativePath = (0, import_path4.relative)(outputDir, wroteFile);
+          const relativePath = (0, import_node_path4.relative)(outputDir, wroteFile);
           const content = await import_fs_extra.default.readFile(wroteFile, "utf-8");
           await Promise.all(
             dirs.map(async (dir) => {
-              const filePath = (0, import_path4.resolve)(dir, relativePath);
-              await import_fs_extra.default.mkdir((0, import_path4.dirname)(filePath), { recursive: true });
+              const filePath = (0, import_node_path4.resolve)(dir, relativePath);
+              await import_fs_extra.default.mkdir((0, import_node_path4.dirname)(filePath), { recursive: true });
               await import_fs_extra.default.writeFile(filePath, content, "utf-8");
             })
           );

package/dist/index.mjs

@@ -1,5 +1,13 @@
+var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
+  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
+}) : x)(function(x) {
+  if (typeof require !== "undefined")
+    return require.apply(this, arguments);
+  throw new Error('Dynamic require of "' + x + '" is not supported');
+});
+
 // src/plugin.ts
-import { resolve as resolve3, dirname as dirname3, relative as relative2, basename } from "path";
+import { resolve as resolve3, dirname as dirname3, relative as relative2, basename } from "node:path";
 import fs from "fs-extra";
 import os from "os";
 import chalk from "chalk";
@@ -10,12 +18,12 @@ import { normalizePath as normalizePath2 } from "vite";
 import { readConfigFile } from "typescript";
 
 // src/transform.ts
-import { dirname as dirname2, relative, isAbsolute as isAbsolute2 } from "path";
+import { dirname as dirname2, relative, isAbsolute as isAbsolute2 } from "node:path";
 import { normalizePath } from "vite";
 
 // src/utils.ts
-import { resolve, isAbsolute, dirname, normalize, sep } from "path";
-import { existsSync, readdirSync, lstatSync, rmdirSync } from "fs";
+import { resolve, isAbsolute, dirname, normalize, sep } from "node:path";
+import { existsSync, readdirSync, lstatSync, rmdirSync } from "node:fs";
 function isNativeObj(value) {
   return Object.prototype.toString.call(value) === "[object Object]";
 }
@@ -239,7 +247,6 @@ function transferSetupPosition(content) {
 }
 
 // src/compile.ts
-import { createRequire } from "node:module";
 var exportDefaultRE = /export\s+default/;
 var exportDefaultClassRE = /(?:(?:^|\n|;)\s*)export\s+default\s+class\s+([\w$]+)/;
 var noScriptContent = "import { defineComponent } from 'vue'\nexport default defineComponent({})";
@@ -247,21 +254,20 @@ var index = 1;
 var compileRoot = null;
 var compiler;
 var vue;
-var _require = createRequire(import.meta.url);
 function requireCompiler() {
   if (!compiler) {
     if (compileRoot) {
       try {
-        compiler = _require(_require.resolve("vue/compiler-sfc", { paths: [compileRoot] }));
+        compiler = __require(__require.resolve("vue/compiler-sfc", { paths: [compileRoot] }));
       } catch (e) {
       }
     }
     if (!compiler) {
       try {
-        compiler = _require("vue/compiler-sfc");
+        compiler = __require("vue/compiler-sfc");
       } catch (e) {
         try {
-          compiler = _require("@vue/compiler-sfc");
+          compiler = __require("@vue/compiler-sfc");
         } catch (e2) {
           throw new Error("@vue/compiler-sfc is not present in the dependency tree.\n");
         }
@@ -274,13 +280,13 @@ function isVue3() {
   if (!vue) {
     if (compileRoot) {
       try {
-        vue = _require(_require.resolve("vue", { paths: [compileRoot] }));
+        vue = __require(__require.resolve("vue", { paths: [compileRoot] }));
       } catch (e) {
       }
     }
     if (!vue) {
       try {
-        vue = _require("vue");
+        vue = __require("vue");
       } catch (e) {
         throw new Error("vue is not present in the dependency tree.\n");
       }
@@ -350,7 +356,7 @@ const _sfc_main = ${classMatch[1]}`;
 }
 
 // src/rollup.ts
-import { resolve as resolve2 } from "path";
+import { resolve as resolve2 } from "node:path";
 import { ExtractorConfig, CompilerState } from "@microsoft/api-extractor";
 import { Collector } from "@microsoft/api-extractor/lib/collector/Collector";
 import { MessageRouter } from "@microsoft/api-extractor/lib/collector/MessageRouter";

package/package.json

@@ -94,5 +94,5 @@
     "test:e2e": "pnpm -C example build"
   },
   "types": "dist/index.d.ts",
-  "version": "1.6.0"
+  "version": "1.6.1"
 }