feat(core): simplify config option of createRsbuild#6245
Merged
chenjiahan merged 1 commit intomainfrom Sep 24, 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 simplifies the configuration option name for createRsbuild by introducing config as a more concise alternative to the existing rsbuildConfig option. The change maintains backward compatibility by keeping both options available, with rsbuildConfig marked for future deprecation.
- Adds a new
configoption toCreateRsbuildOptionsinterface - Updates the internal implementation to prefer
configoverrsbuildConfigusing nullish coalescing - Updates CLI initialization to use the new
configoption
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| packages/core/src/types/rsbuild.ts | Adds the new config option and marks rsbuildConfig as deprecated |
| packages/core/src/createRsbuild.ts | Updates implementation to support both options with preference for config |
| packages/core/src/cli/init.ts | Updates CLI to use the new config option |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
2 tasks
Merged
This was referenced Nov 4, 2025
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
I originally named the configuration option for
createRsbuildasrsbuildConfigto make it clear that it was specific to Rsbuild (and not Rspack or other tools).Over time, though, I realized the name is unnecessarily long—especially in e2e tests where I have to type
rsbuildConfigrepeatedly.This PR shortens it to
configfor simplicity. The oldrsbuildConfigname will still work for now but is planned for deprecation in the future.Checklist