docs: add section on vite-tsconfig-paths support#5593
Merged
chenjiahan merged 1 commit intomainfrom Jul 14, 2025
Merged
Conversation
✅ Deploy Preview for rsbuild ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds a new section in the migration guide to highlight that Rsbuild offers built-in support for TypeScript paths aliases, allowing users to remove the vite-tsconfig-paths plugin.
- Introduce a vite-tsconfig-paths section in both Chinese and English docs
- Explain that Rsbuild natively supports TS
pathsaliases - Link to the advanced path alias guide for more details
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| website/docs/zh/guide/migration/vite.mdx | Added Chinese section on built-in TS paths alias support and removal of the plugin. |
| website/docs/en/guide/migration/vite.mdx | Added English section on built-in TS paths alias support and removal of the plugin. |
Comments suppressed due to low confidence (2)
website/docs/zh/guide/migration/vite.mdx:259
- [nitpick] “alias 别名”存在冗余，可考虑删除其中一个以提升可读性，例如改为 “…支持 TypeScript 的
paths选项作为别名”。
Rsbuild 开箱即用地支持 TypeScript 的 `paths` 选项作为 alias 别名，因此你可以直接移除 `vite-tsconfig-paths` 依赖。
website/docs/en/guide/migration/vite.mdx:259
- [nitpick] 建议将 “as alias” 修改为复数形式或更清晰的表达，例如: “Rsbuild has built-in support for TypeScript
pathsaliases, so you can remove thevite-tsconfig-pathsdependency.”
Rsbuild supports TypeScript's `paths` option as alias out of the box, so you can remove the `vite-tsconfig-paths` dependency directly.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Provide information about Rsbuild's built-in support for TypeScript path aliases and the removal of the
vite-tsconfig-pathsdependency.Checklist