docs: update SWC React options type#5279
Merged
chenjiahan merged 1 commit intomainfrom May 20, 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 updates the React plugin documentation to align with the latest SWC options type, removing a deprecated field and expanding the refresh option syntax.
- Renamed the interface from
SwcReactOptionstoReactConfig. - Removed the deprecated
useBuiltinsoption. - Expanded
refreshto accept either a boolean or an object withrefreshReg,refreshSig, andemitFullSignatures.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| website/docs/zh/plugins/list/plugin-react.mdx | Renamed interface, removed useBuiltins, updated refresh type in Chinese docs |
| website/docs/en/plugins/list/plugin-react.mdx | Renamed interface, removed useBuiltins, updated refresh type in English docs |
Comments suppressed due to low confidence (2)
website/docs/zh/plugins/list/plugin-react.mdx:42
- [nitpick] The interface name
ReactConfigmay be too generic; consider a more specific name likeSwcReactConfigor add a clarifying comment to prevent confusion with other React configs.
interface ReactConfig {
website/docs/en/plugins/list/plugin-react.mdx:42
- [nitpick] The interface name
ReactConfigmay be too generic; consider a more descriptive name likeSwcReactConfigor add a note explaining its context.
interface ReactConfig {
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
Update SWC React options type to match the latest implementation.
Ref: https://github.com/swc-project/swc/blob/883b24c6248fecb223693974951080889bd8827a/packages/types/index.ts#L878-L949
Removed the deprecated
useBuiltinsoption, see web-infra-dev/rspack#10410Checklist