vite-plugin-dts 4.0.0-beta.0 → 4.0.0-beta.1

package/README.md

@@ -84,6 +84,14 @@ For example: `baseUrl: 'src'` is specified and importing from `<root>/src/compon
 
 Currently, you need to avoid the above situation, or use aliases instead (with the `paths` option).
 
+### Get module not found errors during build
+
+This is likely due to incorrect configuration of the `include` property in your default `tsconfig.json`.
+
+Due to some limitations, the plugin relies on the top-level `tsconfig.json` to resolve the files to include. Therefore, you need to specify the correct `include` property in the top-level `tsconfig.json`, or you can specify a configuration file path with the correct `include` property using the `tsconfigPath` option of the plugin. For example, in the Vite initial template, it is `tsconfig.app.json`.
+
+You can refer to this [comment](https://github.com/qmhc/vite-plugin-dts/issues/343#issuecomment-2198111439).
+
 <details>
   <summary>Legacy</summary>
 

package/README.zh-CN.md

@@ -84,6 +84,14 @@ export default defineConfig({
 
 目前想要正常打包，需要规避上述情况，或使用别名代替（配合 `paths` 属性）。
 
+### 打包时出现找不到模块的错误
+
+这很有可能是因为在你的默认 `tsconfig.json` 中未有正确配置 `include` 导致的。
+
+由于一些局限性，插件依赖最上层的 `tsconfig.json` 来解析需要包含的文件，所以你需要在最上层的 `tsconfig.json` 中指定正确的 `include`，或者通过插件的 `tsconfigPath` 选项指定一个包含了正确 `include` 的配置文件路径，例如在 Vite 初始模板中它是 `tsconfig.app.json`。
+
+可以参考这个 [评论](https://github.com/qmhc/vite-plugin-dts/issues/343#issuecomment-2198111439).
+
 <details>
   <summary>过时的</summary>
 

package/dist/index.cjs

@@ -14,6 +14,8 @@ const vueTsc = require('vue-tsc');
 const debug = require('debug');
 const kolorist = require('kolorist');
 const apiExtractor = require('@microsoft/api-extractor');
+const localPkg = require('local-pkg');
+const compareVersions = require('compare-versions');
 const MagicString = require('magic-string');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
@@ -363,6 +365,17 @@ export default _default;
 }
 
 const svelteRE = /\.svelte$/;
+let lowerVersion;
+function querySvelteVersion() {
+  if (typeof lowerVersion === "boolean")
+    return;
+  try {
+    const version = localPkg.getPackageInfoSync("svelte")?.version ?? localPkg.getPackageInfoSync("svelte", { paths: [localPkg.resolveModule("svelte") || process.cwd()] })?.version;
+    lowerVersion = version ? compareVersions.compare(version, "4.0.0", "<") : false;
+  } catch {
+    lowerVersion = false;
+  }
+}
 function SvelteResolver() {
   return {
     name: "svelte",
@@ -370,10 +383,12 @@ function SvelteResolver() {
       return svelteRE.test(id);
     },
     transform({ id, root }) {
+      querySvelteVersion();
       return [
         {
           path: node_path.relative(root, `${id}.d.ts`),
-          content: "export { SvelteComponentTyped as default } from 'svelte';\n"
+          content: `export { ${lowerVersion ? "SvelteComponentTyped" : "SvelteComponent"} as default } from 'svelte';
+`
         }
       ];
     }
@@ -817,7 +832,11 @@ ${logPrefix} ${kolorist.yellow(
           (glob) => normalizeGlob(ensureAbsolute(glob, configPath ? node_path.dirname(configPath) : root))
         );
       };
-      include = computeGlobs(options.include, content?.raw.include, "**/*");
+      include = computeGlobs(
+        options.include,
+        [...ensureArray(content?.raw.include ?? []), ...ensureArray(content?.raw.files ?? [])],
+        "**/*"
+      );
       exclude = computeGlobs(options.exclude, content?.raw.exclude, "node_modules/**");
       filter = pluginutils.createFilter(include, exclude);
       const rootNames = [

package/dist/index.mjs

@@ -17,6 +17,8 @@ import { removeEmitGlobalTypes } from 'vue-tsc';
 import debug from 'debug';
 import { cyan, yellow, green } from 'kolorist';
 import { ExtractorConfig, Extractor } from '@microsoft/api-extractor';
+import { getPackageInfoSync, resolveModule } from 'local-pkg';
+import { compare } from 'compare-versions';
 import MagicString from 'magic-string';
 
 const windowsSlashRE = /\\+/g;
@@ -360,6 +362,17 @@ export default _default;
 }
 
 const svelteRE = /\.svelte$/;
+let lowerVersion;
+function querySvelteVersion() {
+  if (typeof lowerVersion === "boolean")
+    return;
+  try {
+    const version = getPackageInfoSync("svelte")?.version ?? getPackageInfoSync("svelte", { paths: [resolveModule("svelte") || process.cwd()] })?.version;
+    lowerVersion = version ? compare(version, "4.0.0", "<") : false;
+  } catch {
+    lowerVersion = false;
+  }
+}
 function SvelteResolver() {
   return {
     name: "svelte",
@@ -367,10 +380,12 @@ function SvelteResolver() {
       return svelteRE.test(id);
     },
     transform({ id, root }) {
+      querySvelteVersion();
       return [
         {
           path: relative(root, `${id}.d.ts`),
-          content: "export { SvelteComponentTyped as default } from 'svelte';\n"
+          content: `export { ${lowerVersion ? "SvelteComponentTyped" : "SvelteComponent"} as default } from 'svelte';
+`
         }
       ];
     }
@@ -814,7 +829,11 @@ ${logPrefix} ${yellow(
           (glob) => normalizeGlob(ensureAbsolute(glob, configPath ? dirname(configPath) : root))
         );
       };
-      include = computeGlobs(options.include, content?.raw.include, "**/*");
+      include = computeGlobs(
+        options.include,
+        [...ensureArray(content?.raw.include ?? []), ...ensureArray(content?.raw.files ?? [])],
+        "**/*"
+      );
       exclude = computeGlobs(options.exclude, content?.raw.exclude, "node_modules/**");
       filter = createFilter(include, exclude);
       const rootNames = [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-dts",
-  "version": "4.0.0-beta.0",
+  "version": "4.0.0-beta.1",
   "type": "module",
   "license": "MIT",
   "author": "qmhc",
@@ -62,8 +62,10 @@
     "@rollup/pluginutils": "^5.1.0",
     "@volar/typescript": "^2.3.4",
     "@vue/language-core": "2.0.19",
+    "compare-versions": "^6.1.1",
     "debug": "^4.3.5",
     "kolorist": "^1.8.0",
+    "local-pkg": "^0.5.0",
     "magic-string": "^0.30.10",
     "vue-tsc": "2.0.19"
   },