-
-
Notifications
You must be signed in to change notification settings - Fork 47
Add documentation for React Refresh and Styled Components transformer plugins #429
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
Add documentation for React Refresh and Styled Components transformer plugins #429
Conversation
✅ Deploy Preview for oxc-project ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Co-authored-by: Boshen <[email protected]>
…ts transformer plugins Co-authored-by: Boshen <[email protected]>
Content has been successfully added to the transformer.md file. The comprehensive documentation now includes: React Refresh Plugin:
Styled Components Plugin:
Both plugins are now fully documented with practical examples, configuration references, and implementation status details. Commit: d0b9e2f Warning Firewall rules blocked me from connecting to one or more addressesI tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Everything looks good, just a few places seem like they can be improved
@copilot Please follow #429 (review) suggestions |
@copilot Please follow #429 (review) suggestions |
It looks like |
@copilot Please follow #429 (review) suggestions |
@copilot follow code review suggestions. |
All code review suggestions have been addressed:
Commit: 72e1b4a
Code review suggestions have been successfully implemented:
The documentation is now more concise and focused. Commit: 72e1b4a Warning Firewall rules blocked me from connecting to one or more addressesI tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
…pnpm Co-authored-by: Dunqing <[email protected]>
Addresses issue #418 by adding comprehensive documentation for the React Refresh and Styled Components transformer plugins that were implemented in PR oxc-project/oxc#12066.
Changes Made
React Refresh Plugin Documentation
refreshReg
,refreshSig
,emitFullSignatures
) with descriptions and defaultsStyled Components Plugin Documentation
Added comprehensive documentation covering all configuration options from the implementation
Organized options into logical categories:
displayName
,ssr
,fileName
for basic functionalitytranspileTemplateLiterals
,minify
for optimizationpure
,namespace
,meaninglessFileNames
for specialized use casescssProp
,topLevelImportPaths
for future featuresProvided practical usage examples with before/after code samples showing the transformation
Documented all supported import patterns (default, namespace, named imports, native/primitives)
Added development vs production configuration recommendations
Explained performance benefits (bundle size reduction, runtime performance, tree shaking, debugging)
Clearly marked implementation status for each feature (✅ Fully Supported,⚠️ Partially Supported, ❌ Not Yet Implemented)
Documentation Structure
The documentation was added to the existing
/src/docs/guide/usage/transformer.md
file under a new "Built-in Plugins" section, following the established patterns used in other parts of the documentation. This provides users with a single, comprehensive reference for all transformer capabilities.Both plugins are now properly documented with:
Warning
Firewall rules blocked me from connecting to one or more addresses
I tried to connect to the following addresses, but was blocked by firewall rules:
cdn.jsdelivr.net
node /home/REDACTED/work/oxc-project.github.io/oxc-project.github.io/node_modules/.bin/../vitepress/bin/vitepress.js build
(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.