vite-plugin-dts 0.9.3 → 0.9.7

package/README.md

@@ -7,7 +7,7 @@ A vite plugin that generate `.d.ts` files from `.ts` or `.vue` source files for
 ## Install
 
 ```sh
-yarn add vite-plugin-dts -D
+pnpm add vite-plugin-dts -D
 ```
 
 ## Usage
@@ -122,10 +122,13 @@ export interface PluginOptions {
   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
 
@@ -151,11 +154,27 @@ export interface PluginOptions {
 Clone and run the following script:
 
 ```sh
-yarn run test:e2e
+pnpm run test:e2e
 ```
 
 Then check `example/types`.
 
+## FAQ
+
+Here will include some FAQ's and provide some 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 tool such as `vue-tsc`). If there are some files with type errors which will interrupt the build process, these files will not be emitted (not generate declaration files).
+
+If your project has not 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 to 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 in `script` will be merged into the parameter object of `defineComponent` that in `setup-script`, but there is incompatible of `defineComponent` returned types and parameter types, then a type error is caused.
+
+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.
+
 ## License
 
 MIT License.

package/README.zh-CN.md

@@ -7,7 +7,7 @@
 ## 安装
 
 ```sh
-yarn add vite-plugin-dts -D
+pnpm add vite-plugin-dts -D
 ```
 
 ## 使用
@@ -121,10 +121,13 @@ export interface PluginOptions {
   noEmitOnError?: boolean
 
   // 是否跳过类型诊断
+  // 跳过类型诊断意味着出现错误时不会中断打包进程的执行
+  // 但对于出现错误的源文件，将无法生成相应的类型文件
   // 默认值: true
   skipDiagnostics?: boolean
 
   // 是否打印类型诊断信息
+  // 当跳过类型诊断时该属性将不会生效
   // 默认值: false
   logDiagnostics?: boolean
 
@@ -145,16 +148,32 @@ export interface PluginOptions {
 }
 ```
 
-## Example
+## 示例
 
 克隆项目然后执行下列命令：
 
 ```sh
-yarn run test:e2e
+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` 方法移除，直接导出一个原始的对象。
+
 ## 授权
 
-MIT License
+MIT 授权。