docs: explain how resolve.alias affects package resolution
#11799
Conversation
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
github-actions
bot
added
release: document
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation warnings in both English and Chinese about the risks of using alias to directly point to packages in monorepo or node_modules. The warning explains how this practice can break normal module resolution logic and provides better alternatives.
- Added warning sections explaining why alias shouldn't directly target monorepo or node_modules packages
- Documented the technical consequences of bypassing package resolution mechanisms
- Provided recommendations to use package manager workspace features instead
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| website/docs/zh/config/resolve.mdx | Added Chinese warning documentation about alias misuse |
| website/docs/en/config/resolve.mdx | Added English warning documentation about alias misuse |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
✅ Deploy Preview for rspack ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
SyMind
force-pushed
the
warning-for-alias
branch
from
400dab2 to
04e8cd8
Compare
JSerFeng
reviewed
Sep 30, 2025
SyMind
force-pushed
the
warning-for-alias
branch
from
04e8cd8 to
e9b6c25
Compare
JSerFeng
previously approved these changes
Sep 30, 2025
SyMind
force-pushed
the
warning-for-alias
branch
from
e9b6c25 to
91b0d0a
Compare
chenjiahan
reviewed
Sep 30, 2025
SyMind
force-pushed
the
warning-for-alias
branch
from
f4e4404 to
f4d2c17
Compare
chenjiahan
changed the title
resolve.alias affects package resolution
chenjiahan
previously approved these changes
Sep 30, 2025
chenjiahan
reviewed
Sep 30, 2025
chenjiahan
approved these changes
Sep 30, 2025
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
Adds documentation about how
resolve.aliasaffects package resolution, clarify the difference between default package resolution and aliased paths, especially in monorepo scenarios, and recommend best practices for maintaining standard package resolution behavior.Related links
web-infra-dev/rsbuild#5311
Checklist