docs: more details for diagnostics options

README.md

@@ -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
 

README.zh-CN.md

@@ -121,10 +121,13 @@ export interface PluginOptions {
   noEmitOnError?: boolean
 
   // 是否跳过类型诊断
+  // 跳过类型诊断意味着出现错误时不会中断打包进程的执行
+  // 但对于出现错误的源文件，将无法生成相应的类型文件
   // 默认值: true
   skipDiagnostics?: boolean
 
   // 是否打印类型诊断信息
+  // 当跳过类型诊断时该属性将不会生效
   // 默认值: false
   logDiagnostics?: boolean
 
@@ -157,4 +160,4 @@ yarn run test:e2e
 
 ## 授权
 
-MIT License
+MIT 授权。