vite-plugin-dts 3.1.1 → 3.3.0

package/README.md

@@ -97,11 +97,14 @@ export interface Resolver {
   supports: (id: string) => void | boolean,
   /**
    * Transform source to declaration files
+   *
+   * Note that the path of the returns should base on `outDir`, or relative path to `root`
    */
   transform: (payload: {
     id: string,
     code: string,
     root: string,
+    outDir: string,
     host: ts.CompilerHost,
     program: ts.Program,
     service: ts.LanguageService
@@ -166,6 +169,16 @@ export interface PluginOptions {
    */
   resolvers?: Resolver[],
 
+  /**
+   * Parsing `paths` of tsconfig.json to aliases
+   *
+   * Note that these aliases only use for declaration files
+   *
+   * @default true
+   * @remarks Only use first replacement of each path
+   */
+  pathsToAliases?: boolean,
+
   /**
    * Set which paths should be excluded when transforming aliases
    *
@@ -267,20 +280,21 @@ export interface PluginOptions {
    *
    * This allows you to transform the path or content
    *
-   * The file will be skipped when the return value `false`
+   * The file will be skipped when the return value `false` or `Promise<false>`
    *
    * @default () => {}
    */
   beforeWriteFile?: (
     filePath: string,
     content: string
-  ) =>
-  | void
-  | false
-  | {
-    filePath?: string,
-    content?: string
-  },
+  ) => MaybePromise<
+    | void
+    | false
+    | {
+      filePath?: string,
+      content?: string
+    }
+  >,
 
   /**
    * Hook called after all declaration files are written

package/README.zh-CN.md

@@ -97,11 +97,14 @@ export interface Resolver {
   supports: (id: string) => void | boolean,
   /**
    * 将源文件转换为类型文件
+   *
+   * 注意，返回的文件的路径应该基于 `outDir`，或者相对于 `root`
    */
   transform: (payload: {
     id: string,
     code: string,
     root: string,
+    outDir: string,
     host: ts.CompilerHost,
     program: ts.Program,
     service: ts.LanguageService
@@ -166,6 +169,16 @@ export interface PluginOptions {
    */
   resolvers?: Resolver[],
 
+  /**
+   * 解析 tsconfig.json 的 `paths` 作为别名
+   *
+   * 注意，这些别名仅用在类型文件中使用
+   *
+   * @default true
+   * @remarks 只使用每个路径的第一个替换
+   */
+  pathsToAliases?: boolean,
+
   /**
    * 设置在转换别名时哪些路径需要排除
    *
@@ -267,20 +280,21 @@ export interface PluginOptions {
    *
    * 可以在钩子里转换文件路径和文件内容
    *
-   * 当返回 `false` 时会跳过该文件
+   * 当返回 `false` 或 `Promise<false>` 时会跳过该文件
    *
    * @default () => {}
    */
   beforeWriteFile?: (
     filePath: string,
     content: string
-  ) =>
-  | void
-  | false
-  | {
-    filePath?: string,
-    content?: string
-  },
+  ) => MaybePromise<
+    | void
+    | false
+    | {
+      filePath?: string,
+      content?: string
+    }
+  >,
 
   /**
    * 在所有类型文件被写入后调用的钩子