fix: respect declarationDir if dts.distPath is not set (#420)

Author: Timeless0911

packages/core/src/config.ts

@@ -911,7 +911,7 @@ const composeDtsConfig = async (
   libConfig: LibConfig,
   dtsExtension: string,
 ): Promise<RsbuildConfig> => {
-  const { output, autoExternal, banner, footer } = libConfig;
+  const { autoExternal, banner, footer } = libConfig;
 
   let { dts } = libConfig;
 
@@ -929,10 +929,10 @@ const composeDtsConfig = async (
     plugins: [
       pluginDts({
         // Only setting ⁠dts.bundle to true will generate the bundled d.ts.
-        bundle: dts?.bundle ?? false,
-        distPath: dts?.distPath ?? output?.distPath?.root ?? './dist',
-        build: dts?.build ?? false,
-        abortOnError: dts?.abortOnError ?? true,
+        bundle: dts?.bundle,
+        distPath: dts?.distPath,
+        build: dts?.build,
+        abortOnError: dts?.abortOnError,
         dtsExtension: dts?.autoExtension ? dtsExtension : '.d.ts',
         autoExternal,
         banner: banner?.dts,

packages/plugin-dts/src/apiExtractor.ts

@@ -12,7 +12,7 @@ import { addBannerAndFooter, getTimeCost } from './utils';
 export type BundleOptions = {
   name: string;
   cwd: string;
-  outDir: string;
+  distPath: string;
   dtsExtension: string;
   banner?: string;
   footer?: string;
@@ -25,7 +25,7 @@ export async function bundleDts(options: BundleOptions): Promise<void> {
   const {
     name,
     cwd,
-    outDir,
+    distPath,
     dtsExtension,
     banner,
     footer,
@@ -40,7 +40,7 @@ export async function bundleDts(options: BundleOptions): Promise<void> {
     const start = Date.now();
     const untrimmedFilePath = join(
       cwd,
-      relative(cwd, outDir),
+      relative(cwd, distPath),
       `${dtsEntry.name}${dtsExtension}`,
     );
     const mainEntryPointFilePath = dtsEntry.path!;

packages/plugin-dts/src/dts.ts

@@ -125,6 +125,7 @@ export async function generateDts(data: DtsGenOptions): Promise<void> {
     userExternals,
     banner,
     footer,
+    rootDistPath,
   } = data;
   logger.start(`Generating DTS... ${color.gray(`(${name})`)}`);
   const configPath = ts.findConfigFile(cwd, ts.sys.fileExists, tsconfigPath);
@@ -146,9 +147,12 @@ export async function generateDts(data: DtsGenOptions): Promise<void> {
         )) ??
     dirname(configPath);
 
-  const outDir = distPath
-    ? distPath
-    : rawCompilerOptions.declarationDir || './dist';
+  const dtsEmitPath =
+    distPath ?? rawCompilerOptions.declarationDir ?? rootDistPath;
+
+  const resolvedDtsEmitPath = normalize(
+    resolve(dirname(configPath), dtsEmitPath),
+  );
 
   if (build) {
     // do not allow to use bundle DTS when 'build: true' since temp declarationDir should be set by user in tsconfig
@@ -159,34 +163,24 @@ export async function generateDts(data: DtsGenOptions): Promise<void> {
     // can not set '--declarationDir' or '--outDir' when 'build: true'.
     if (
       (!rawCompilerOptions.outDir ||
-        normalize(rawCompilerOptions.outDir) !==
-          normalize(resolve(dirname(configPath), outDir))) &&
+        normalize(rawCompilerOptions.outDir) !== resolvedDtsEmitPath) &&
       (!rawCompilerOptions.declarationDir ||
-        normalize(rawCompilerOptions.declarationDir) !==
-          normalize(resolve(dirname(configPath), outDir)))
+        normalize(rawCompilerOptions.declarationDir) !== resolvedDtsEmitPath)
     ) {
       const info =
         rawCompilerOptions.outDir && !rawCompilerOptions.declarationDir
           ? 'outDir'
           : 'declarationDir';
       throw Error(
-        `Please set ${info}: "${outDir}" in ${color.underline(
+        `Please set ${info}: "${dtsEmitPath}" in ${color.underline(
           configPath,
-        )} to keep it same as "dts.distPath" or "output.distPath" field in lib config.`,
+        )} to keep it same as "dts.distPath" or "output.distPath.root" field in lib config.`,
       );
     }
   }
 
-  const getDeclarationDir = (bundle: boolean, distPath?: string) => {
-    if (bundle) {
-      return ensureTempDeclarationDir(cwd);
-    }
-    return distPath
-      ? distPath
-      : (rawCompilerOptions.declarationDir ?? './dist');
-  };
+  const declarationDir = bundle ? ensureTempDeclarationDir(cwd) : dtsEmitPath;
 
-  const declarationDir = getDeclarationDir(bundle!, distPath);
   const { name: entryName, path: entryPath } = dtsEntry;
   let entry = '';
 
@@ -211,7 +205,7 @@ export async function generateDts(data: DtsGenOptions): Promise<void> {
       await bundleDts({
         name,
         cwd,
-        outDir,
+        distPath: dtsEmitPath,
         dtsEntry: {
           name: entryName,
           path: entry,

packages/plugin-dts/src/index.ts

@@ -34,6 +34,7 @@ export type DtsGenOptions = PluginDtsOptions & {
   cwd: string;
   isWatch: boolean;
   dtsEntry: DtsEntry;
+  rootDistPath: string;
   build?: boolean;
   tsconfigPath?: string;
   userExternals?: NonNullable<RsbuildConfig['output']>['externals'];
@@ -68,8 +69,6 @@ export const pluginDts = (options: PluginDtsOptions): RsbuildPlugin => ({
 
         const { config } = environment;
 
-        options.distPath = options.distPath ?? config.output?.distPath?.root;
-
         const jsExtension = extname(__filename);
         const childProcess = fork(join(__dirname, `./dts${jsExtension}`), [], {
           stdio: 'inherit',
@@ -86,6 +85,7 @@ export const pluginDts = (options: PluginDtsOptions): RsbuildPlugin => ({
           ...options,
           dtsEntry,
           userExternals: config.output.externals,
+          rootDistPath: config.output?.distPath?.root,
           tsconfigPath: config.source.tsconfigPath,
           name: environment.name,
           cwd: api.context.rootPath,

pnpm-lock.yaml

@@ -0,0 +1,6 @@
+{
+  "name": "dts-bundle-false-declaration-dir-test",
+  "version": "1.0.0",
+  "private": true,
+  "type": "module"
+}

tests/integration/dts/bundle-false/declaration-dir/package.json

@@ -0,0 +1,18 @@
+import { defineConfig } from '@rslib/core';
+import { generateBundleEsmConfig } from 'test-helper';
+
+export default defineConfig({
+  lib: [
+    generateBundleEsmConfig({
+      bundle: false,
+      dts: {
+        bundle: false,
+      },
+    }),
+  ],
+  source: {
+    entry: {
+      index: ['../__fixtures__/src/**'],
+    },
+  },
+});

tests/integration/dts/bundle-false/declaration-dir/rslib.config.ts

@@ -0,0 +1,8 @@
+{
+  "extends": "@rslib/tsconfig/base",
+  "compilerOptions": {
+    "baseUrl": "./",
+    "declarationDir": "./dist-types"
+  },
+  "include": ["../__fixtures__/src"]
+}

tests/integration/dts/bundle-false/declaration-dir/tsconfig.json

@@ -1,6 +1,6 @@
 import { existsSync } from 'node:fs';
 import { join } from 'node:path';
-import { buildAndGetResults } from 'test-helper';
+import { buildAndGetResults, globContentJSON } from 'test-helper';
 import { describe, expect, test } from 'vitest';
 
 describe('dts when bundle: false', () => {
@@ -90,6 +90,27 @@ describe('dts when bundle: false', () => {
       ]
     `);
   });
+
+  test('should use declarationDir when not set dts.distPath', async () => {
+    const fixturePath = join(__dirname, 'bundle-false', 'declaration-dir');
+    const distTypesPath = join(fixturePath, 'dist-types');
+
+    await buildAndGetResults({ fixturePath, type: 'dts' });
+
+    const distTypeFiles = await globContentJSON(distTypesPath, {
+      absolute: true,
+    });
+    const distTypeFilePaths = Object.keys(distTypeFiles).sort();
+
+    expect(distTypeFilePaths).toMatchInlineSnapshot(`
+      [
+        "<ROOT>/tests/integration/dts/bundle-false/declaration-dir/dist-types/index.d.ts",
+        "<ROOT>/tests/integration/dts/bundle-false/declaration-dir/dist-types/sum.d.ts",
+        "<ROOT>/tests/integration/dts/bundle-false/declaration-dir/dist-types/utils/numbers.d.ts",
+        "<ROOT>/tests/integration/dts/bundle-false/declaration-dir/dist-types/utils/strings.d.ts",
+      ]
+    `);
+  });
 });
 
 describe('dts when bundle: true', () => {
@@ -309,7 +330,7 @@ describe('dts when build: true', () => {
     expect(isSuccess).toBe(true);
   });
 
-  test('tsconfig missing some fields', async () => {
+  test('tsconfig missing some fields - declarationDir or outDir', async () => {
     const fixturePath = join(__dirname, 'composite', 'tsconfig');
     try {
       await buildAndGetResults({