vite-plugin-dts 1.3.1 → 1.5.0

package/README.md

@@ -97,6 +97,11 @@ export interface PluginOptions {
   // Default: 'tsconfig.json'
   tsConfigFilePath?: string
 
+  // Set which paths should exclude when transform aliases
+  // If it's regexp, it will test the original import path directly
+  // Default: []
+  aliasesExclude?: (string | RegExp)[]
+
   // Whether transform file name '.vue.d.ts' to '.d.ts'
   // Default: false
   cleanVueFileName?: boolean

package/README.zh-CN.md

@@ -96,6 +96,11 @@ export interface PluginOptions {
   // 默认值: 'tsconfig.json'
   tsConfigFilePath?: string
 
+  // 设置在转换别名时哪些路径需要排除
+  // 如果为正则，会直接使用 test 和原始路径进行比较
+  // 默认值: []
+  aliasesExclude?: (string | RegExp)[]
+
   // 是否将 '.vue.d.ts' 文件名转换为 '.d.ts'
   // 默认值: false
   cleanVueFileName?: boolean

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Plugin, Alias } from 'vite';
+import { Plugin } from 'vite';
 import { ts, Diagnostic } from 'ts-morph';
 
 interface TransformWriteFile {
@@ -13,7 +13,7 @@ interface PluginOptions {
     entryRoot?: string;
     compilerOptions?: ts.CompilerOptions | null;
     tsConfigFilePath?: string;
-    aliasesExclude?: Alias['find'][];
+    aliasesExclude?: (string | RegExp)[];
     cleanVueFileName?: boolean;
     staticImport?: boolean;
     clearPureImport?: boolean;

package/dist/index.js

@@ -219,7 +219,7 @@ var staticImportRE = /(?:import|export)\s?(?:type)?\s?\{?.+\}?\s?from\s?['"](.+)
 var dynamicImportRE = /import\(['"]([^;\n]+?)['"]\)/;
 var simpleStaticImportRE = /((?:import|export).+from\s?)['"](.+)['"]/;
 var simpleDynamicImportRE = /(import\()['"](.+)['"]\)/;
-function transformAliasImport(filePath, content, aliases) {
+function transformAliasImport(filePath, content, aliases, exclude = []) {
   if (!aliases.length)
     return content;
   return content.replace(globalImportRE, (str) => {
@@ -232,6 +232,9 @@ function transformAliasImport(filePath, content, aliases) {
     if (matchResult == null ? void 0 : matchResult[1]) {
       const matchedAlias = aliases.find((alias) => isAliasMatch(alias, matchResult[1]));
       if (matchedAlias) {
+        if (exclude.some((e) => isRegExp(e) ? e.test(matchResult[1]) : String(e) === matchResult[1])) {
+          return str;
+        }
         const truthPath = (0, import_path2.isAbsolute)(matchedAlias.replacement) ? (0, import_vite.normalizePath)((0, import_path2.relative)((0, import_path2.dirname)(filePath), matchedAlias.replacement)) : (0, import_vite.normalizePath)(matchedAlias.replacement);
         return str.replace(isDynamic ? simpleDynamicImportRE : simpleStaticImportRE, `$1'${matchResult[1].replace(matchedAlias.find, (truthPath.startsWith(".") ? truthPath : `./${truthPath}`) + (typeof matchedAlias.find === "string" && matchedAlias.find.endsWith("/") ? "/" : ""))}'${isDynamic ? ")" : ""}`);
       }
@@ -256,9 +259,11 @@ function transferSetupPosition(content) {
 // src/compile.ts
 var exportDefaultRE = /export\s+default/;
 var exportDefaultClassRE = /(?:(?:^|\n|;)\s*)export\s+default\s+class\s+([\w$]+)/;
+var noScriptContent = "import { defineComponent } from 'vue'\nexport default defineComponent({})";
 var index = 1;
 var compileRoot = null;
 var compiler;
+var vue;
 function requireCompiler() {
   if (!compiler) {
     if (compileRoot) {
@@ -281,15 +286,43 @@ function requireCompiler() {
   }
   return compiler;
 }
+function isVue3() {
+  if (!vue) {
+    if (compileRoot) {
+      try {
+        vue = require(require.resolve("vue", { paths: [compileRoot] }));
+      } catch (e) {
+      }
+    }
+    if (!vue) {
+      try {
+        vue = require("vue");
+      } catch (e) {
+        throw new Error("vue is not present in the dependency tree.\n");
+      }
+    }
+  }
+  return vue.version.startsWith("3");
+}
 function setCompileRoot(root) {
   if (root && root !== compileRoot) {
     compileRoot = root;
     compiler = null;
   }
 }
+function parseCode(code) {
+  const { parse } = requireCompiler();
+  let descriptor;
+  if (isVue3()) {
+    descriptor = parse(code).descriptor;
+  } else {
+    descriptor = parse({ source: code });
+  }
+  return descriptor;
+}
 function compileVueCode(code) {
-  const { parse, compileScript, rewriteDefault } = requireCompiler();
-  const { descriptor } = parse(code);
+  const { compileScript, rewriteDefault } = requireCompiler();
+  const descriptor = parseCode(code);
   const { script, scriptSetup } = descriptor;
   let content = null;
   let ext = null;
@@ -317,6 +350,9 @@ const _sfc_main = ${classMatch[1]}`;
       content += "\nexport default _sfc_main\n";
       ext = script.lang || "js";
     }
+  } else {
+    content = noScriptContent;
+    ext = "ts";
   }
   return { content, ext };
 }
@@ -549,7 +585,7 @@ ${import_chalk.default.cyan("[vite:dts]")} Can not resolve declaration directory
       }
     },
     async closeBundle() {
-      var _a2, _b2, _c, _d, _e, _f;
+      var _a2, _b2, _c, _d, _e, _f, _g, _h, _i;
       if (!outputDirs || !project || isBundle)
         return;
       logger.info(import_chalk.default.green(`
@@ -559,15 +595,17 @@ ${logPrefix} Start generate declaration files...`));
       sourceDtsFiles.clear();
       const startTime = Date.now();
       const tsConfig = (_a2 = (0, import_typescript.readConfigFile)(tsConfigPath, project.getFileSystem().readFileSync).config) != null ? _a2 : {};
-      const include = (_c = (_b2 = options.include) != null ? _b2 : tsConfig.include) != null ? _c : "**/*";
-      const exclude = (_d = options.exclude) != null ? _d : tsConfig.exclude;
+      const parentTsConfigPath = tsConfig.extends && ensureAbsolute(tsConfig.extends, root);
+      const parentTsConfig = parentTsConfigPath ? (0, import_typescript.readConfigFile)(parentTsConfigPath, project.getFileSystem().readFileSync).config : {};
+      const include = (_d = (_c = (_b2 = options.include) != null ? _b2 : tsConfig.include) != null ? _c : parentTsConfig.include) != null ? _d : "**/*";
+      const exclude = (_g = (_f = (_e = options.exclude) != null ? _e : tsConfig.exclude) != null ? _f : parentTsConfig.exclude) != null ? _g : "node_modules/**";
       bundleDebug("read config");
       const includedFileSet = /* @__PURE__ */ new Set();
       if (include && include.length) {
         const files = await (0, import_fast_glob.default)(ensureArray(include).map(normalizeGlob), {
           cwd: root,
           absolute: true,
-          ignore: ensureArray(exclude != null ? exclude : ["node_modules/**"]).map(normalizeGlob)
+          ignore: ensureArray(exclude).map(normalizeGlob)
         });
         files.forEach((file) => {
           if (dtsRE2.test(file)) {
@@ -627,7 +665,7 @@ ${logPrefix} Start generate declaration files...`));
         }
         if (!isMapFile && content && content !== noneExport) {
           content = clearPureImport ? removePureImport(content) : content;
-          content = transformAliasImport(filePath, content, aliases);
+          content = transformAliasImport(filePath, content, aliases, aliasesExclude);
           content = staticImport || rollupTypes ? transformDynamicImport(content) : content;
         }
         filePath = (0, import_path4.resolve)(outputDir, (0, import_path4.relative)(entryRoot, cleanVueFileName ? filePath.replace(".vue.d.ts", ".d.ts") : filePath));
@@ -667,8 +705,8 @@ export default ${libName}
           if (typeof beforeWriteFile === "function") {
             const result = beforeWriteFile(typesPath, content);
             if (result && isNativeObj(result)) {
-              typesPath = (_e = result.filePath) != null ? _e : typesPath;
-              content = (_f = result.content) != null ? _f : content;
+              typesPath = (_h = result.filePath) != null ? _h : typesPath;
+              content = (_i = result.content) != null ? _i : content;
             }
           }
           await import_fs_extra.default.writeFile(typesPath, content, "utf-8");

package/dist/index.mjs

@@ -198,7 +198,7 @@ var staticImportRE = /(?:import|export)\s?(?:type)?\s?\{?.+\}?\s?from\s?['"](.+)
 var dynamicImportRE = /import\(['"]([^;\n]+?)['"]\)/;
 var simpleStaticImportRE = /((?:import|export).+from\s?)['"](.+)['"]/;
 var simpleDynamicImportRE = /(import\()['"](.+)['"]\)/;
-function transformAliasImport(filePath, content, aliases) {
+function transformAliasImport(filePath, content, aliases, exclude = []) {
   if (!aliases.length)
     return content;
   return content.replace(globalImportRE, (str) => {
@@ -211,6 +211,9 @@ function transformAliasImport(filePath, content, aliases) {
     if (matchResult == null ? void 0 : matchResult[1]) {
       const matchedAlias = aliases.find((alias) => isAliasMatch(alias, matchResult[1]));
       if (matchedAlias) {
+        if (exclude.some((e) => isRegExp(e) ? e.test(matchResult[1]) : String(e) === matchResult[1])) {
+          return str;
+        }
         const truthPath = isAbsolute2(matchedAlias.replacement) ? normalizePath(relative(dirname2(filePath), matchedAlias.replacement)) : normalizePath(matchedAlias.replacement);
         return str.replace(isDynamic ? simpleDynamicImportRE : simpleStaticImportRE, `$1'${matchResult[1].replace(matchedAlias.find, (truthPath.startsWith(".") ? truthPath : `./${truthPath}`) + (typeof matchedAlias.find === "string" && matchedAlias.find.endsWith("/") ? "/" : ""))}'${isDynamic ? ")" : ""}`);
       }
@@ -235,9 +238,11 @@ function transferSetupPosition(content) {
 // src/compile.ts
 var exportDefaultRE = /export\s+default/;
 var exportDefaultClassRE = /(?:(?:^|\n|;)\s*)export\s+default\s+class\s+([\w$]+)/;
+var noScriptContent = "import { defineComponent } from 'vue'\nexport default defineComponent({})";
 var index = 1;
 var compileRoot = null;
 var compiler;
+var vue;
 function requireCompiler() {
   if (!compiler) {
     if (compileRoot) {
@@ -260,15 +265,43 @@ function requireCompiler() {
   }
   return compiler;
 }
+function isVue3() {
+  if (!vue) {
+    if (compileRoot) {
+      try {
+        vue = __require(__require.resolve("vue", { paths: [compileRoot] }));
+      } catch (e) {
+      }
+    }
+    if (!vue) {
+      try {
+        vue = __require("vue");
+      } catch (e) {
+        throw new Error("vue is not present in the dependency tree.\n");
+      }
+    }
+  }
+  return vue.version.startsWith("3");
+}
 function setCompileRoot(root) {
   if (root && root !== compileRoot) {
     compileRoot = root;
     compiler = null;
   }
 }
+function parseCode(code) {
+  const { parse } = requireCompiler();
+  let descriptor;
+  if (isVue3()) {
+    descriptor = parse(code).descriptor;
+  } else {
+    descriptor = parse({ source: code });
+  }
+  return descriptor;
+}
 function compileVueCode(code) {
-  const { parse, compileScript, rewriteDefault } = requireCompiler();
-  const { descriptor } = parse(code);
+  const { compileScript, rewriteDefault } = requireCompiler();
+  const descriptor = parseCode(code);
   const { script, scriptSetup } = descriptor;
   let content = null;
   let ext = null;
@@ -296,6 +329,9 @@ const _sfc_main = ${classMatch[1]}`;
       content += "\nexport default _sfc_main\n";
       ext = script.lang || "js";
     }
+  } else {
+    content = noScriptContent;
+    ext = "ts";
   }
   return { content, ext };
 }
@@ -531,7 +567,7 @@ ${chalk.cyan("[vite:dts]")} Can not resolve declaration directory, please check
       }
     },
     async closeBundle() {
-      var _a2, _b2, _c, _d, _e, _f;
+      var _a2, _b2, _c, _d, _e, _f, _g, _h, _i;
       if (!outputDirs || !project || isBundle)
         return;
       logger.info(chalk.green(`
@@ -541,15 +577,17 @@ ${logPrefix} Start generate declaration files...`));
       sourceDtsFiles.clear();
       const startTime = Date.now();
       const tsConfig = (_a2 = readConfigFile(tsConfigPath, project.getFileSystem().readFileSync).config) != null ? _a2 : {};
-      const include = (_c = (_b2 = options.include) != null ? _b2 : tsConfig.include) != null ? _c : "**/*";
-      const exclude = (_d = options.exclude) != null ? _d : tsConfig.exclude;
+      const parentTsConfigPath = tsConfig.extends && ensureAbsolute(tsConfig.extends, root);
+      const parentTsConfig = parentTsConfigPath ? readConfigFile(parentTsConfigPath, project.getFileSystem().readFileSync).config : {};
+      const include = (_d = (_c = (_b2 = options.include) != null ? _b2 : tsConfig.include) != null ? _c : parentTsConfig.include) != null ? _d : "**/*";
+      const exclude = (_g = (_f = (_e = options.exclude) != null ? _e : tsConfig.exclude) != null ? _f : parentTsConfig.exclude) != null ? _g : "node_modules/**";
       bundleDebug("read config");
       const includedFileSet = /* @__PURE__ */ new Set();
       if (include && include.length) {
         const files = await glob(ensureArray(include).map(normalizeGlob), {
           cwd: root,
           absolute: true,
-          ignore: ensureArray(exclude != null ? exclude : ["node_modules/**"]).map(normalizeGlob)
+          ignore: ensureArray(exclude).map(normalizeGlob)
         });
         files.forEach((file) => {
           if (dtsRE2.test(file)) {
@@ -609,7 +647,7 @@ ${logPrefix} Start generate declaration files...`));
         }
         if (!isMapFile && content && content !== noneExport) {
           content = clearPureImport ? removePureImport(content) : content;
-          content = transformAliasImport(filePath, content, aliases);
+          content = transformAliasImport(filePath, content, aliases, aliasesExclude);
           content = staticImport || rollupTypes ? transformDynamicImport(content) : content;
         }
         filePath = resolve3(outputDir, relative2(entryRoot, cleanVueFileName ? filePath.replace(".vue.d.ts", ".d.ts") : filePath));
@@ -649,8 +687,8 @@ export default ${libName}
           if (typeof beforeWriteFile === "function") {
             const result = beforeWriteFile(typesPath, content);
             if (result && isNativeObj(result)) {
-              typesPath = (_e = result.filePath) != null ? _e : typesPath;
-              content = (_f = result.content) != null ? _f : content;
+              typesPath = (_h = result.filePath) != null ? _h : typesPath;
+              content = (_i = result.content) != null ? _i : content;
             }
           }
           await fs.writeFile(typesPath, content, "utf-8");

package/package.json

@@ -93,5 +93,5 @@
     "test:e2e": "cd example && cross-env DEBUG=\"vite-plugin-dts:bundle\" vite build"
   },
   "types": "dist/index.d.ts",
-  "version": "1.3.1"
+  "version": "1.5.0"
 }