vite-plugin-dts 3.3.1 → 3.5.0

package/dist/index.cjs

@@ -185,7 +185,7 @@ function rollupDeclarationFiles({
   entryPath,
   fileName,
   libFolder,
-  bundledPackages
+  rollupConfig = {}
 }) {
   const configObjectFullPath = node_path.resolve(root, "api-extractor.json");
   if (!dtsRE$1.test(fileName)) {
@@ -193,9 +193,9 @@ function rollupDeclarationFiles({
   }
   const extractorConfig = apiExtractor.ExtractorConfig.prepare({
     configObject: {
+      ...rollupConfig,
       projectFolder: root,
       mainEntryPointFilePath: entryPath,
-      bundledPackages,
       compiler: {
         tsconfigFilePath: configPath,
         overrideTsconfig: {
@@ -205,17 +205,20 @@ function rollupDeclarationFiles({
       },
       apiReport: {
         enabled: false,
-        reportFileName: "<unscopedPackageName>.api.md"
+        reportFileName: "<unscopedPackageName>.api.md",
+        ...rollupConfig.apiReport
       },
       docModel: {
-        enabled: false
+        enabled: false,
+        ...rollupConfig.docModel
       },
       dtsRollup: {
         enabled: true,
         publicTrimmedFilePath: node_path.resolve(outDir, fileName)
       },
       tsdocMetadata: {
-        enabled: false
+        enabled: false,
+        ...rollupConfig.tsdocMetadata
       },
       messages: {
         compilerMessageReporting: {
@@ -227,7 +230,8 @@ function rollupDeclarationFiles({
           default: {
             logLevel: "none"
           }
-        }
+        },
+        ...rollupConfig.messages
       }
     },
     configObjectFullPath,
@@ -398,7 +402,7 @@ const dynamicImportRE = /import\(['"]([^;\n]+?)['"]\)/;
 const simpleStaticImportRE = /((?:import|export).+from\s?)['"](.+)['"]/;
 const simpleDynamicImportRE = /(import\()['"](.+)['"]\)/;
 function transformAliasImport(filePath, content, aliases, exclude = []) {
-  if (!aliases.length)
+  if (!aliases?.length)
     return content;
   return content.replace(globalImportRE, (str) => {
     let matchResult = str.match(staticImportRE);
@@ -464,10 +468,10 @@ function dtsPlugin(options = {}) {
     cleanVueFileName = false,
     insertTypesEntry = false,
     rollupTypes = false,
-    bundledPackages = [],
     pathsToAliases = true,
     aliasesExclude = [],
     copyDtsFiles = false,
+    declarationOnly = false,
     strictOutput = true,
     afterDiagnostic = noop,
     beforeWriteFile = noop,
@@ -500,6 +504,8 @@ function dtsPlugin(options = {}) {
   ]);
   const rootFiles = /* @__PURE__ */ new Set();
   const outputFiles = /* @__PURE__ */ new Map();
+  const rollupConfig = { ...options.rollupConfig || {} };
+  rollupConfig.bundledPackages = rollupConfig.bundledPackages || options.bundledPackages || [];
   return {
     name: "vite:dts",
     apply: "build",
@@ -543,13 +549,11 @@ function dtsPlugin(options = {}) {
         }
       } else {
         logger.warn(
-          kolorist.yellow(
-            `
-${kolorist.cyan(
-              "[vite:dts]"
-            )} You are building a library that may not need to generate declaration files.
+          `
+${logPrefix} ${kolorist.yellow(
+            "You are building a library that may not need to generate declaration files."
+          )}
 `
-          )
         );
         libName = "_default";
         indexName = defaultIndex;
@@ -674,7 +678,7 @@ ${kolorist.cyan(
       } else {
         const sourceFile = program.getSourceFile(id);
         if (sourceFile) {
-          for (const outputFile of service.getEmitOutput(sourceFile.fileName, true).outputFiles) {
+          for (const outputFile of service.getEmitOutput(sourceFile.fileName, true, true).outputFiles) {
             outputFiles.set(
               resolve(publicRoot, node_path.relative(outDir, ensureAbsolute(outputFile.name, outDir))),
               outputFile.text
@@ -799,7 +803,17 @@ ${logPrefix} Start generate declaration files...`));
         const entryNames = Object.keys(entries);
         const types = pkg.types || pkg.typings || pkg.publishConfig?.types || pkg.publishConfig?.typings || (pkg.exports?.["."] || pkg.exports?.["./"])?.types;
         const multiple = entryNames.length > 1;
-        const typesPath = types ? resolve(root, types) : resolve(outDir, indexName);
+        let typesPath = types ? resolve(root, types) : resolve(outDir, indexName);
+        if (!multiple && !dtsRE.test(typesPath)) {
+          logger.warn(
+            `
+${logPrefix} ${kolorist.yellow(
+              "The resolved path of type entry is not ending with '.d.ts'."
+            )}
+`
+          );
+          typesPath = `${typesPath.replace(tjsRE, "")}.d.${extPrefix(typesPath)}ts`;
+        }
         for (const name of entryNames) {
           const path = multiple ? resolve(outDir, `${name.replace(tsRE, "")}.d.ts`) : typesPath;
           if (node_fs.existsSync(path))
@@ -847,7 +861,7 @@ export default ${libName}
                 entryPath: path,
                 fileName: node_path.basename(path),
                 libFolder,
-                bundledPackages
+                rollupConfig
               });
               emittedFiles.delete(path);
               rollupFiles.add(path);
@@ -861,7 +875,7 @@ export default ${libName}
               entryPath: typesPath,
               fileName: node_path.basename(typesPath),
               libFolder,
-              bundledPackages
+              rollupConfig
             });
             emittedFiles.delete(typesPath);
             rollupFiles.add(typesPath);
@@ -909,6 +923,13 @@ export default ${libName}
         kolorist.green(`${logPrefix} Declaration files built in ${timeRecord + Date.now() - startTime}ms.
 `)
       );
+    },
+    generateBundle(_, bundle) {
+      if (declarationOnly) {
+        for (const id of Object.keys(bundle)) {
+          delete bundle[id];
+        }
+      }
     }
   };
 }

package/dist/index.d.ts

@@ -1,8 +1,10 @@
 import * as vite from 'vite';
 import { LogLevel } from 'vite';
 import ts from 'typescript';
+import { IExtractorConfigPrepareOptions } from '@microsoft/api-extractor';
 
 type MaybePromise<T> = T | Promise<T>;
+type RollupConfig = Omit<IExtractorConfigPrepareOptions['configObject'], 'projectFolder' | 'mainEntryPointFilePath' | 'compiler' | 'dtsRollup'>;
 interface Resolver {
     /**
      * The name of the resolver
@@ -155,6 +157,13 @@ interface PluginOptions {
      * @see https://api-extractor.com/pages/configs/api-extractor_json/#bundledpackages
      */
     bundledPackages?: string[];
+    /**
+     * Override the config of `@microsoft/api-extractor`
+     *
+     * @default null
+     * @see https://api-extractor.com/pages/setup/configure_api_report/
+     */
+    rollupConfig?: RollupConfig;
     /**
      * Whether to copy .d.ts source files to `outDir`
      *
@@ -162,6 +171,14 @@ interface PluginOptions {
      * @remarks Before 2.0, the default was `true`
      */
     copyDtsFiles?: boolean;
+    /**
+     * Whether to emit declaration files only
+     *
+     * When `true`, all the original outputs of vite (rollup) will be force removed
+     *
+     * @default false
+     */
+    declarationOnly?: boolean;
     /**
      * Logging level for this plugin
      *

package/dist/index.mjs

@@ -185,7 +185,7 @@ function rollupDeclarationFiles({
   entryPath,
   fileName,
   libFolder,
-  bundledPackages
+  rollupConfig = {}
 }) {
   const configObjectFullPath = resolve$1(root, "api-extractor.json");
   if (!dtsRE$1.test(fileName)) {
@@ -193,9 +193,9 @@ function rollupDeclarationFiles({
   }
   const extractorConfig = ExtractorConfig.prepare({
     configObject: {
+      ...rollupConfig,
       projectFolder: root,
       mainEntryPointFilePath: entryPath,
-      bundledPackages,
       compiler: {
         tsconfigFilePath: configPath,
         overrideTsconfig: {
@@ -205,17 +205,20 @@ function rollupDeclarationFiles({
       },
       apiReport: {
         enabled: false,
-        reportFileName: "<unscopedPackageName>.api.md"
+        reportFileName: "<unscopedPackageName>.api.md",
+        ...rollupConfig.apiReport
       },
       docModel: {
-        enabled: false
+        enabled: false,
+        ...rollupConfig.docModel
       },
       dtsRollup: {
         enabled: true,
         publicTrimmedFilePath: resolve$1(outDir, fileName)
       },
       tsdocMetadata: {
-        enabled: false
+        enabled: false,
+        ...rollupConfig.tsdocMetadata
       },
       messages: {
         compilerMessageReporting: {
@@ -227,7 +230,8 @@ function rollupDeclarationFiles({
           default: {
             logLevel: "none"
           }
-        }
+        },
+        ...rollupConfig.messages
       }
     },
     configObjectFullPath,
@@ -398,7 +402,7 @@ const dynamicImportRE = /import\(['"]([^;\n]+?)['"]\)/;
 const simpleStaticImportRE = /((?:import|export).+from\s?)['"](.+)['"]/;
 const simpleDynamicImportRE = /(import\()['"](.+)['"]\)/;
 function transformAliasImport(filePath, content, aliases, exclude = []) {
-  if (!aliases.length)
+  if (!aliases?.length)
     return content;
   return content.replace(globalImportRE, (str) => {
     let matchResult = str.match(staticImportRE);
@@ -464,10 +468,10 @@ function dtsPlugin(options = {}) {
     cleanVueFileName = false,
     insertTypesEntry = false,
     rollupTypes = false,
-    bundledPackages = [],
     pathsToAliases = true,
     aliasesExclude = [],
     copyDtsFiles = false,
+    declarationOnly = false,
     strictOutput = true,
     afterDiagnostic = noop,
     beforeWriteFile = noop,
@@ -500,6 +504,8 @@ function dtsPlugin(options = {}) {
   ]);
   const rootFiles = /* @__PURE__ */ new Set();
   const outputFiles = /* @__PURE__ */ new Map();
+  const rollupConfig = { ...options.rollupConfig || {} };
+  rollupConfig.bundledPackages = rollupConfig.bundledPackages || options.bundledPackages || [];
   return {
     name: "vite:dts",
     apply: "build",
@@ -543,13 +549,11 @@ function dtsPlugin(options = {}) {
         }
       } else {
         logger.warn(
-          yellow(
-            `
-${cyan(
-              "[vite:dts]"
-            )} You are building a library that may not need to generate declaration files.
+          `
+${logPrefix} ${yellow(
+            "You are building a library that may not need to generate declaration files."
+          )}
 `
-          )
         );
         libName = "_default";
         indexName = defaultIndex;
@@ -674,7 +678,7 @@ ${cyan(
       } else {
         const sourceFile = program.getSourceFile(id);
         if (sourceFile) {
-          for (const outputFile of service.getEmitOutput(sourceFile.fileName, true).outputFiles) {
+          for (const outputFile of service.getEmitOutput(sourceFile.fileName, true, true).outputFiles) {
             outputFiles.set(
               resolve(publicRoot, relative(outDir, ensureAbsolute(outputFile.name, outDir))),
               outputFile.text
@@ -799,7 +803,17 @@ ${logPrefix} Start generate declaration files...`));
         const entryNames = Object.keys(entries);
         const types = pkg.types || pkg.typings || pkg.publishConfig?.types || pkg.publishConfig?.typings || (pkg.exports?.["."] || pkg.exports?.["./"])?.types;
         const multiple = entryNames.length > 1;
-        const typesPath = types ? resolve(root, types) : resolve(outDir, indexName);
+        let typesPath = types ? resolve(root, types) : resolve(outDir, indexName);
+        if (!multiple && !dtsRE.test(typesPath)) {
+          logger.warn(
+            `
+${logPrefix} ${yellow(
+              "The resolved path of type entry is not ending with '.d.ts'."
+            )}
+`
+          );
+          typesPath = `${typesPath.replace(tjsRE, "")}.d.${extPrefix(typesPath)}ts`;
+        }
         for (const name of entryNames) {
           const path = multiple ? resolve(outDir, `${name.replace(tsRE, "")}.d.ts`) : typesPath;
           if (existsSync(path))
@@ -847,7 +861,7 @@ export default ${libName}
                 entryPath: path,
                 fileName: basename(path),
                 libFolder,
-                bundledPackages
+                rollupConfig
               });
               emittedFiles.delete(path);
               rollupFiles.add(path);
@@ -861,7 +875,7 @@ export default ${libName}
               entryPath: typesPath,
               fileName: basename(typesPath),
               libFolder,
-              bundledPackages
+              rollupConfig
             });
             emittedFiles.delete(typesPath);
             rollupFiles.add(typesPath);
@@ -909,6 +923,13 @@ export default ${libName}
         green(`${logPrefix} Declaration files built in ${timeRecord + Date.now() - startTime}ms.
 `)
       );
+    },
+    generateBundle(_, bundle) {
+      if (declarationOnly) {
+        for (const id of Object.keys(bundle)) {
+          delete bundle[id];
+        }
+      }
     }
   };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-dts",
-  "version": "3.3.1",
+  "version": "3.5.0",
   "type": "module",
   "license": "MIT",
   "author": "qmhc",
@@ -53,46 +53,43 @@
     "typescript"
   ],
   "dependencies": {
-    "@microsoft/api-extractor": "^7.36.0",
+    "@microsoft/api-extractor": "^7.36.3",
     "@rollup/pluginutils": "^5.0.2",
-    "@vue/language-core": "^1.8.1",
+    "@vue/language-core": "^1.8.8",
     "debug": "^4.3.4",
     "kolorist": "^1.8.0",
-    "vue-tsc": "^1.8.1"
+    "vue-tsc": "^1.8.8"
   },
   "devDependencies": {
-    "@commitlint/cli": "^17.6.6",
-    "@commitlint/config-conventional": "^17.6.6",
+    "@commitlint/cli": "^17.6.7",
     "@types/debug": "^4.1.8",
     "@types/minimist": "^1.2.2",
-    "@types/node": "^20.3.1",
+    "@types/node": "^20.4.5",
     "@types/prompts": "^2.4.4",
     "@types/semver": "^7.5.0",
-    "@typescript-eslint/eslint-plugin": "^5.60.0",
-    "@typescript-eslint/parser": "^5.60.0",
-    "@vexip-ui/commitlint-config": "^0.1.0",
-    "@vexip-ui/eslint-config": "^0.6.3",
+    "@vexip-ui/commitlint-config": "^0.2.0",
+    "@vexip-ui/eslint-config": "^0.8.1",
     "@vexip-ui/prettier-config": "^0.2.0",
     "@vue/eslint-config-standard": "^8.0.1",
     "@vue/eslint-config-typescript": "^11.0.3",
     "conventional-changelog-cli": "^3.0.0",
-    "eslint": "^8.43.0",
-    "execa": "^7.1.1",
+    "eslint": "^8.46.0",
+    "execa": "^7.2.0",
     "husky": "^8.0.3",
     "is-ci": "^3.0.1",
-    "lint-staged": "^13.2.2",
+    "lint-staged": "^13.2.3",
     "minimist": "^1.2.8",
     "pinst": "^3.0.0",
     "prettier": "^2.8.8",
     "pretty-quick": "^3.1.3",
     "prompts": "^2.4.2",
     "rimraf": "^5.0.1",
-    "semver": "^7.5.3",
+    "semver": "^7.5.4",
     "tsx": "^3.12.7",
     "typescript": "5.0.4",
     "unbuild": "^1.2.1",
-    "vite": "^4.3.9",
-    "vitest": "^0.32.2"
+    "vite": "^4.4.7",
+    "vitest": "^0.33.0"
   },
   "peerDependencies": {
     "typescript": "*",