vite-plugin-dts 4.0.3 → 4.1.1

package/README.md

@@ -53,6 +53,14 @@ If you want to merge all declarations into one file, just specify `rollupTypes:
 }
 ```
 
+If you start with official Vite template, you should specify the `tsconfigPath`:
+
+```ts
+{
+  plugins: [dts({ tsconfigPath: './tsconfig.app.json' })]
+}
+```
+
 Starting with `3.0.0`, you can use this plugin with Rollup.
 
 ## FAQ
@@ -148,145 +156,146 @@ export interface Resolver {
     root: string,
     outDir: string,
     host: ts.CompilerHost,
-    program: ts.Program,
-    service: ts.LanguageService
+    program: ts.Program
   }) => MaybePromise<{ path: string, content: string }[]>
 }
 
 export interface PluginOptions {
   /**
-   * Specify root directory
+   * Specify root directory.
    *
-   * Defaults to the 'root' of the Vite config, or `process.cwd()` if using Rollup
+   * Defaults to the 'root' of the Vite config, or `process.cwd()` if using Rollup.
    */
   root?: string,
 
   /**
-   * Output directory for declaration files
+   * Output directory for declaration files.
    *
-   * Can be an array to output to multiple directories
+   * Can be an array to output to multiple directories.
    *
-   * Defaults to 'build.outDir' of the Vite config, or `outDir` of tsconfig.json if using Rollup
+   * Defaults to 'build.outDir' of the Vite config, or `outDir` of tsconfig.json if using Rollup.
    */
   outDir?: string | string[],
 
   /**
-   * Override root path of entry files (useful in monorepos)
+   * Override root path of entry files (useful in monorepos).
    *
-   * The output path of each file will be calculated based on the value provided
+   * The output path of each file will be calculated based on the value provided.
    *
-   * The default is the smallest public path for all source files
+   * The default is the smallest public path for all source files.
    */
   entryRoot?: string,
 
   /**
-   * Restrict declaration files output to `outDir`
+   * Restrict declaration files output to `outDir`.
    *
-   * If true, generated declaration files outside `outDir` will be ignored
+   * If true, generated declaration files outside `outDir` will be ignored.
    *
    * @default true
    */
   strictOutput?: boolean,
 
   /**
-   * Override compilerOptions
+   * Override compilerOptions.
    *
    * @default null
    */
   compilerOptions?: ts.CompilerOptions | null,
 
   /**
-   * Specify tsconfig.json path
+   * Specify tsconfig.json path.
    *
-   * Plugin resolves `include` and `exclude` globs from tsconfig.json
+   * Plugin resolves `include` and `exclude` globs from tsconfig.json.
    *
-   * If not specified, plugin will find config file from root
+   * If not specified, plugin will find config file from root.
    */
   tsconfigPath?: string,
 
   /**
-   * Specify custom resolvers
+   * Specify custom resolvers.
    *
    * @default []
    */
   resolvers?: Resolver[],
 
   /**
-   * Parsing `paths` of tsconfig.json to aliases
+   * Parsing `paths` of tsconfig.json to aliases.
    *
-   * Note that these aliases only use for declaration files
+   * Note that these aliases only use for declaration files.
    *
    * @default true
-   * @remarks Only use first replacement of each path
+   * @remarks Only use first replacement of each path.
    */
   pathsToAliases?: boolean,
 
   /**
-   * Set which paths should be excluded when transforming aliases
+   * Set which paths should be excluded when transforming aliases.
    *
    * @default []
    */
   aliasesExclude?: (string | RegExp)[],
 
   /**
-   * Whether to transform file names ending in '.vue.d.ts' to '.d.ts'
+   * Whether to transform file names ending in '.vue.d.ts' to '.d.ts'.
+   *
+   * If there is a duplicate name after transform, it will fall back to the original name.
    *
    * @default false
    */
   cleanVueFileName?: boolean,
 
   /**
-   * Whether to transform dynamic imports to static (eg `import('vue').DefineComponent` to `import { DefineComponent } from 'vue'`)
+   * Whether to transform dynamic imports to static (eg `import('vue').DefineComponent` to `import { DefineComponent } from 'vue'`).
    *
-   * Value is forced to `true` when `rollupTypes` is `true`
+   * Value is forced to `true` when `rollupTypes` is `true`.
    *
    * @default false
    */
   staticImport?: boolean,
 
   /**
-   * Override `include` glob (relative to root)
+   * Override `include` glob (relative to root).
    *
-   * Defaults to `include` property of tsconfig.json (relative to tsconfig.json located)
+   * Defaults to `include` property of tsconfig.json (relative to tsconfig.json located).
    */
   include?: string | string[],
 
   /**
-   * Override `exclude` glob
+   * Override `exclude` glob.
    *
    * Defaults to `exclude` property of tsconfig.json or `'node_modules/**'` if not supplied.
    */
   exclude?: string | string[],
 
   /**
-   * Whether to remove `import 'xxx'`
+   * Whether to remove `import 'xxx'`.
    *
    * @default true
    */
   clearPureImport?: boolean,
 
   /**
-   * Whether to generate types entry file(s)
+   * Whether to generate types entry file(s).
    *
-   * When `true`, uses package.json `types` property if it exists or `${outDir}/index.d.ts`
+   * When `true`, uses package.json `types` property if it exists or `${outDir}/index.d.ts`.
    *
-   * Value is forced to `true` when `rollupTypes` is `true`
+   * Value is forced to `true` when `rollupTypes` is `true`.
    *
    * @default false
    */
   insertTypesEntry?: boolean,
 
   /**
-   * Rollup type declaration files after emitting them
+   * Rollup type declaration files after emitting them.
    *
-   * Powered by `@microsoft/api-extractor` - time-intensive operation
+   * Powered by `@microsoft/api-extractor` - time-intensive operation.
    *
    * @default false
    */
   rollupTypes?: boolean,
 
   /**
-   * Bundled packages for `@microsoft/api-extractor`
+   * Bundled packages for `@microsoft/api-extractor`.
    *
    * @default []
    * @see https://api-extractor.com/pages/configs/api-extractor_json/#bundledpackages
@@ -294,7 +303,7 @@ export interface PluginOptions {
   bundledPackages?: string[],
 
   /**
-   * Override the config of `@microsoft/api-extractor`
+   * Override the config of `@microsoft/api-extractor`.
    *
    * @default null
    * @see https://api-extractor.com/pages/setup/configure_api_report/
@@ -302,7 +311,7 @@ export interface PluginOptions {
   rollupConfig?: RollupConfig,
 
   /**
-   * Override the invoke options of `@microsoft/api-extractor`
+   * Override the invoke options of `@microsoft/api-extractor`.
    *
    * @default null
    * @see https://api-extractor.com/pages/setup/invoking/#invoking-from-a-build-script
@@ -310,44 +319,44 @@ export interface PluginOptions {
   rollupOptions?: IExtractorInvokeOptions,
 
   /**
-   * Whether to copy .d.ts source files to `outDir`
+   * Whether to copy .d.ts source files to `outDir`.
    *
    * @default false
-   * @remarks Before 2.0, the default was `true`
+   * @remarks Before 2.0, the default was `true`.
    */
   copyDtsFiles?: boolean,
 
   /**
-   * Whether to emit declaration files only
+   * Whether to emit declaration files only.
    *
-   * When `true`, all the original outputs of vite (rollup) will be force removed
+   * When `true`, all the original outputs of vite (rollup) will be force removed.
    *
    * @default false
    */
   declarationOnly?: boolean,
 
   /**
-   * Logging level for this plugin
+   * Logging level for this plugin.
    *
-   * Defaults to the 'logLevel' property of your Vite config
+   * Defaults to the 'logLevel' property of your Vite config.
    */
   logLevel?: LogLevel,
 
   /**
-   * Hook called after diagnostic is emitted
+   * Hook called after diagnostic is emitted.
    *
-   * According to the `diagnostics.length`, you can judge whether there is any type error
+   * According to the `diagnostics.length`, you can judge whether there is any type error.
    *
    * @default () => {}
    */
   afterDiagnostic?: (diagnostics: readonly ts.Diagnostic[]) => MaybePromise<void>,
 
   /**
-   * Hook called prior to writing each declaration file
+   * Hook called prior to writing each declaration file.
    *
-   * This allows you to transform the path or content
+   * This allows you to transform the path or content.
    *
-   * The file will be skipped when the return value `false` or `Promise<false>`
+   * The file will be skipped when the return value `false` or `Promise<false>`.
    *
    * @default () => {}
    */
@@ -364,20 +373,20 @@ export interface PluginOptions {
   >,
 
   /**
-   * Hook called after rolling up declaration files
+   * Hook called after rolling up declaration files.
    *
    * @default () => {}
    */
   afterRollup?: (result: ExtractorResult) => MaybePromise<void>,
 
   /**
-   * Hook called after all declaration files are written
+   * Hook called after all declaration files are written.
    *
-   * It will be received a map (path -> content) that records those emitted files
+   * It will be received a map (path -> content) that records those emitted files.
    *
    * @default () => {}
    */
-  afterBuild?: () => MaybePromise<void>
+  afterBuild?: (emittedFiles: Map<string, string>) => MaybePromise<void>
 }
 ```
 

package/README.zh-CN.md

@@ -53,6 +53,14 @@ export default defineConfig({
 }
 ```
 
+如果你从 Vite 官方模板开始，你应该指定 `tsconfigPath`：
+
+```ts
+{
+  plugins: [dts({ tsconfigPath: './tsconfig.app.json' })]
+}
+```
+
 从 `3.0.0` 开始，你可以在 Rollup 中使用该插件。
 
 ## 常见问题
@@ -149,7 +157,6 @@ export interface Resolver {
     outDir: string,
     host: ts.CompilerHost,
     program: ts.Program,
-    service: ts.LanguageService
   }) => MaybePromise<{ path: string, content: string }[]>
 }
 
@@ -231,6 +238,8 @@ export interface PluginOptions {
   /**
    * 是否将 '.vue.d.ts' 文件名转换为 '.d.ts'
    *
+   * 如果转换后出现重名，将会回退到原来的名字。
+   *
    * @default false
    */
   cleanVueFileName?: boolean,

package/dist/index.cjs

@@ -10,73 +10,20 @@ const languageCore = require('@vue/language-core');
 const typescript = require('@volar/typescript');
 const ts = require('typescript');
 const vueTsc = require('vue-tsc');
+const localPkg = require('local-pkg');
 const pluginutils = require('@rollup/pluginutils');
 const debug = require('debug');
 const kolorist = require('kolorist');
 const apiExtractor = require('@microsoft/api-extractor');
-const node_module = require('node:module');
-const localPkg = require('local-pkg');
 const compareVersions = require('compare-versions');
 const MagicString = require('magic-string');
 
-var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
 
 const ts__default = /*#__PURE__*/_interopDefaultCompat(ts);
 const debug__default = /*#__PURE__*/_interopDefaultCompat(debug);
 const MagicString__default = /*#__PURE__*/_interopDefaultCompat(MagicString);
 
-const _createProgram = typescript.proxyCreateProgram(ts__default, ts__default.createProgram, (ts2, options) => {
-  const { configFilePath } = options.options;
-  const vueOptions = typeof configFilePath === "string" ? languageCore.createParsedCommandLine(ts2, ts2.sys, configFilePath.replace(/\\/g, "/")).vueOptions : languageCore.resolveVueCompilerOptions({});
-  if (options.host) {
-    const writeFile = options.host.writeFile.bind(options.host);
-    options.host.writeFile = (fileName, contents, ...args) => {
-      return writeFile(fileName, vueTsc.removeEmitGlobalTypes(contents), ...args);
-    };
-  }
-  const vueLanguagePlugin = languageCore.createVueLanguagePlugin2(
-    ts2,
-    (id) => id,
-    languageCore.createRootFileChecker(
-      void 0,
-      () => options.rootNames.map((rootName) => rootName.replace(/\\/g, "/")),
-      options.host?.useCaseSensitiveFileNames?.() ?? false
-    ),
-    options.options,
-    vueOptions
-  );
-  return [vueLanguagePlugin];
-});
-const createProgram = (options) => {
-  const program = _createProgram(options);
-  const emit = program.emit;
-  program.emit = (targetSourceFile, writeFile, cancellationToken, emitOnlyDtsFiles, customTransformers) => {
-    if (writeFile) {
-      return emit(
-        targetSourceFile,
-        (fileName, data, writeByteOrderMark, onError, sourceFiles) => {
-          if (fileName.endsWith(".d.ts")) {
-            data = vueTsc.removeEmitGlobalTypes(data);
-          }
-          return writeFile(fileName, data, writeByteOrderMark, onError, sourceFiles);
-        },
-        cancellationToken,
-        emitOnlyDtsFiles,
-        customTransformers
-      );
-    }
-    return emit(
-      targetSourceFile,
-      writeFile,
-      cancellationToken,
-      emitOnlyDtsFiles,
-      customTransformers
-    );
-  };
-  return program;
-};
-
 const windowsSlashRE = /\\+/g;
 function slash(p) {
   return p.replace(windowsSlashRE, "/");
@@ -200,25 +147,9 @@ function getTsConfig(tsConfigPath, readFileSync) {
   Object.assign(tsConfig.compilerOptions, baseConfig.compilerOptions);
   return tsConfig;
 }
-function getTsLibFolder({ root, entryRoot }) {
-  let libFolder;
-  try {
-    libFolder = normalizePath(node_module.createRequire((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href))).resolve("typescript")).replace(
-      /node_modules\/typescript.*/,
-      "node_modules/typescript"
-    );
-  } catch {
-    libFolder = resolve(root, "node_modules/typescript");
-    if (!node_fs.existsSync(libFolder)) {
-      if (root !== entryRoot) {
-        libFolder = resolve(entryRoot, "node_modules/typescript");
-        if (!node_fs.existsSync(libFolder))
-          libFolder = void 0;
-      }
-      libFolder = void 0;
-    }
-  }
-  return libFolder;
+function getTsLibFolder() {
+  const libFolder = tryGetPackageInfo("typescript")?.rootPath;
+  return libFolder && normalizePath(libFolder);
 }
 const BASE64_ALPHABET = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/".split("");
 function base64Encode(number) {
@@ -328,7 +259,7 @@ function parseTsAliases(basePath, paths) {
   const result = [];
   for (const [pathWithAsterisk, replacements] of Object.entries(paths)) {
     const find = new RegExp(
-      `^${pathWithAsterisk.replace(regexpSymbolRE, "\\$1").replace(asteriskRE, "([^\\/]+)")}$`
+      `^${pathWithAsterisk.replace(regexpSymbolRE, "\\$1").replace(asteriskRE, "(.+)")}$`
     );
     let index = 1;
     result.push({
@@ -341,6 +272,64 @@ function parseTsAliases(basePath, paths) {
   }
   return result;
 }
+function tryGetPackageInfo(name) {
+  try {
+    return localPkg.getPackageInfoSync(name) ?? localPkg.getPackageInfoSync(name, { paths: [localPkg.resolveModule(name) || process.cwd()] });
+  } catch (e) {
+  }
+}
+
+const hasVue = !!tryGetPackageInfo("vue");
+const _createProgram = !hasVue ? ts__default.createProgram : typescript.proxyCreateProgram(ts__default, ts__default.createProgram, (ts2, options) => {
+  const { configFilePath } = options.options;
+  const vueOptions = typeof configFilePath === "string" ? languageCore.createParsedCommandLine(ts2, ts2.sys, configFilePath.replace(/\\/g, "/")).vueOptions : languageCore.resolveVueCompilerOptions({});
+  if (options.host) {
+    const writeFile = options.host.writeFile.bind(options.host);
+    options.host.writeFile = (fileName, contents, ...args) => {
+      return writeFile(fileName, vueTsc.removeEmitGlobalTypes(contents), ...args);
+    };
+  }
+  const vueLanguagePlugin = languageCore.createVueLanguagePlugin2(
+    ts2,
+    (id) => id,
+    languageCore.createRootFileChecker(
+      void 0,
+      () => options.rootNames.map((rootName) => rootName.replace(/\\/g, "/")),
+      options.host?.useCaseSensitiveFileNames?.() ?? false
+    ),
+    options.options,
+    vueOptions
+  );
+  return [vueLanguagePlugin];
+});
+const createProgram = !hasVue ? ts__default.createProgram : (options) => {
+  const program = _createProgram(options);
+  const emit = program.emit;
+  program.emit = (targetSourceFile, writeFile, cancellationToken, emitOnlyDtsFiles, customTransformers) => {
+    if (writeFile) {
+      return emit(
+        targetSourceFile,
+        (fileName, data, writeByteOrderMark, onError, sourceFiles) => {
+          if (fileName.endsWith(".d.ts")) {
+            data = vueTsc.removeEmitGlobalTypes(data);
+          }
+          return writeFile(fileName, data, writeByteOrderMark, onError, sourceFiles);
+        },
+        cancellationToken,
+        emitOnlyDtsFiles,
+        customTransformers
+      );
+    }
+    return emit(
+      targetSourceFile,
+      writeFile,
+      cancellationToken,
+      emitOnlyDtsFiles,
+      customTransformers
+    );
+  };
+  return program;
+};
 
 const dtsRE$1 = /\.d\.(m|c)?tsx?$/;
 function rollupDeclarationFiles({
@@ -354,7 +343,7 @@ function rollupDeclarationFiles({
   rollupConfig = {},
   rollupOptions = {}
 }) {
-  const configObjectFullPath = node_path.resolve(root, "api-extractor.json");
+  const configObjectFullPath = resolve(root, "api-extractor.json");
   if (!dtsRE$1.test(fileName)) {
     fileName += ".d.ts";
   }
@@ -384,7 +373,7 @@ function rollupDeclarationFiles({
       },
       dtsRollup: {
         enabled: true,
-        publicTrimmedFilePath: node_path.resolve(outDir, fileName)
+        publicTrimmedFilePath: resolve(outDir, fileName)
       },
       tsdocMetadata: {
         enabled: false,
@@ -411,7 +400,7 @@ function rollupDeclarationFiles({
     localBuild: false,
     showVerboseMessages: false,
     showDiagnostics: false,
-    typescriptCompilerFolder: libFolder ? node_path.resolve(libFolder) : void 0,
+    typescriptCompilerFolder: libFolder,
     ...rollupOptions
   });
 }
@@ -446,9 +435,9 @@ function querySvelteVersion() {
   if (typeof lowerVersion === "boolean")
     return;
   try {
-    const version = localPkg.getPackageInfoSync("svelte")?.version ?? localPkg.getPackageInfoSync("svelte", { paths: [localPkg.resolveModule("svelte") || process.cwd()] })?.version;
+    const version = tryGetPackageInfo("svelte")?.version;
     lowerVersion = version ? compareVersions.compare(version, "4.0.0", "<") : false;
-  } catch {
+  } catch (e) {
     lowerVersion = false;
   }
 }
@@ -796,8 +785,9 @@ function dtsPlugin(options = {}) {
   };
   const rollupConfig = { ...options.rollupConfig || {} };
   rollupConfig.bundledPackages = rollupConfig.bundledPackages || options.bundledPackages || [];
-  const cleanPath = (path) => {
-    return cleanVueFileName ? path.replace(".vue.d.ts", ".d.ts") : path;
+  const cleanPath = (path, emittedFiles) => {
+    const newPath = path.replace(".vue.d.ts", ".d.ts");
+    return !emittedFiles.has(newPath) && cleanVueFileName ? newPath : path;
   };
   return {
     name: pluginName,
@@ -1167,7 +1157,10 @@ ${logPrefix} Start generate declaration files...`));
         const entryNames = Object.keys(entries);
         const types = findTypesPath(pkg.publishConfig, pkg);
         const multiple = entryNames.length > 1;
-        let typesPath = cleanPath(types ? resolve(root, types) : resolve(outDir, indexName));
+        let typesPath = cleanPath(
+          types ? resolve(root, types) : resolve(outDir, indexName),
+          emittedFiles
+        );
         if (!multiple && !dtsRE.test(typesPath)) {
           logger.warn(
             `
@@ -1179,11 +1172,11 @@ ${logPrefix} ${kolorist.yellow(
           typesPath = `${typesPath.replace(tjsRE, "")}.d.${extPrefix(typesPath)}ts`;
         }
         for (const name of entryNames) {
-          const entryDtsPath = multiple ? cleanPath(resolve(outDir, tsToDts(name))) : typesPath;
+          const entryDtsPath = multiple ? cleanPath(resolve(outDir, tsToDts(name)), emittedFiles) : typesPath;
           if (node_fs.existsSync(entryDtsPath))
             continue;
           const sourceEntry = normalizePath(
-            cleanPath(resolve(outDir, node_path.relative(entryRoot, tsToDts(entries[name]))))
+            cleanPath(resolve(outDir, node_path.relative(entryRoot, tsToDts(entries[name]))), emittedFiles)
           );
           let fromPath = normalizePath(node_path.relative(node_path.dirname(entryDtsPath), sourceEntry));
           fromPath = fromPath.replace(dtsRE, "");
@@ -1200,7 +1193,7 @@ export default ${libName}
 ${content}`;
             }
           }
-          await writeOutput(cleanPath(entryDtsPath), content, outDir);
+          await writeOutput(cleanPath(entryDtsPath, emittedFiles), content, outDir);
         }
         bundleDebug("insert index");
         if (rollupTypes) {
@@ -1215,7 +1208,7 @@ ${content}`;
               outDir,
               entryPath: path,
               fileName: node_path.basename(path),
-              libFolder: getTsLibFolder({ root, entryRoot }),
+              libFolder: getTsLibFolder(),
               rollupConfig,
               rollupOptions
             });
@@ -1227,7 +1220,7 @@ ${content}`;
           };
           if (multiple) {
             await runParallel(node_os.cpus().length, entryNames, async (name) => {
-              await rollup(cleanPath(resolve(outDir, tsToDts(name))));
+              await rollup(cleanPath(resolve(outDir, tsToDts(name)), emittedFiles));
             });
           } else {
             await rollup(typesPath);