feat: warn if declarationDir or outDir is resolved outside project root (#780)

Author: Timeless0911

packages/plugin-dts/src/index.ts

@@ -10,6 +10,7 @@ import {
   clearTempDeclarationDir,
   loadTsconfig,
   processSourceEntry,
+  warnIfOutside,
 } from './utils';
 
 const __filename = fileURLToPath(import.meta.url);
@@ -110,11 +111,18 @@ export const pluginDts = (options: PluginDtsOptions = {}): RsbuildPlugin => ({
 
         const tsConfigResult = loadTsconfig(tsconfigPath);
         const { options: rawCompilerOptions } = tsConfigResult;
+        const { declarationDir, outDir, composite, incremental } =
+          rawCompilerOptions;
         const dtsEmitPath =
           options.distPath ??
-          rawCompilerOptions.declarationDir ??
+          declarationDir ??
+          outDir ??
           config.output?.distPath?.root;
 
+        // check whether declarationDir or outDir is outside from current project
+        warnIfOutside(cwd, declarationDir, 'declarationDir');
+        warnIfOutside(cwd, outDir, 'outDir');
+
         // clean dts files
         if (config.output.cleanDistPath !== false) {
           await cleanDtsFiles(dtsEmitPath);
@@ -126,11 +134,7 @@ export const pluginDts = (options: PluginDtsOptions = {}): RsbuildPlugin => ({
         }
 
         // clean tsbuildinfo file
-        if (
-          rawCompilerOptions.composite ||
-          rawCompilerOptions.incremental ||
-          options.build
-        ) {
+        if (composite || incremental || options.build) {
           await cleanTsBuildInfoFile(tsconfigPath, rawCompilerOptions);
         }
 

packages/plugin-dts/src/utils.ts

@@ -505,3 +505,21 @@ export async function cleanTsBuildInfoFile(
     await fsP.rm(tsbuildInfoFilePath, { force: true });
   }
 }
+
+export function warnIfOutside(
+  cwd: string,
+  dir: string | undefined,
+  label: string,
+): void {
+  if (dir) {
+    const normalizedCwd = normalize(cwd);
+    const normalizedDir = normalize(dir);
+    const relDir = relative(normalizedCwd, normalizedDir);
+
+    if (relDir.startsWith('..')) {
+      logger.warn(
+        `The resolved ${label} ${color.cyan(normalizedDir)} is outside the project root ${color.cyan(normalizedCwd)}, please check your tsconfig file.`,
+      );
+    }
+  }
+}

pnpm-lock.yaml

@@ -0,0 +1,6 @@
+{
+  "name": "dts-check-outdise-root-test",
+  "version": "1.0.0",
+  "private": true,
+  "type": "module"
+}

tests/integration/dts/check/outside-root/package.json

@@ -0,0 +1,10 @@
+import { defineConfig } from '@rslib/core';
+import { generateBundleEsmConfig } from 'test-helper';
+
+export default defineConfig({
+  lib: [
+    generateBundleEsmConfig({
+      dts: true,
+    }),
+  ],
+});

tests/integration/dts/check/outside-root/rslib.config.ts

@@ -0,0 +1 @@
+export const foo = 'foo';

tests/integration/dts/check/outside-root/src/index.ts

@@ -0,0 +1,9 @@
+{
+  "extends": "../tsconfig/declarationDir.json",
+  "compilerOptions": {
+    "baseUrl": "./",
+    "rootDir": "src",
+    "composite": true
+  },
+  "include": ["src"]
+}

tests/integration/dts/check/outside-root/tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "declarationDir": "dist"
+  }
+}

tests/integration/dts/check/tsconfig/declarationDir.json

@@ -1,5 +1,5 @@
 import { existsSync } from 'node:fs';
-import { join } from 'node:path';
+import { join, normalize } from 'node:path';
 import stripAnsi from 'strip-ansi';
 import {
   buildAndGetResults,
@@ -607,3 +607,31 @@ describe('use with other features', async () => {
     `);
   });
 });
+
+describe('check tsconfig.json field', async () => {
+  test('check whether declarationDir is resolved outside from project root', async () => {
+    const fixturePath = join(__dirname, 'check', 'outside-root');
+    const { logs, restore } = proxyConsole();
+    const { files } = await buildAndGetResults({
+      fixturePath,
+      type: 'dts',
+    });
+    const logStrings = logs.map((log) => stripAnsi(log));
+    restore();
+
+    const expectDeclarationDir = normalize(
+      join(__dirname, 'check/tsconfig/dist'),
+    );
+    const expectRoot = normalize(join(__dirname, 'check/outside-root'));
+
+    expect(
+      logStrings.some((log) =>
+        log.includes(
+          `The resolved declarationDir ${expectDeclarationDir} is outside the project root ${expectRoot}, please check your tsconfig file.`,
+        ),
+      ),
+    ).toEqual(true);
+
+    expect(files.esm).toMatchInlineSnapshot('undefined');
+  });
+});