Skip to content

feat(dts): support using output.distPath as dts emit path #1269

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 15, 2025
Merged

feat(dts): support using output.distPath as dts emit path #1269

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/plugin-dts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ The output directory of declaration files. The default value follows the priorit

1. The `distPath` value of the plugin options.
2. The `declarationDir` value in the `tsconfig.json` file.
3. The [output.distPath.root](https://rsbuild.rs/config/output/dist-path) value of Rsbuild configuration.
3. The [output.distPath](https://rsbuild.rs/config/output/dist-path) or [output.distPath.root](https://rsbuild.rs/config/output/dist-path) value of Rsbuild configuration.

```js
pluginDts({
Expand Down
2 changes: 1 addition & 1 deletion packages/plugin-dts/src/dts.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ export async function generateDts(data: DtsGenOptions): Promise<void> {
throw Error(
`Please set "declarationDir": "${dtsEmitPath}" in ${color.underline(
tsconfigPath,
)} to keep it same as "dts.distPath" or "output.distPath.root" field in lib config.`,
)} to keep it same as "dts.distPath" or "output.distPath" field in lib config.`,
);
}
}
Expand Down
7 changes: 6 additions & 1 deletion packages/plugin-dts/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,10 +144,15 @@ export const pluginDts = (options: PluginDtsOptions = {}): RsbuildPlugin => ({
const { options: rawCompilerOptions } = tsConfigResult;
const { declarationDir, outDir, composite, incremental } =
rawCompilerOptions;
const distPathRoot =
typeof config.output?.distPath === 'string'
? config.output?.distPath
: config.output?.distPath.root;

const dtsEmitPath = getDtsEmitPath(
options.distPath,
declarationDir,
config.output?.distPath?.root,
distPathRoot,
);

// check whether declarationDir or outDir is outside from current project
Expand Down
6 changes: 3 additions & 3 deletions packages/plugin-dts/src/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -655,14 +655,14 @@ export async function cleanTsBuildInfoFile(
}
}

// the priority of dtsEmitPath is dts.distPath > declarationDir > output.distPath.root
// the priority of dtsEmitPath is dts.distPath > declarationDir > output.distPath > output.distPath.root
// outDir is not considered since in multiple formats, the dts files may not in the same directory as the js files
export function getDtsEmitPath(
pathFromPlugin: string | undefined,
declarationDir: string | undefined,
distPath: string,
distPathRoot: string,
): string {
return pathFromPlugin ?? declarationDir ?? distPath;
return pathFromPlugin ?? declarationDir ?? distPathRoot;
}

export function warnIfOutside(
Expand Down
2 changes: 1 addition & 1 deletion website/docs/en/config/lib/dts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ The default value follows the priority below:

1. The `dts.distPath` value in the current lib configuration.
2. The `declarationDir` value in the `tsconfig.json` file.
3. The [output.distPath.root](/config/rsbuild/output#outputdistpath) value in the current lib configuration.
3. The [output.distPath](/config/rsbuild/output#outputdistpath) or [output.distPath.root](/config/rsbuild/output#outputdistpath) value in the current lib configuration.

#### Example

Expand Down
2 changes: 1 addition & 1 deletion website/docs/en/guide/advanced/dts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ The priority from highest to lowest of final output directory of declaration fil

- The configuration option [dts.distPath](/config/lib/dts#dtsdistpath)
- The configuration option `declarationDir` in `tsconfig.json`
- The configuration option [output.distPath.root](/config/rsbuild/output#outputdistpath)
- The configuration option [output.distPath](/config/rsbuild/output#outputdistpath) or [output.distPath.root](/config/rsbuild/output#outputdistpath)

## Related configuration of declaration files

Expand Down
2 changes: 1 addition & 1 deletion website/docs/zh/config/lib/dts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ export default {

1. 当前 lib 配置中的 `dts.distPath` 值。
2. `tsconfig.json` 文件中的 `declarationDir` 值。
3. 当前 lib 配置中的 [output.distPath.root](/config/rsbuild/output#outputdistpath) 值。
3. 当前 lib 配置中的 [output.distPath](/config/rsbuild/output#outputdistpath) 值或 [output.distPath.root](/config/rsbuild/output#outputdistpath) 值。

#### 示例

Expand Down
2 changes: 1 addition & 1 deletion website/docs/zh/guide/advanced/dts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ API](https://github.com/microsoft/TypeScript/wiki/Using-the-Compiler-API) 或 [t

- [dts.distPath](/config/lib/dts#dtsdistpath) 配置项
- `tsconfig.json` 中的 `declarationDir` 配置项
- [output.distPath.root](/config/rsbuild/output#outputdistpath) 配置项
- [output.distPath](/config/rsbuild/output#outputdistpath) 或 [output.distPath.root](/config/rsbuild/output#outputdistpath) 配置项

## 类型声明文件的相关配置

Expand Down
Loading