vite-plugin-dts 3.1.1 → 3.2.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
    *

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,
+
   /**
    * 设置在转换别名时哪些路径需要排除
    *

package/dist/index.cjs

@@ -114,6 +114,30 @@ function rollupDeclarationFiles({
   );
 }
 
+const jsonRE = /\.json$/;
+function JsonResolver() {
+  return {
+    name: "json",
+    supports(id) {
+      return jsonRE.test(id);
+    },
+    transform({ id, root, program }) {
+      const sourceFile = program.getSourceFile(id);
+      if (!sourceFile)
+        return [];
+      return [
+        {
+          path: node_path.relative(root, `${id}.d.ts`),
+          content: `declare const _default: ${sourceFile.text};
+
+export default _default;
+`
+        }
+      ];
+    }
+  };
+}
+
 const svelteRE = /\.svelte$/;
 function SvelteResolver() {
   return {
@@ -121,17 +145,46 @@ function SvelteResolver() {
     supports(id) {
       return svelteRE.test(id);
     },
-    transform({ id }) {
+    transform({ id, root }) {
       return [
         {
-          path: `${id}.d.ts`,
-          content: "export { SvelteComponentTyped as default } from 'svelte';"
+          path: node_path.relative(root, `${id}.d.ts`),
+          content: "export { SvelteComponentTyped as default } from 'svelte';\n"
         }
       ];
     }
   };
 }
 
+const vueRE = /\.vue$/;
+function VueResolver() {
+  return {
+    name: "vue",
+    supports(id) {
+      return vueRE.test(id);
+    },
+    transform({ id, program, service }) {
+      const sourceFile = program.getSourceFile(id) || program.getSourceFile(id + ".ts") || program.getSourceFile(id + ".js") || program.getSourceFile(id + ".tsx") || program.getSourceFile(id + ".jsx");
+      if (!sourceFile)
+        return [];
+      return service.getEmitOutput(sourceFile.fileName, true).outputFiles.map((file) => {
+        return {
+          path: file.name,
+          content: file.text
+        };
+      });
+    }
+  };
+}
+
+function parseResolvers(resolvers) {
+  const nameMap = /* @__PURE__ */ new Map();
+  for (const resolver of resolvers) {
+    resolver.name && nameMap.set(resolver.name, resolver);
+  }
+  return Array.from(nameMap.values());
+}
+
 const windowsSlashRE = /\\+/g;
 function slash(p) {
   return p.replace(windowsSlashRE, "/");
@@ -232,38 +285,6 @@ function removeDirIfEmpty(dir) {
   return onlyHasDir;
 }
 
-const vueRE = /\.vue$/;
-function VueResolver() {
-  return {
-    name: "vue",
-    supports(id) {
-      return vueRE.test(id);
-    },
-    transform({ id, root, program, service }) {
-      let sourceFile = program.getSourceFile(id);
-      if (!sourceFile && vueRE.test(id)) {
-        sourceFile = program.getSourceFile(id + ".ts") || program.getSourceFile(id + ".js") || program.getSourceFile(id + ".tsx") || program.getSourceFile(id + ".jsx");
-      }
-      if (!sourceFile)
-        return [];
-      return service.getEmitOutput(sourceFile.fileName, true).outputFiles.map((file) => {
-        return {
-          path: resolve(root, file.name),
-          content: file.text
-        };
-      });
-    }
-  };
-}
-
-function parseResolvers(resolvers) {
-  const nameMap = /* @__PURE__ */ new Map();
-  for (const resolver of resolvers) {
-    resolver.name && nameMap.set(resolver.name, resolver);
-  }
-  return Array.from(nameMap.values());
-}
-
 const globSuffixRE = /^((?:.*\.[^.]+)|(?:\*+))$/;
 function normalizeGlob(path) {
   if (/[\\/]$/.test(path)) {
@@ -396,6 +417,7 @@ function dtsPlugin(options = {}) {
     insertTypesEntry = false,
     rollupTypes = false,
     bundledPackages = [],
+    pathsToAliases = true,
     aliasesExclude = [],
     copyDtsFiles = false,
     strictOutput = true,
@@ -422,7 +444,12 @@ function dtsPlugin(options = {}) {
   let filter;
   let bundled = false;
   let timeRecord = 0;
-  const resolvers = parseResolvers([VueResolver(), SvelteResolver(), ...options.resolvers || []]);
+  const resolvers = parseResolvers([
+    JsonResolver(),
+    VueResolver(),
+    SvelteResolver(),
+    ...options.resolvers || []
+  ]);
   const rootFiles = /* @__PURE__ */ new Set();
   const outputFiles = /* @__PURE__ */ new Map();
   return {
@@ -441,7 +468,7 @@ function dtsPlugin(options = {}) {
       if (aliasesExclude.length > 0) {
         aliases = aliases.filter(
           ({ find }) => !aliasesExclude.some(
-            (alias) => alias && (isRegExp(find) ? find.toString() === alias.toString() : isRegExp(alias) ? find.match(alias)?.[0] : find === alias)
+            (aliasExclude) => aliasExclude && (isRegExp(find) ? find.toString() === aliasExclude.toString() : isRegExp(aliasExclude) ? find.match(aliasExclude)?.[0] : find === aliasExclude)
           )
         );
       }
@@ -520,12 +547,28 @@ ${kolorist.cyan(
       if (!outDirs) {
         outDirs = options.outDir ? ensureArray(options.outDir).map((d) => ensureAbsolute(d, root)) : [ensureAbsolute(content?.raw.compilerOptions?.outDir || "dist", root)];
       }
+      const { baseUrl, paths } = compilerOptions;
+      if (pathsToAliases && baseUrl && paths) {
+        const basePath = ensureAbsolute(baseUrl, configPath ? node_path.dirname(configPath) : root);
+        const existsFinds = new Set(
+          aliases.map((alias) => alias.find).filter((find) => typeof find === "string")
+        );
+        for (const [findWithAsterisk, replacements] of Object.entries(paths)) {
+          const find = findWithAsterisk.replace("/*", "");
+          if (!replacements.length || existsFinds.has(find))
+            continue;
+          aliases.push({
+            find,
+            replacement: ensureAbsolute(replacements[0].replace("/*", ""), basePath)
+          });
+        }
+      }
       include = ensureArray(options.include ?? content?.raw.include ?? "**/*").map(normalizeGlob);
       exclude = ensureArray(options.exclude ?? content?.raw.exclude ?? "node_modules/**").map(
         normalizeGlob
       );
       filter = pluginutils.createFilter(include, exclude, { resolve: root });
-      const rootNames = Object.values(entries).concat(content?.fileNames.filter(filter) || []).map(normalizePath);
+      const rootNames = Object.values(entries).map((entry) => ensureAbsolute(entry, root)).concat(content?.fileNames.filter(filter) || []).map(normalizePath);
       host = ts__default.createCompilerHost(compilerOptions, true);
       program = vueTsc.createProgram({ host, rootNames, options: compilerOptions });
       libName = libName || "_default";
@@ -561,6 +604,7 @@ ${kolorist.cyan(
         return;
       }
       const startTime = Date.now();
+      const outDir = outDirs[0];
       const service = program.__vue.languageService;
       rootFiles.delete(id);
       if (resolver) {
@@ -568,18 +612,25 @@ ${kolorist.cyan(
           id,
           code,
           root: publicRoot,
+          outDir,
           host,
           program,
           service
         });
         for (const { path, content } of result) {
-          outputFiles.set(ensureAbsolute(path, publicRoot), content);
+          outputFiles.set(
+            resolve(publicRoot, node_path.relative(outDir, ensureAbsolute(path, outDir))),
+            content
+          );
         }
       } else {
         const sourceFile = program.getSourceFile(id);
         if (sourceFile) {
           for (const outputFile of service.getEmitOutput(sourceFile.fileName, true).outputFiles) {
-            outputFiles.set(resolve(publicRoot, outputFile.name), outputFile.text);
+            outputFiles.set(
+              resolve(publicRoot, node_path.relative(outDir, ensureAbsolute(outputFile.name, outDir))),
+              outputFile.text
+            );
           }
         }
       }
@@ -634,7 +685,10 @@ ${logPrefix} Start generate declaration files...`));
         }
         if (rootFiles.has(sourceFile.fileName)) {
           for (const outputFile of service.getEmitOutput(sourceFile.fileName, true).outputFiles) {
-            outputFiles.set(resolve(publicRoot, outputFile.name), outputFile.text);
+            outputFiles.set(
+              resolve(publicRoot, node_path.relative(outDir, ensureAbsolute(outputFile.name, outDir))),
+              outputFile.text
+            );
           }
           rootFiles.delete(sourceFile.fileName);
         }

package/dist/index.d.ts

@@ -16,11 +16,14 @@ 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;
@@ -80,6 +83,15 @@ interface PluginOptions {
      * @default []
      */
     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
      *

package/dist/index.mjs

@@ -5,7 +5,7 @@ import __cjs_mod__ from 'module';
 const __filename = __cjs_url__.fileURLToPath(import.meta.url);
 const __dirname = __cjs_path__.dirname(__filename);
 const require = __cjs_mod__.createRequire(import.meta.url);
-import { resolve as resolve$1, posix, isAbsolute, dirname, normalize, sep, relative, basename } from 'node:path';
+import { resolve as resolve$1, relative, posix, isAbsolute, dirname, normalize, sep, basename } from 'node:path';
 import { existsSync, readdirSync, lstatSync, rmdirSync } from 'node:fs';
 import { readFile, mkdir, writeFile, unlink } from 'node:fs/promises';
 import { cpus } from 'node:os';
@@ -114,6 +114,30 @@ function rollupDeclarationFiles({
   );
 }
 
+const jsonRE = /\.json$/;
+function JsonResolver() {
+  return {
+    name: "json",
+    supports(id) {
+      return jsonRE.test(id);
+    },
+    transform({ id, root, program }) {
+      const sourceFile = program.getSourceFile(id);
+      if (!sourceFile)
+        return [];
+      return [
+        {
+          path: relative(root, `${id}.d.ts`),
+          content: `declare const _default: ${sourceFile.text};
+
+export default _default;
+`
+        }
+      ];
+    }
+  };
+}
+
 const svelteRE = /\.svelte$/;
 function SvelteResolver() {
   return {
@@ -121,17 +145,46 @@ function SvelteResolver() {
     supports(id) {
       return svelteRE.test(id);
     },
-    transform({ id }) {
+    transform({ id, root }) {
       return [
         {
-          path: `${id}.d.ts`,
-          content: "export { SvelteComponentTyped as default } from 'svelte';"
+          path: relative(root, `${id}.d.ts`),
+          content: "export { SvelteComponentTyped as default } from 'svelte';\n"
         }
       ];
     }
   };
 }
 
+const vueRE = /\.vue$/;
+function VueResolver() {
+  return {
+    name: "vue",
+    supports(id) {
+      return vueRE.test(id);
+    },
+    transform({ id, program, service }) {
+      const sourceFile = program.getSourceFile(id) || program.getSourceFile(id + ".ts") || program.getSourceFile(id + ".js") || program.getSourceFile(id + ".tsx") || program.getSourceFile(id + ".jsx");
+      if (!sourceFile)
+        return [];
+      return service.getEmitOutput(sourceFile.fileName, true).outputFiles.map((file) => {
+        return {
+          path: file.name,
+          content: file.text
+        };
+      });
+    }
+  };
+}
+
+function parseResolvers(resolvers) {
+  const nameMap = /* @__PURE__ */ new Map();
+  for (const resolver of resolvers) {
+    resolver.name && nameMap.set(resolver.name, resolver);
+  }
+  return Array.from(nameMap.values());
+}
+
 const windowsSlashRE = /\\+/g;
 function slash(p) {
   return p.replace(windowsSlashRE, "/");
@@ -232,38 +285,6 @@ function removeDirIfEmpty(dir) {
   return onlyHasDir;
 }
 
-const vueRE = /\.vue$/;
-function VueResolver() {
-  return {
-    name: "vue",
-    supports(id) {
-      return vueRE.test(id);
-    },
-    transform({ id, root, program, service }) {
-      let sourceFile = program.getSourceFile(id);
-      if (!sourceFile && vueRE.test(id)) {
-        sourceFile = program.getSourceFile(id + ".ts") || program.getSourceFile(id + ".js") || program.getSourceFile(id + ".tsx") || program.getSourceFile(id + ".jsx");
-      }
-      if (!sourceFile)
-        return [];
-      return service.getEmitOutput(sourceFile.fileName, true).outputFiles.map((file) => {
-        return {
-          path: resolve(root, file.name),
-          content: file.text
-        };
-      });
-    }
-  };
-}
-
-function parseResolvers(resolvers) {
-  const nameMap = /* @__PURE__ */ new Map();
-  for (const resolver of resolvers) {
-    resolver.name && nameMap.set(resolver.name, resolver);
-  }
-  return Array.from(nameMap.values());
-}
-
 const globSuffixRE = /^((?:.*\.[^.]+)|(?:\*+))$/;
 function normalizeGlob(path) {
   if (/[\\/]$/.test(path)) {
@@ -396,6 +417,7 @@ function dtsPlugin(options = {}) {
     insertTypesEntry = false,
     rollupTypes = false,
     bundledPackages = [],
+    pathsToAliases = true,
     aliasesExclude = [],
     copyDtsFiles = false,
     strictOutput = true,
@@ -422,7 +444,12 @@ function dtsPlugin(options = {}) {
   let filter;
   let bundled = false;
   let timeRecord = 0;
-  const resolvers = parseResolvers([VueResolver(), SvelteResolver(), ...options.resolvers || []]);
+  const resolvers = parseResolvers([
+    JsonResolver(),
+    VueResolver(),
+    SvelteResolver(),
+    ...options.resolvers || []
+  ]);
   const rootFiles = /* @__PURE__ */ new Set();
   const outputFiles = /* @__PURE__ */ new Map();
   return {
@@ -441,7 +468,7 @@ function dtsPlugin(options = {}) {
       if (aliasesExclude.length > 0) {
         aliases = aliases.filter(
           ({ find }) => !aliasesExclude.some(
-            (alias) => alias && (isRegExp(find) ? find.toString() === alias.toString() : isRegExp(alias) ? find.match(alias)?.[0] : find === alias)
+            (aliasExclude) => aliasExclude && (isRegExp(find) ? find.toString() === aliasExclude.toString() : isRegExp(aliasExclude) ? find.match(aliasExclude)?.[0] : find === aliasExclude)
           )
         );
       }
@@ -520,12 +547,28 @@ ${cyan(
       if (!outDirs) {
         outDirs = options.outDir ? ensureArray(options.outDir).map((d) => ensureAbsolute(d, root)) : [ensureAbsolute(content?.raw.compilerOptions?.outDir || "dist", root)];
       }
+      const { baseUrl, paths } = compilerOptions;
+      if (pathsToAliases && baseUrl && paths) {
+        const basePath = ensureAbsolute(baseUrl, configPath ? dirname(configPath) : root);
+        const existsFinds = new Set(
+          aliases.map((alias) => alias.find).filter((find) => typeof find === "string")
+        );
+        for (const [findWithAsterisk, replacements] of Object.entries(paths)) {
+          const find = findWithAsterisk.replace("/*", "");
+          if (!replacements.length || existsFinds.has(find))
+            continue;
+          aliases.push({
+            find,
+            replacement: ensureAbsolute(replacements[0].replace("/*", ""), basePath)
+          });
+        }
+      }
       include = ensureArray(options.include ?? content?.raw.include ?? "**/*").map(normalizeGlob);
       exclude = ensureArray(options.exclude ?? content?.raw.exclude ?? "node_modules/**").map(
         normalizeGlob
       );
       filter = createFilter(include, exclude, { resolve: root });
-      const rootNames = Object.values(entries).concat(content?.fileNames.filter(filter) || []).map(normalizePath);
+      const rootNames = Object.values(entries).map((entry) => ensureAbsolute(entry, root)).concat(content?.fileNames.filter(filter) || []).map(normalizePath);
       host = ts.createCompilerHost(compilerOptions, true);
       program = createProgram({ host, rootNames, options: compilerOptions });
       libName = libName || "_default";
@@ -561,6 +604,7 @@ ${cyan(
         return;
       }
       const startTime = Date.now();
+      const outDir = outDirs[0];
       const service = program.__vue.languageService;
       rootFiles.delete(id);
       if (resolver) {
@@ -568,18 +612,25 @@ ${cyan(
           id,
           code,
           root: publicRoot,
+          outDir,
           host,
           program,
           service
         });
         for (const { path, content } of result) {
-          outputFiles.set(ensureAbsolute(path, publicRoot), content);
+          outputFiles.set(
+            resolve(publicRoot, relative(outDir, ensureAbsolute(path, outDir))),
+            content
+          );
         }
       } else {
         const sourceFile = program.getSourceFile(id);
         if (sourceFile) {
           for (const outputFile of service.getEmitOutput(sourceFile.fileName, true).outputFiles) {
-            outputFiles.set(resolve(publicRoot, outputFile.name), outputFile.text);
+            outputFiles.set(
+              resolve(publicRoot, relative(outDir, ensureAbsolute(outputFile.name, outDir))),
+              outputFile.text
+            );
           }
         }
       }
@@ -634,7 +685,10 @@ ${logPrefix} Start generate declaration files...`));
         }
         if (rootFiles.has(sourceFile.fileName)) {
           for (const outputFile of service.getEmitOutput(sourceFile.fileName, true).outputFiles) {
-            outputFiles.set(resolve(publicRoot, outputFile.name), outputFile.text);
+            outputFiles.set(
+              resolve(publicRoot, relative(outDir, ensureAbsolute(outputFile.name, outDir))),
+              outputFile.text
+            );
           }
           rootFiles.delete(sourceFile.fileName);
         }

package/package.json

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