-
-
Notifications
You must be signed in to change notification settings - Fork 58
docs: add resolve field of Rsbuild config
#517
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.
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
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,5 @@ | ||
| [ | ||
| "resolve", | ||
| "source", | ||
| "output", | ||
| "tools", | ||
|
|
||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| import { RsbuildDocBadge } from '@components/RsbuildDocBadge'; | ||
|
|
||
| # resolve | ||
|
|
||
| ## resolve.aliasStrategy <RsbuildDocBadge path="/config/resolve/alias-strategy" text="resolve.aliasStrategy" /> | ||
|
|
||
| `resolve.aliasStrategy` is used to control the priority between the `paths` option in `tsconfig.json` and the `alias` option in the bundler. | ||
|
|
||
| ## resolve.alias <RsbuildDocBadge path="/config/resolve/alias" text="resolve.alias" /> | ||
|
|
||
| Create aliases to import or require certain modules, same as the [resolve.alias](https://rspack.dev/config/resolve#resolvealias) config of Rspack. | ||
|
|
||
| It is important to note that `resolve.alias` differs from [output.externals](/config/rsbuild/output#outputexternals) in the following ways: | ||
|
|
||
| - `resolve.alias` is used when bundling target code into the product (when [lib.bundle](/config/lib/bundle) is set to `true`). It allows you to replace the target module you want to include in the output with another module. | ||
|
|
||
| For example, if you want to replace `lodash` with `lodash-es` in a bundled CLI application, you can configure it as follows: | ||
|
|
||
| ```ts title="rslib.config.ts" | ||
| export default { | ||
| // ... | ||
| resolve: { | ||
| alias: { | ||
| lodash: 'lodash-es', | ||
| }, | ||
| }, | ||
| }; | ||
| ``` | ||
|
|
||
| All `lodash` modules imported in the source code will be mapped to `lodash-es` and be bundled into the output. | ||
|
|
||
| - `output.externals` is used to handle alias mapping for externalized modules. Externalized modules are not included in the bundle; instead, they are imported from external sources at runtime. | ||
|
|
||
| For example, if you want to replace `react` and `react-dom` with `preact/compat` in the bundle, you can configure it as follows: | ||
|
|
||
| ```ts title="rslib.config.ts" | ||
| export default { | ||
| // ... | ||
| output: { | ||
| externals: { | ||
| react: 'preact/compat', | ||
| 'react-dom': 'preact/compat', | ||
| }, | ||
| }, | ||
| }; | ||
| ``` | ||
|
|
||
| Now, the code `import { useState } from 'react'` will be replaced with `import { useState } from 'preact/compat'`. | ||
|
|
||
| ## resolve.dedupe <RsbuildDocBadge path="/config/resolve/dedupe" text="resolve.dedupe" /> | ||
|
|
||
| `resolve.dedupe` is used to resolve the specified packages from project root, which is useful for deduplicating packages and reducing the bundle size. | ||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,5 @@ | ||
| [ | ||
| "resolve", | ||
| "source", | ||
| "output", | ||
| "tools", | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| # resolve |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.