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

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

@@ -9,11 +9,13 @@ const node_os = require('node:os');
 const languageCore = require('@vue/language-core');
 const typescript = require('@volar/typescript');
 const ts = require('typescript');
-const pluginutils = require('@rollup/pluginutils');
 const vueTsc = require('vue-tsc');
+const pluginutils = require('@rollup/pluginutils');
 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; }
@@ -22,6 +24,29 @@ 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 windowsSlashRE = /\\+/g;
 function slash(p) {
   return p.replace(windowsSlashRE, "/");
@@ -363,6 +388,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 +406,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';
+`
         }
       ];
     }
@@ -550,7 +588,7 @@ function transformCode(options) {
       return false;
     }
     if (ts__default.isModuleDeclaration(node)) {
-      if (node.body && ts__default.isModuleBlock(node.body) && !node.body.statements.some(
+      if (node.modifiers?.[0] && node.modifiers[0].kind === ts__default.SyntaxKind.DeclareKeyword && node.body && ts__default.isModuleBlock(node.body) && !node.body.statements.some(
         (s2) => ts__default.isExportAssignment(s2) || ts__default.isExportDeclaration(s2) || ts__default.isImportDeclaration(s2)
       )) {
         declareModules.push(s.slice(node.pos, node.end + 1));
@@ -569,6 +607,29 @@ function transformCode(options) {
     declareModules
   };
 }
+function hasNamedExport(content) {
+  const ast = ts__default.createSourceFile("a.ts", content, ts__default.ScriptTarget.Latest);
+  let has = false;
+  walkSourceFile(ast, (node) => {
+    if (ts__default.isExportDeclaration(node) && node.exportClause && ts__default.isNamedExports(node.exportClause)) {
+      for (const element of node.exportClause.elements) {
+        if (element.name.escapedText !== "default") {
+          has = true;
+          break;
+        }
+      }
+    } else if ("modifiers" in node && Array.isArray(node.modifiers) && node.modifiers.length > 1) {
+      for (let i = 0, len = node.modifiers.length; i < len; ++i) {
+        if (node.modifiers[i].kind === ts__default.SyntaxKind.ExportKeyword && node.modifiers[i + 1]?.kind !== ts__default.SyntaxKind.DefaultKeyword) {
+          has = true;
+          break;
+        }
+      }
+    }
+    return false;
+  });
+  return has;
+}
 function hasExportDefault(content) {
   const ast = ts__default.createSourceFile("a.ts", content, ts__default.ScriptTarget.Latest);
   let has = false;
@@ -595,26 +656,6 @@ function hasExportDefault(content) {
   return has;
 }
 
-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 writeFile2 = options.host.writeFile.bind(options.host);
-    options.host.writeFile = (fileName, contents, ...args) => {
-      return writeFile2(fileName, vueTsc.removeEmitGlobalTypes(contents), ...args);
-    };
-  }
-  const vueLanguagePlugin = languageCore.createVueLanguagePlugin(
-    ts2,
-    (id) => id,
-    options.host?.useCaseSensitiveFileNames?.() ?? false,
-    () => "",
-    () => options.rootNames.map((rootName) => rootName.replace(/\\/g, "/")),
-    options.options,
-    vueOptions
-  );
-  return [vueLanguagePlugin];
-});
 const jsRE = /\.(m|c)?jsx?$/;
 const tsRE = /\.(m|c)?tsx?$/;
 const dtsRE = /\.d\.(m|c)?tsx?$/;
@@ -817,7 +858,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 = [
@@ -1055,12 +1100,17 @@ ${logPrefix} ${kolorist.yellow(
           let fromPath = normalizePath(node_path.relative(node_path.dirname(entryDtsPath), sourceEntry));
           fromPath = fromPath.replace(dtsRE, "");
           fromPath = fullRelativeRE.test(fromPath) ? fromPath : `./${fromPath}`;
-          let content = `export * from '${fromPath}'
+          let content = "";
+          if (emittedFiles.has(sourceEntry)) {
+            if (hasNamedExport(emittedFiles.get(sourceEntry))) {
+              content += `export * from '${fromPath}'
 `;
-          if (emittedFiles.has(sourceEntry) && hasExportDefault(emittedFiles.get(sourceEntry))) {
-            content += `import ${libName} from '${fromPath}'
+            }
+            if (hasExportDefault(emittedFiles.get(sourceEntry))) {
+              content += `import ${libName} from '${fromPath}'
 export default ${libName}
 `;
+            }
           }
           await writeOutput(cleanPath(entryDtsPath), content, outDir);
         }
@@ -1111,8 +1161,7 @@ export default ${libName}
             await writeOutput(
               filePath,
               await promises.readFile(filePath, "utf-8") + (declared ? `
-${declared}
-` : ""),
+${declared}` : ""),
               node_path.dirname(filePath)
             );
           });

package/dist/index.mjs

@@ -9,16 +9,41 @@ import { relative, posix, resolve as resolve$1, isAbsolute, dirname, normalize,
 import { existsSync, readdirSync, lstatSync, rmdirSync } from 'node:fs';
 import { readFile, mkdir, writeFile, unlink } from 'node:fs/promises';
 import { cpus } from 'node:os';
-import { createParsedCommandLine, resolveVueCompilerOptions, createVueLanguagePlugin } from '@vue/language-core';
+import { createParsedCommandLine, resolveVueCompilerOptions, createVueLanguagePlugin2, createRootFileChecker } from '@vue/language-core';
 import { proxyCreateProgram } from '@volar/typescript';
 import ts from 'typescript';
-import { createFilter } from '@rollup/pluginutils';
 import { removeEmitGlobalTypes } from 'vue-tsc';
+import { createFilter } from '@rollup/pluginutils';
 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 createProgram = proxyCreateProgram(ts, ts.createProgram, (ts2, options) => {
+  const { configFilePath } = options.options;
+  const vueOptions = typeof configFilePath === "string" ? createParsedCommandLine(ts2, ts2.sys, configFilePath.replace(/\\/g, "/")).vueOptions : resolveVueCompilerOptions({});
+  if (options.host) {
+    const writeFile = options.host.writeFile.bind(options.host);
+    options.host.writeFile = (fileName, contents, ...args) => {
+      return writeFile(fileName, removeEmitGlobalTypes(contents), ...args);
+    };
+  }
+  const vueLanguagePlugin = createVueLanguagePlugin2(
+    ts2,
+    (id) => id,
+    createRootFileChecker(
+      void 0,
+      () => options.rootNames.map((rootName) => rootName.replace(/\\/g, "/")),
+      options.host?.useCaseSensitiveFileNames?.() ?? false
+    ),
+    options.options,
+    vueOptions
+  );
+  return [vueLanguagePlugin];
+});
+
 const windowsSlashRE = /\\+/g;
 function slash(p) {
   return p.replace(windowsSlashRE, "/");
@@ -360,6 +385,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 +403,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';
+`
         }
       ];
     }
@@ -547,7 +585,7 @@ function transformCode(options) {
       return false;
     }
     if (ts.isModuleDeclaration(node)) {
-      if (node.body && ts.isModuleBlock(node.body) && !node.body.statements.some(
+      if (node.modifiers?.[0] && node.modifiers[0].kind === ts.SyntaxKind.DeclareKeyword && node.body && ts.isModuleBlock(node.body) && !node.body.statements.some(
         (s2) => ts.isExportAssignment(s2) || ts.isExportDeclaration(s2) || ts.isImportDeclaration(s2)
       )) {
         declareModules.push(s.slice(node.pos, node.end + 1));
@@ -566,6 +604,29 @@ function transformCode(options) {
     declareModules
   };
 }
+function hasNamedExport(content) {
+  const ast = ts.createSourceFile("a.ts", content, ts.ScriptTarget.Latest);
+  let has = false;
+  walkSourceFile(ast, (node) => {
+    if (ts.isExportDeclaration(node) && node.exportClause && ts.isNamedExports(node.exportClause)) {
+      for (const element of node.exportClause.elements) {
+        if (element.name.escapedText !== "default") {
+          has = true;
+          break;
+        }
+      }
+    } else if ("modifiers" in node && Array.isArray(node.modifiers) && node.modifiers.length > 1) {
+      for (let i = 0, len = node.modifiers.length; i < len; ++i) {
+        if (node.modifiers[i].kind === ts.SyntaxKind.ExportKeyword && node.modifiers[i + 1]?.kind !== ts.SyntaxKind.DefaultKeyword) {
+          has = true;
+          break;
+        }
+      }
+    }
+    return false;
+  });
+  return has;
+}
 function hasExportDefault(content) {
   const ast = ts.createSourceFile("a.ts", content, ts.ScriptTarget.Latest);
   let has = false;
@@ -592,26 +653,6 @@ function hasExportDefault(content) {
   return has;
 }
 
-const createProgram = proxyCreateProgram(ts, ts.createProgram, (ts2, options) => {
-  const { configFilePath } = options.options;
-  const vueOptions = typeof configFilePath === "string" ? createParsedCommandLine(ts2, ts2.sys, configFilePath.replace(/\\/g, "/")).vueOptions : resolveVueCompilerOptions({});
-  if (options.host) {
-    const writeFile2 = options.host.writeFile.bind(options.host);
-    options.host.writeFile = (fileName, contents, ...args) => {
-      return writeFile2(fileName, removeEmitGlobalTypes(contents), ...args);
-    };
-  }
-  const vueLanguagePlugin = createVueLanguagePlugin(
-    ts2,
-    (id) => id,
-    options.host?.useCaseSensitiveFileNames?.() ?? false,
-    () => "",
-    () => options.rootNames.map((rootName) => rootName.replace(/\\/g, "/")),
-    options.options,
-    vueOptions
-  );
-  return [vueLanguagePlugin];
-});
 const jsRE = /\.(m|c)?jsx?$/;
 const tsRE = /\.(m|c)?tsx?$/;
 const dtsRE = /\.d\.(m|c)?tsx?$/;
@@ -814,7 +855,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 = [
@@ -1052,12 +1097,17 @@ ${logPrefix} ${yellow(
           let fromPath = normalizePath(relative(dirname(entryDtsPath), sourceEntry));
           fromPath = fromPath.replace(dtsRE, "");
           fromPath = fullRelativeRE.test(fromPath) ? fromPath : `./${fromPath}`;
-          let content = `export * from '${fromPath}'
+          let content = "";
+          if (emittedFiles.has(sourceEntry)) {
+            if (hasNamedExport(emittedFiles.get(sourceEntry))) {
+              content += `export * from '${fromPath}'
 `;
-          if (emittedFiles.has(sourceEntry) && hasExportDefault(emittedFiles.get(sourceEntry))) {
-            content += `import ${libName} from '${fromPath}'
+            }
+            if (hasExportDefault(emittedFiles.get(sourceEntry))) {
+              content += `import ${libName} from '${fromPath}'
 export default ${libName}
 `;
+            }
           }
           await writeOutput(cleanPath(entryDtsPath), content, outDir);
         }
@@ -1108,8 +1158,7 @@ export default ${libName}
             await writeOutput(
               filePath,
               await readFile(filePath, "utf-8") + (declared ? `
-${declared}
-` : ""),
+${declared}` : ""),
               dirname(filePath)
             );
           });

package/package.json

@@ -1,20 +1,20 @@
 {
   "name": "vite-plugin-dts",
-  "version": "4.0.0-beta.0",
+  "version": "4.0.0-beta.2",
   "type": "module",
+  "packageManager": "pnpm@8.3.0",
   "license": "MIT",
   "author": "qmhc",
-  "packageManager": "pnpm@8.3.0",
   "scripts": {
     "build": "tsx scripts/build.ts",
     "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s --commit-path .",
     "dev": "unbuild --stub",
-    "lint": "eslint --ext .js,.jsx,.ts,.tsx \"{src,tests}/**\"",
     "_postinstall": "is-ci || husky install",
-    "postpublish": "pinst --enable",
+    "lint": "eslint --ext .js,.jsx,.ts,.tsx \"{src,tests}/**\"",
     "precommit": "lint-staged -c ./.husky/.lintstagedrc -q",
     "prepublishOnly": "pinst --disable",
     "prettier": "pretty-quick --staged && pnpm run lint",
+    "postpublish": "pinst --enable",
     "release": "tsx scripts/release.ts",
     "test": "vitest run",
     "test:dev": "vitest",
@@ -39,13 +39,6 @@
   "engines": {
     "node": "^14.18.0 || >=16.0.0"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/qmhc/vite-plugin-dts.git"
-  },
-  "bugs": {
-    "url": "https://github.com/qmhc/vite-plugin-dts/issues"
-  },
   "keywords": [
     "vite",
     "vite-plugin",
@@ -57,15 +50,24 @@
     "vue-tsc",
     "volar"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/qmhc/vite-plugin-dts.git"
+  },
+  "bugs": {
+    "url": "https://github.com/qmhc/vite-plugin-dts/issues"
+  },
   "dependencies": {
-    "@microsoft/api-extractor": "7.47.2",
+    "@microsoft/api-extractor": "7.47.4",
     "@rollup/pluginutils": "^5.1.0",
     "@volar/typescript": "^2.3.4",
-    "@vue/language-core": "2.0.19",
-    "debug": "^4.3.5",
+    "@vue/language-core": "2.0.29",
+    "compare-versions": "^6.1.1",
+    "debug": "^4.3.6",
     "kolorist": "^1.8.0",
-    "magic-string": "^0.30.10",
-    "vue-tsc": "2.0.19"
+    "local-pkg": "^0.5.0",
+    "magic-string": "^0.30.11",
+    "vue-tsc": "2.0.29"
   },
   "devDependencies": {
     "@commitlint/cli": "^19.3.0",
@@ -76,7 +78,7 @@
     "@types/semver": "^7.5.8",
     "@vexip-ui/commitlint-config": "^0.5.0",
     "@vexip-ui/eslint-config": "^0.12.1",
-    "@vexip-ui/prettier-config": "^0.2.0",
+    "@vexip-ui/prettier-config": "^1.0.0",
     "@vue/eslint-config-standard": "^8.0.1",
     "@vue/eslint-config-typescript": "^13.0.0",
     "conventional-changelog-cli": "^5.0.0",
@@ -93,10 +95,10 @@
     "rimraf": "^6.0.1",
     "semver": "^7.6.3",
     "tsx": "^4.16.2",
-    "typescript": "5.5.3",
+    "typescript": "5.5.4",
     "unbuild": "^2.0.0",
-    "vite": "^5.3.4",
-    "vitest": "^2.0.3"
+    "vite": "^5.3.5",
+    "vitest": "^2.0.4"
   },
   "peerDependencies": {
     "typescript": "*",
@@ -109,7 +111,7 @@
   },
   "pnpm": {
     "patchedDependencies": {
-      "@microsoft/api-extractor@7.47.2": "patches/@microsoft__api-extractor@7.47.2.patch"
+      "@microsoft/api-extractor@7.47.4": "patches/@microsoft__api-extractor@7.47.4.patch"
     }
   }
 }