vite-plugin-dts 3.8.3 → 3.9.1

package/README.md

@@ -355,6 +355,13 @@ export interface PluginOptions {
     }
   >,
 
+  /**
+   * Hook called after rolling up declaration files
+   *
+   * @default () => {}
+   */
+  afterRollup?: (result: ExtractorResult) => MaybePromise<void>,
+
   /**
    * Hook called after all declaration files are written
    *

package/README.zh-CN.md

@@ -269,7 +269,7 @@ export interface PluginOptions {
   insertTypesEntry?: boolean,
 
   /**
-   * 设置是否在发出类型文件后将其打包
+   * 设置是否将发出的类型文件打包进单个文件
    *
    * 基于 `@microsoft/api-extractor`，过程将会消耗一些时间
    *
@@ -356,7 +356,14 @@ export interface PluginOptions {
   >,
 
   /**
-   * 在所有类型文件被写入后调用的钩子
+   * 类型文件被打包进单个文件后的钩子
+   *
+   * @default () => {}
+   */
+  afterRollup?: (result: ExtractorResult) => MaybePromise<void>,
+
+  /**
+   * 在所有类型文件被写入后的钩子
    *
    * 它会接收一个记录了那些最终被写入的文件的映射（path -> content）
    *

package/dist/index.cjs

@@ -307,14 +307,13 @@ function rollupDeclarationFiles({
     configObjectFullPath,
     packageJsonFullPath: tryGetPkgPath(configObjectFullPath)
   });
-  const result = apiExtractor.Extractor.invoke(extractorConfig, {
+  return apiExtractor.Extractor.invoke(extractorConfig, {
     localBuild: false,
     showVerboseMessages: false,
     showDiagnostics: false,
     typescriptCompilerFolder: libFolder ? node_path.resolve(libFolder) : void 0,
     ...rollupOptions
   });
-  return result.succeeded;
 }
 
 const jsonRE = /\.json$/;
@@ -457,18 +456,17 @@ function transformCode(options) {
   const importMap = /* @__PURE__ */ new Map();
   const usedDefault = /* @__PURE__ */ new Map();
   const declareModules = [];
+  const toLibName = (origin) => {
+    const name = transformAlias(origin, dir, options.aliases, options.aliasesExclude);
+    return options.cleanVueFileName ? name.replace(/\.vue$/, "") : name;
+  };
   let indexCount = 0;
   walkSourceFile(ast, (node, parent) => {
     if (ts__default.isImportDeclaration(node)) {
       if (!node.importClause) {
         options.clearPureImport && s.remove(node.pos, node.end);
       } else if (ts__default.isStringLiteral(node.moduleSpecifier) && (node.importClause.name || node.importClause.namedBindings && ts__default.isNamedImports(node.importClause.namedBindings))) {
-        const libName = transformAlias(
-          node.moduleSpecifier.text,
-          dir,
-          options.aliases,
-          options.aliasesExclude
-        );
+        const libName = toLibName(node.moduleSpecifier.text);
         const importSet = importMap.get(libName) ?? importMap.set(libName, /* @__PURE__ */ new Set()).get(libName);
         if (node.importClause.name && !usedDefault.has(libName)) {
           const usedType = node.importClause.name.escapedText;
@@ -489,12 +487,7 @@ function transformCode(options) {
       return false;
     }
     if (ts__default.isImportTypeNode(node) && node.qualifier && ts__default.isLiteralTypeNode(node.argument) && ts__default.isIdentifier(node.qualifier) && ts__default.isStringLiteral(node.argument.literal)) {
-      const libName = transformAlias(
-        node.argument.literal.text,
-        dir,
-        options.aliases,
-        options.aliasesExclude
-      );
+      const libName = toLibName(node.argument.literal.text);
       if (!options.staticImport) {
         s.update(node.argument.literal.pos, node.argument.literal.end, `'${libName}'`);
         return !!node.typeArguments;
@@ -516,23 +509,19 @@ function transformCode(options) {
       return !!node.typeArguments;
     }
     if (ts__default.isCallExpression(node) && node.expression.kind === ts__default.SyntaxKind.ImportKeyword && ts__default.isStringLiteral(node.arguments[0])) {
-      const libName = transformAlias(
-        node.arguments[0].text,
-        dir,
-        options.aliases,
-        options.aliasesExclude
+      s.update(
+        node.arguments[0].pos,
+        node.arguments[0].end,
+        `'${toLibName(node.arguments[0].text)}'`
       );
-      s.update(node.arguments[0].pos, node.arguments[0].end, `'${libName}'`);
       return false;
     }
     if (ts__default.isExportDeclaration(node) && node.moduleSpecifier && ts__default.isStringLiteral(node.moduleSpecifier)) {
-      const libName = transformAlias(
-        node.moduleSpecifier.text,
-        dir,
-        options.aliases,
-        options.aliasesExclude
+      s.update(
+        node.moduleSpecifier.pos,
+        node.moduleSpecifier.end,
+        ` '${toLibName(node.moduleSpecifier.text)}'`
       );
-      s.update(node.moduleSpecifier.pos, node.moduleSpecifier.end, ` '${libName}'`);
       return false;
     }
     if (ts__default.isModuleDeclaration(node)) {
@@ -544,10 +533,12 @@ function transformCode(options) {
       return false;
     }
   });
+  let prependImports = "";
   importMap.forEach((importSet, libName) => {
-    s.prepend(`import { ${Array.from(importSet).join(", ")} } from '${libName}';
-`);
+    prependImports += `import { ${Array.from(importSet).join(", ")} } from '${libName}';
+`;
   });
+  s.prepend(prependImports);
   return {
     content: s.toString(),
     declareModules
@@ -624,6 +615,7 @@ function dtsPlugin(options = {}) {
     strictOutput = true,
     afterDiagnostic = noop,
     beforeWriteFile = noop,
+    afterRollup = noop,
     afterBuild = noop
   } = options;
   let root = ensureAbsolute(options.root ?? "", process.cwd());
@@ -942,7 +934,6 @@ ${logPrefix} Start generate declaration files...`));
       }
       bundleDebug("emit output patch");
       const currentDir = host.getCurrentDirectory();
-      const vuePathRE = /['"](.+)\.vue['"]/g;
       await runParallel(
         node_os.cpus().length,
         Array.from(outputFiles.entries()),
@@ -956,7 +947,8 @@ ${logPrefix} Start generate declaration files...`));
               aliases,
               aliasesExclude,
               staticImport,
-              clearPureImport
+              clearPureImport,
+              cleanVueFileName
             });
             content = result.content;
             declareModules.push(...result.declareModules);
@@ -968,7 +960,6 @@ ${logPrefix} Start generate declaration files...`));
               cleanVueFileName ? filePath.replace(".vue.d.ts", ".d.ts") : filePath
             )
           );
-          content = cleanVueFileName ? content.replace(vuePathRE, '"$1"') : content;
           if (isMapFile) {
             try {
               const sourceMap = JSON.parse(content);
@@ -1043,37 +1034,30 @@ export default ${libName}
           }
           const rollupFiles = /* @__PURE__ */ new Set();
           const compilerOptions2 = configPath ? getTsConfig(configPath, host.readFile).compilerOptions : rawCompilerOptions;
-          if (multiple) {
-            for (const name of entryNames) {
-              const path = cleanPath(resolve(outDir, tsToDts(name)));
-              rollupDeclarationFiles({
-                root,
-                configPath,
-                compilerOptions: compilerOptions2,
-                outDir,
-                entryPath: path,
-                fileName: node_path.basename(path),
-                libFolder,
-                rollupConfig,
-                rollupOptions
-              });
-              emittedFiles.delete(path);
-              rollupFiles.add(path);
-            }
-          } else {
-            rollupDeclarationFiles({
+          const rollup = async (path) => {
+            const result = rollupDeclarationFiles({
               root,
               configPath,
               compilerOptions: compilerOptions2,
               outDir,
-              entryPath: typesPath,
-              fileName: node_path.basename(typesPath),
+              entryPath: path,
+              fileName: node_path.basename(path),
               libFolder,
               rollupConfig,
               rollupOptions
             });
-            emittedFiles.delete(typesPath);
-            rollupFiles.add(typesPath);
+            emittedFiles.delete(path);
+            rollupFiles.add(path);
+            if (typeof afterRollup === "function") {
+              await unwrapPromise(afterRollup(result));
+            }
+          };
+          if (multiple) {
+            await runParallel(node_os.cpus().length, entryNames, async (name) => {
+              await rollup(cleanPath(resolve(outDir, tsToDts(name))));
+            });
+          } else {
+            await rollup(typesPath);
           }
           await runParallel(node_os.cpus().length, Array.from(emittedFiles.keys()), (f) => promises.unlink(f));
           removeDirIfEmpty(outDir);

package/dist/index.d.cts

@@ -1,7 +1,7 @@
 import * as vite from 'vite';
 import { LogLevel } from 'vite';
 import ts from 'typescript';
-import { IExtractorInvokeOptions, IExtractorConfigPrepareOptions } from '@microsoft/api-extractor';
+import { IExtractorInvokeOptions, ExtractorResult, IExtractorConfigPrepareOptions } from '@microsoft/api-extractor';
 
 type MaybePromise<T> = T | Promise<T>;
 type RollupConfig = Omit<IExtractorConfigPrepareOptions['configObject'], 'projectFolder' | 'mainEntryPointFilePath' | 'compiler' | 'dtsRollup'>;
@@ -213,6 +213,12 @@ interface PluginOptions {
         filePath?: string;
         content?: string;
     }>;
+    /**
+     * Hook called after rolling up declaration files
+     *
+     * @default () => {}
+     */
+    afterRollup?: (result: ExtractorResult) => MaybePromise<void>;
     /**
      * Hook called after all declaration files are written
      *

package/dist/index.d.mts

@@ -1,7 +1,7 @@
 import * as vite from 'vite';
 import { LogLevel } from 'vite';
 import ts from 'typescript';
-import { IExtractorInvokeOptions, IExtractorConfigPrepareOptions } from '@microsoft/api-extractor';
+import { IExtractorInvokeOptions, ExtractorResult, IExtractorConfigPrepareOptions } from '@microsoft/api-extractor';
 
 type MaybePromise<T> = T | Promise<T>;
 type RollupConfig = Omit<IExtractorConfigPrepareOptions['configObject'], 'projectFolder' | 'mainEntryPointFilePath' | 'compiler' | 'dtsRollup'>;
@@ -213,6 +213,12 @@ interface PluginOptions {
         filePath?: string;
         content?: string;
     }>;
+    /**
+     * Hook called after rolling up declaration files
+     *
+     * @default () => {}
+     */
+    afterRollup?: (result: ExtractorResult) => MaybePromise<void>;
     /**
      * Hook called after all declaration files are written
      *

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import * as vite from 'vite';
 import { LogLevel } from 'vite';
 import ts from 'typescript';
-import { IExtractorInvokeOptions, IExtractorConfigPrepareOptions } from '@microsoft/api-extractor';
+import { IExtractorInvokeOptions, ExtractorResult, IExtractorConfigPrepareOptions } from '@microsoft/api-extractor';
 
 type MaybePromise<T> = T | Promise<T>;
 type RollupConfig = Omit<IExtractorConfigPrepareOptions['configObject'], 'projectFolder' | 'mainEntryPointFilePath' | 'compiler' | 'dtsRollup'>;
@@ -213,6 +213,12 @@ interface PluginOptions {
         filePath?: string;
         content?: string;
     }>;
+    /**
+     * Hook called after rolling up declaration files
+     *
+     * @default () => {}
+     */
+    afterRollup?: (result: ExtractorResult) => MaybePromise<void>;
     /**
      * Hook called after all declaration files are written
      *

package/dist/index.mjs

@@ -304,14 +304,13 @@ function rollupDeclarationFiles({
     configObjectFullPath,
     packageJsonFullPath: tryGetPkgPath(configObjectFullPath)
   });
-  const result = Extractor.invoke(extractorConfig, {
+  return Extractor.invoke(extractorConfig, {
     localBuild: false,
     showVerboseMessages: false,
     showDiagnostics: false,
     typescriptCompilerFolder: libFolder ? resolve$1(libFolder) : void 0,
     ...rollupOptions
   });
-  return result.succeeded;
 }
 
 const jsonRE = /\.json$/;
@@ -454,18 +453,17 @@ function transformCode(options) {
   const importMap = /* @__PURE__ */ new Map();
   const usedDefault = /* @__PURE__ */ new Map();
   const declareModules = [];
+  const toLibName = (origin) => {
+    const name = transformAlias(origin, dir, options.aliases, options.aliasesExclude);
+    return options.cleanVueFileName ? name.replace(/\.vue$/, "") : name;
+  };
   let indexCount = 0;
   walkSourceFile(ast, (node, parent) => {
     if (ts.isImportDeclaration(node)) {
       if (!node.importClause) {
         options.clearPureImport && s.remove(node.pos, node.end);
       } else if (ts.isStringLiteral(node.moduleSpecifier) && (node.importClause.name || node.importClause.namedBindings && ts.isNamedImports(node.importClause.namedBindings))) {
-        const libName = transformAlias(
-          node.moduleSpecifier.text,
-          dir,
-          options.aliases,
-          options.aliasesExclude
-        );
+        const libName = toLibName(node.moduleSpecifier.text);
         const importSet = importMap.get(libName) ?? importMap.set(libName, /* @__PURE__ */ new Set()).get(libName);
         if (node.importClause.name && !usedDefault.has(libName)) {
           const usedType = node.importClause.name.escapedText;
@@ -486,12 +484,7 @@ function transformCode(options) {
       return false;
     }
     if (ts.isImportTypeNode(node) && node.qualifier && ts.isLiteralTypeNode(node.argument) && ts.isIdentifier(node.qualifier) && ts.isStringLiteral(node.argument.literal)) {
-      const libName = transformAlias(
-        node.argument.literal.text,
-        dir,
-        options.aliases,
-        options.aliasesExclude
-      );
+      const libName = toLibName(node.argument.literal.text);
       if (!options.staticImport) {
         s.update(node.argument.literal.pos, node.argument.literal.end, `'${libName}'`);
         return !!node.typeArguments;
@@ -513,23 +506,19 @@ function transformCode(options) {
       return !!node.typeArguments;
     }
     if (ts.isCallExpression(node) && node.expression.kind === ts.SyntaxKind.ImportKeyword && ts.isStringLiteral(node.arguments[0])) {
-      const libName = transformAlias(
-        node.arguments[0].text,
-        dir,
-        options.aliases,
-        options.aliasesExclude
+      s.update(
+        node.arguments[0].pos,
+        node.arguments[0].end,
+        `'${toLibName(node.arguments[0].text)}'`
       );
-      s.update(node.arguments[0].pos, node.arguments[0].end, `'${libName}'`);
       return false;
     }
     if (ts.isExportDeclaration(node) && node.moduleSpecifier && ts.isStringLiteral(node.moduleSpecifier)) {
-      const libName = transformAlias(
-        node.moduleSpecifier.text,
-        dir,
-        options.aliases,
-        options.aliasesExclude
+      s.update(
+        node.moduleSpecifier.pos,
+        node.moduleSpecifier.end,
+        ` '${toLibName(node.moduleSpecifier.text)}'`
       );
-      s.update(node.moduleSpecifier.pos, node.moduleSpecifier.end, ` '${libName}'`);
       return false;
     }
     if (ts.isModuleDeclaration(node)) {
@@ -541,10 +530,12 @@ function transformCode(options) {
       return false;
     }
   });
+  let prependImports = "";
   importMap.forEach((importSet, libName) => {
-    s.prepend(`import { ${Array.from(importSet).join(", ")} } from '${libName}';
-`);
+    prependImports += `import { ${Array.from(importSet).join(", ")} } from '${libName}';
+`;
   });
+  s.prepend(prependImports);
   return {
     content: s.toString(),
     declareModules
@@ -621,6 +612,7 @@ function dtsPlugin(options = {}) {
     strictOutput = true,
     afterDiagnostic = noop,
     beforeWriteFile = noop,
+    afterRollup = noop,
     afterBuild = noop
   } = options;
   let root = ensureAbsolute(options.root ?? "", process.cwd());
@@ -939,7 +931,6 @@ ${logPrefix} Start generate declaration files...`));
       }
       bundleDebug("emit output patch");
       const currentDir = host.getCurrentDirectory();
-      const vuePathRE = /['"](.+)\.vue['"]/g;
       await runParallel(
         cpus().length,
         Array.from(outputFiles.entries()),
@@ -953,7 +944,8 @@ ${logPrefix} Start generate declaration files...`));
               aliases,
               aliasesExclude,
               staticImport,
-              clearPureImport
+              clearPureImport,
+              cleanVueFileName
             });
             content = result.content;
             declareModules.push(...result.declareModules);
@@ -965,7 +957,6 @@ ${logPrefix} Start generate declaration files...`));
               cleanVueFileName ? filePath.replace(".vue.d.ts", ".d.ts") : filePath
             )
           );
-          content = cleanVueFileName ? content.replace(vuePathRE, '"$1"') : content;
           if (isMapFile) {
             try {
               const sourceMap = JSON.parse(content);
@@ -1040,37 +1031,30 @@ export default ${libName}
           }
           const rollupFiles = /* @__PURE__ */ new Set();
           const compilerOptions2 = configPath ? getTsConfig(configPath, host.readFile).compilerOptions : rawCompilerOptions;
-          if (multiple) {
-            for (const name of entryNames) {
-              const path = cleanPath(resolve(outDir, tsToDts(name)));
-              rollupDeclarationFiles({
-                root,
-                configPath,
-                compilerOptions: compilerOptions2,
-                outDir,
-                entryPath: path,
-                fileName: basename(path),
-                libFolder,
-                rollupConfig,
-                rollupOptions
-              });
-              emittedFiles.delete(path);
-              rollupFiles.add(path);
-            }
-          } else {
-            rollupDeclarationFiles({
+          const rollup = async (path) => {
+            const result = rollupDeclarationFiles({
               root,
               configPath,
               compilerOptions: compilerOptions2,
               outDir,
-              entryPath: typesPath,
-              fileName: basename(typesPath),
+              entryPath: path,
+              fileName: basename(path),
               libFolder,
               rollupConfig,
               rollupOptions
             });
-            emittedFiles.delete(typesPath);
-            rollupFiles.add(typesPath);
+            emittedFiles.delete(path);
+            rollupFiles.add(path);
+            if (typeof afterRollup === "function") {
+              await unwrapPromise(afterRollup(result));
+            }
+          };
+          if (multiple) {
+            await runParallel(cpus().length, entryNames, async (name) => {
+              await rollup(cleanPath(resolve(outDir, tsToDts(name))));
+            });
+          } else {
+            await rollup(typesPath);
           }
           await runParallel(cpus().length, Array.from(emittedFiles.keys()), (f) => unlink(f));
           removeDirIfEmpty(outDir);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-dts",
-  "version": "3.8.3",
+  "version": "3.9.1",
   "type": "module",
   "license": "MIT",
   "author": "qmhc",