rsbuild-plugin-dts 0.10.6 → 0.11.1

package/README.md

@@ -136,6 +136,25 @@ pluginDts({
 });
 ```
 
+### alias
+
+- **Type:** `Record<string, string>`
+- **Default:** `{}`
+
+Configure the path alias for declaration files.
+
+`alias` will be merged with `compilerOptions.paths` configured in `tsconfig.json` and `alias` has a higher priority.
+
+In most cases, you don't need to use `alias`, but consider using it when you need to use path alias only in declaration files without wanting to affect JavaScript outputs. For example, map the declaration file of `foo` to `./compiled/foo`.
+
+```js
+pluginDts({
+  alias: {
+    foo: './compiled/foo',
+  },
+});
+```
+
 ### autoExternal
 
 - **Type:** `boolean`

package/dist/dts.js

@@ -3,7 +3,7 @@ import { basename, dirname, isAbsolute, join, normalize, relative, resolve } fro
 import { logger } from "@rsbuild/core";
 import picocolors from "picocolors";
 import { emitDts } from "./tsc.js";
-import { calcLongestCommonPath, ensureTempDeclarationDir } from "./utils.js";
+import { calcLongestCommonPath, ensureTempDeclarationDir, mergeAliasWithTsConfigPaths } from "./utils.js";
 const isObject = (obj)=>'[object Object]' === Object.prototype.toString.call(obj);
 const calcBundledPackages = (options)=>{
     const { cwd, autoExternal, userExternals, overrideBundledPackages } = options;
@@ -53,20 +53,19 @@ const calcBundledPackages = (options)=>{
     return Array.from(new Set(bundledPackages));
 };
 async function generateDts(data) {
-    const { bundle, dtsEntry, dtsEmitPath, tsconfigPath, tsConfigResult, name, cwd, build, isWatch, dtsExtension = '.d.ts', autoExternal = true, userExternals, apiExtractorOptions, banner, footer, redirect = {
+    const { bundle, dtsEntry, dtsEmitPath, tsconfigPath, tsConfigResult, name, cwd, build, isWatch, dtsExtension = '.d.ts', autoExternal = true, alias = {}, userExternals, apiExtractorOptions, banner, footer, redirect = {
         path: true,
         extension: false
     } } = data;
     if (!isWatch) logger.start(`generating declaration files... ${picocolors.gray(`(${name})`)}`);
+    const paths = mergeAliasWithTsConfigPaths(tsConfigResult.options.paths, alias);
+    if (Object.keys(paths).length > 0) tsConfigResult.options.paths = paths;
     const { options: rawCompilerOptions, fileNames } = tsConfigResult;
     const rootDir = rawCompilerOptions.rootDir ?? (rawCompilerOptions.composite ? dirname(tsconfigPath) : await calcLongestCommonPath(fileNames.filter((fileName)=>!/\.d\.(ts|mts|cts)$/.test(fileName)))) ?? dirname(tsconfigPath);
     const resolvedDtsEmitPath = normalize(resolve(dirname(tsconfigPath), dtsEmitPath));
     if (build) {
         if (bundle) throw Error('Can not set "dts.bundle: true" when "dts.build: true"');
-        if ((!rawCompilerOptions.outDir || normalize(rawCompilerOptions.outDir) !== resolvedDtsEmitPath) && (!rawCompilerOptions.declarationDir || normalize(rawCompilerOptions.declarationDir) !== resolvedDtsEmitPath)) {
-            const info = rawCompilerOptions.outDir && !rawCompilerOptions.declarationDir ? 'outDir' : 'declarationDir';
-            throw Error(`Please set ${info}: "${dtsEmitPath}" in ${picocolors.underline(tsconfigPath)} to keep it same as "dts.distPath" or "output.distPath.root" field in lib config.`);
-        }
+        if ((!rawCompilerOptions.outDir || normalize(rawCompilerOptions.outDir) !== resolvedDtsEmitPath) && (!rawCompilerOptions.declarationDir || normalize(rawCompilerOptions.declarationDir) !== resolvedDtsEmitPath)) throw Error(`Please set "declarationDir": "${dtsEmitPath}" in ${picocolors.underline(tsconfigPath)} to keep it same as "dts.distPath" or "output.distPath.root" field in lib config.`);
     }
     const declarationDir = bundle ? ensureTempDeclarationDir(cwd, name) : dtsEmitPath;
     let dtsEntries = [];
@@ -114,6 +113,7 @@ async function generateDts(data) {
         dtsExtension,
         redirect,
         rootDir,
+        paths,
         banner,
         footer
     }, onComplete, bundle, isWatch, build);

package/dist/index.d.ts

@@ -13,6 +13,7 @@ export type PluginDtsOptions = {
     build?: boolean;
     abortOnError?: boolean;
     dtsExtension?: string;
+    alias?: Record<string, string>;
     autoExternal?: boolean | {
         dependencies?: boolean;
         optionalDependencies?: boolean;

package/dist/index.js

@@ -21,6 +21,7 @@ const pluginDts = (options = {})=>({
             options.redirect = options.redirect ?? {};
             options.redirect.path = options.redirect.path ?? true;
             options.redirect.extension = options.redirect.extension ?? false;
+            options.alias = options.alias ?? {};
             const dtsPromises = [];
             let promisesResult = [];
             let childProcesses = [];

package/dist/tsc.d.ts

@@ -9,6 +9,7 @@ export type EmitDtsOptions = {
     dtsExtension: string;
     rootDir: string;
     redirect: DtsRedirect;
+    paths: Record<string, string[]>;
     banner?: string;
     footer?: string;
 };

package/dist/tsc.js

@@ -8,7 +8,7 @@ const formatHost = {
     getCurrentDirectory: typescript.sys.getCurrentDirectory,
     getNewLine: ()=>typescript.sys.newLine
 };
-async function handleDiagnosticsAndProcessFiles(diagnostics, configPath, bundle, declarationDir, dtsExtension, redirect, rootDir, banner, footer, name) {
+async function handleDiagnosticsAndProcessFiles(diagnostics, configPath, bundle, declarationDir, dtsExtension, redirect, rootDir, paths, banner, footer, name) {
     const diagnosticMessages = [];
     for (const diagnostic of diagnostics){
         const message = typescript.formatDiagnosticsWithColorAndContext([
@@ -16,7 +16,7 @@ async function handleDiagnosticsAndProcessFiles(diagnostics, configPath, bundle,
         ], formatHost);
         diagnosticMessages.push(message);
     }
-    await processDtsFiles(bundle, declarationDir, dtsExtension, redirect, configPath, rootDir, banner, footer);
+    await processDtsFiles(bundle, declarationDir, dtsExtension, redirect, configPath, rootDir, paths, banner, footer);
     if (diagnosticMessages.length) {
         for (const message of diagnosticMessages)logger.error(logPrefixTsc, message);
         const error = new Error(`Failed to generate declaration files. ${picocolors.gray(`(${name})`)}`);
@@ -26,7 +26,7 @@ async function handleDiagnosticsAndProcessFiles(diagnostics, configPath, bundle,
 }
 async function emitDts(options, onComplete, bundle = false, isWatch = false, build = false) {
     const start = Date.now();
-    const { configPath, tsConfigResult, declarationDir, name, dtsExtension, rootDir, banner, footer, redirect } = options;
+    const { configPath, tsConfigResult, declarationDir, name, dtsExtension, rootDir, banner, footer, paths, redirect } = options;
     const { options: rawCompilerOptions, fileNames, projectReferences } = tsConfigResult;
     const compilerOptions = {
         ...rawCompilerOptions,
@@ -51,11 +51,11 @@ async function emitDts(options, onComplete, bundle = false, isWatch = false, bui
                 logger.info(logPrefixTsc, message);
                 onComplete(true);
             }
-            await processDtsFiles(bundle, declarationDir, dtsExtension, redirect, configPath, rootDir, banner, footer);
+            await processDtsFiles(bundle, declarationDir, dtsExtension, redirect, configPath, rootDir, paths, banner, footer);
         }
         if (6193 === diagnostic.code) {
             logger.error(logPrefixTsc, message);
-            await processDtsFiles(bundle, declarationDir, dtsExtension, redirect, configPath, rootDir, banner, footer);
+            await processDtsFiles(bundle, declarationDir, dtsExtension, redirect, configPath, rootDir, paths, banner, footer);
         }
     };
     const renameDtsFile = (fileName)=>{
@@ -102,7 +102,7 @@ async function emitDts(options, onComplete, bundle = false, isWatch = false, bui
             const emitResult = program.emit();
             allDiagnostics.push(...emitResult.diagnostics);
             const sortAndDeduplicateDiagnostics = typescript.sortAndDeduplicateDiagnostics(allDiagnostics);
-            await handleDiagnosticsAndProcessFiles(sortAndDeduplicateDiagnostics, configPath, bundle, declarationDir, dtsExtension, redirect, rootDir, banner, footer, name);
+            await handleDiagnosticsAndProcessFiles(sortAndDeduplicateDiagnostics, configPath, bundle, declarationDir, dtsExtension, redirect, rootDir, paths, banner, footer, name);
         } else {
             let errorNumber = 0;
             const reportErrorSummary = (errorCount)=>{
@@ -113,7 +113,7 @@ async function emitDts(options, onComplete, bundle = false, isWatch = false, bui
                 configPath
             ], compilerOptions);
             solutionBuilder.build();
-            await processDtsFiles(bundle, declarationDir, dtsExtension, redirect, configPath, rootDir, banner, footer);
+            await processDtsFiles(bundle, declarationDir, dtsExtension, redirect, configPath, rootDir, paths, banner, footer);
             if (errorNumber > 0) {
                 const error = new Error(`Failed to generate declaration files. ${picocolors.gray(`(${name})`)}`);
                 error.stack = '';
@@ -139,7 +139,7 @@ async function emitDts(options, onComplete, bundle = false, isWatch = false, bui
             const emitResult = program.emit();
             const allDiagnostics = preEmitDiagnostics.concat(emitResult.diagnostics);
             const sortAndDeduplicateDiagnostics = typescript.sortAndDeduplicateDiagnostics(allDiagnostics);
-            await handleDiagnosticsAndProcessFiles(sortAndDeduplicateDiagnostics, configPath, bundle, declarationDir, dtsExtension, redirect, rootDir, banner, footer, name);
+            await handleDiagnosticsAndProcessFiles(sortAndDeduplicateDiagnostics, configPath, bundle, declarationDir, dtsExtension, redirect, rootDir, paths, banner, footer, name);
         }
         if (bundle) logger.info(`declaration files prepared in ${getTimeCost(start)} ${picocolors.gray(`(${name})`)}`);
         else logger.ready(`declaration files generated in ${getTimeCost(start)} ${picocolors.gray(`(${name})`)}`);

package/dist/utils.d.ts

@@ -4,6 +4,7 @@ import ts from 'typescript';
 import type { DtsEntry, DtsRedirect } from './index';
 export declare const JS_EXTENSIONS_PATTERN: RegExp;
 export declare function loadTsconfig(tsconfigPath: string): ts.ParsedCommandLine;
+export declare function mergeAliasWithTsConfigPaths(paths: Record<string, string[]> | undefined, alias?: Record<string, string>): Record<string, string[]>;
 export declare const TEMP_FOLDER = ".rslib";
 export declare const TEMP_DTS_DIR: string;
 export declare function ensureTempDeclarationDir(cwd: string, name: string): string;
@@ -16,7 +17,7 @@ export declare const prettyTime: (seconds: number) => string;
 export declare function getTimeCost(start: number): string;
 export declare function addBannerAndFooter(dtsFile: string, banner?: string, footer?: string): Promise<void>;
 export declare function redirectDtsImports(dtsFile: string, dtsExtension: string, redirect: DtsRedirect, matchPath: MatchPath, outDir: string, rootDir: string): Promise<void>;
-export declare function processDtsFiles(bundle: boolean, dir: string, dtsExtension: string, redirect: DtsRedirect, tsconfigPath: string, rootDir: string, banner?: string, footer?: string): Promise<void>;
+export declare function processDtsFiles(bundle: boolean, dir: string, dtsExtension: string, redirect: DtsRedirect, tsconfigPath: string, rootDir: string, paths: Record<string, string[]>, banner?: string, footer?: string): Promise<void>;
 export declare function processSourceEntry(bundle: boolean, entryConfig: NonNullable<RsbuildConfig['source']>['entry']): DtsEntry[];
 export declare function calcLongestCommonPath(absPaths: string[]): Promise<string | null>;
 export declare const globDtsFiles: (dir: string, patterns: string[]) => Promise<string[]>;

package/dist/utils.js

@@ -29,6 +29,22 @@ function loadTsconfig(tsconfigPath) {
     const configFileContent = typescript.parseJsonConfigFileContent(configFile.config, typescript.sys, node_path.dirname(tsconfigPath));
     return configFileContent;
 }
+function mergeAliasWithTsConfigPaths(paths, alias = {}) {
+    const mergedPaths = {};
+    if (alias && 'object' == typeof alias && Object.keys(alias).length > 0) {
+        for (const [key, value] of Object.entries(alias))if ('string' == typeof value && value.trim()) mergedPaths[key] = [
+            value
+        ];
+    }
+    if (paths) {
+        for (const [key, value] of Object.entries(paths))if (Array.isArray(value) && value.length > 0) {
+            if (!mergedPaths[key]) mergedPaths[key] = [
+                ...value
+            ];
+        }
+    }
+    return Object.keys(mergedPaths).length > 0 ? mergedPaths : {};
+}
 const TEMP_FOLDER = '.rslib';
 const TEMP_DTS_DIR = `${TEMP_FOLDER}/declarations`;
 function ensureTempDeclarationDir(cwd, name) {
@@ -227,13 +243,13 @@ async function redirectDtsImports(dtsFile, dtsExtension, redirect, matchPath, ou
     }
     if (code.hasChanged()) await promises.writeFile(dtsFile, code.toString());
 }
-async function processDtsFiles(bundle, dir, dtsExtension, redirect, tsconfigPath, rootDir, banner, footer) {
+async function processDtsFiles(bundle, dir, dtsExtension, redirect, tsconfigPath, rootDir, paths, banner, footer) {
     if (bundle) return;
     let matchPath;
     if (redirect.path || redirect.extension) {
         const result = loadConfig(tsconfigPath);
         if ('failed' === result.resultType) return void logger.error(result.message);
-        const { absoluteBaseUrl, paths, addMatchAll } = result;
+        const { absoluteBaseUrl, addMatchAll } = result;
         const mainFields = [];
         matchPath = createMatchPath(absoluteBaseUrl, paths, mainFields, addMatchAll);
     }
@@ -304,8 +320,12 @@ async function cleanDtsFiles(dir) {
 async function cleanTsBuildInfoFile(tsconfigPath, compilerOptions) {
     const tsconfigDir = dirname(tsconfigPath);
     const { outDir, rootDir, tsBuildInfoFile } = compilerOptions;
-    let tsbuildInfoFilePath = `${basename(tsconfigPath, '.json')}${tsBuildInfoFile ?? '.tsbuildinfo'}`;
-    if (outDir) tsbuildInfoFilePath = rootDir ? join(outDir, relative(resolve(tsconfigDir, rootDir), tsconfigDir), tsbuildInfoFilePath) : join(outDir, tsbuildInfoFilePath);
+    let tsbuildInfoFilePath;
+    if (tsBuildInfoFile && isAbsolute(tsBuildInfoFile)) tsbuildInfoFilePath = tsBuildInfoFile;
+    else {
+        const defaultFileName = `${basename(tsconfigPath, '.json')}${tsBuildInfoFile ?? '.tsbuildinfo'}`;
+        tsbuildInfoFilePath = outDir ? rootDir ? join(outDir, relative(resolve(tsconfigDir, rootDir), tsconfigDir), defaultFileName) : join(outDir, defaultFileName) : join(tsconfigDir, defaultFileName);
+    }
     if (await pathExists(tsbuildInfoFilePath)) await promises.rm(tsbuildInfoFilePath, {
         force: true
     });
@@ -321,4 +341,4 @@ function warnIfOutside(cwd, dir, label) {
         if (relDir.startsWith('..')) logger.warn(`The resolved ${label} ${picocolors.cyan(normalizedDir)} is outside the project root ${picocolors.cyan(normalizedCwd)}, please check your tsconfig file.`);
     }
 }
-export { JS_EXTENSIONS_PATTERN, TEMP_DTS_DIR, TEMP_FOLDER, addBannerAndFooter, calcLongestCommonPath, cleanDtsFiles, cleanTsBuildInfoFile, clearTempDeclarationDir, emptyDir, ensureTempDeclarationDir, getDtsEmitPath, getFileLoc, getTimeCost, globDtsFiles, isDirectory, loadTsconfig, pathExists, prettyTime, processDtsFiles, processSourceEntry, redirectDtsImports, warnIfOutside };
+export { JS_EXTENSIONS_PATTERN, TEMP_DTS_DIR, TEMP_FOLDER, addBannerAndFooter, calcLongestCommonPath, cleanDtsFiles, cleanTsBuildInfoFile, clearTempDeclarationDir, emptyDir, ensureTempDeclarationDir, getDtsEmitPath, getFileLoc, getTimeCost, globDtsFiles, isDirectory, loadTsconfig, mergeAliasWithTsConfigPaths, pathExists, prettyTime, processDtsFiles, processSourceEntry, redirectDtsImports, warnIfOutside };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rsbuild-plugin-dts",
-  "version": "0.10.6",
+  "version": "0.11.1",
   "description": "Rsbuild plugin that supports emitting declaration files for TypeScript.",
   "homepage": "https://rslib.rs",
   "bugs": {
@@ -32,11 +32,11 @@
     "tsconfig-paths": "^4.2.0"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.52.8",
-    "@rsbuild/core": "~1.4.7",
+    "@microsoft/api-extractor": "^7.52.10",
+    "@rsbuild/core": "~1.4.12",
     "rsbuild-plugin-publint": "^0.3.2",
-    "rslib": "npm:@rslib/core@0.10.5",
-    "typescript": "^5.8.3",
+    "rslib": "npm:@rslib/core@0.11.0",
+    "typescript": "^5.9.2",
     "@rslib/tsconfig": "0.0.1"
   },
   "peerDependencies": {