Add --rspack generator option for faster builds #1852
Conversation
WalkthroughAdds an --rspack option to the React on Rails generators, updates install flow to add Rspack dev/runtime dependencies, applies Rspack+SWC settings to Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant Dev as Developer
participant InstallGen as react_on_rails:install
participant BaseGen as BaseGenerator
participant FS as Filesystem
participant PkgMgr as Package Manager
Dev->>InstallGen: run generator (--rspack)
InstallGen->>InstallGen: choose deps (Rspack vs Webpack)
InstallGen->>PkgMgr: install selected deps/devDeps
InstallGen->>BaseGen: invoke with rspack: true
BaseGen->>FS: copy templates
BaseGen->>FS: update config/shakapacker.yml (assets_bundler/webpack_loader)
BaseGen-->>Dev: generation finished
sequenceDiagram
autonumber
participant Dev as Developer
participant Script as bin/switch-bundler
participant FS as Filesystem
participant PkgMgr as Package Manager
Dev->>Script: bin/switch-bundler rspack|webpack
Script->>Script: validate target
Script->>FS: update shakapacker.yml
Script->>FS: update package.json deps/devDeps
Script->>PkgMgr: detect npm|yarn|pnpm
Script->>PkgMgr: run install command
Script-->>Dev: print next steps
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Files/areas to focus review on:
Possibly related issues
Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (10)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Code Review: Add --rspack generator option for faster buildsSummaryThis PR adds a --rspack flag to enable Rspack bundler support. Overall, this is a well-structured and valuable feature that follows existing patterns. However, there are several issues that need to be addressed before merging. Critical Issues1. Security Vulnerability: YAML.load_file usageLocation: lib/generators/react_on_rails/templates/base/base/bin/switch-bundler:50 YAML.load_file is unsafe and can execute arbitrary code. Use YAML.safe_load_file instead with permitted_classes parameter. 2. Missing JSON requireLocation: lib/generators/react_on_rails/templates/base/base/bin/switch-bundler:73 The script uses JSON.parse but doesn't require the JSON library. Add require json at the top. 3. Fragile Regex-Based YAML ManipulationLocation: lib/generators/react_on_rails/base_generator.rb:416-418 The regex assumes source_path is always the first key after default: and will fail silently if the YAML structure is different. Better approach: Parse YAML, modify the hash, and write it back using YAML.safe_load_file. 4. Inconsistent YAML HandlingThe switch-bundler script properly parses YAML but base_generator.rb uses regex string manipulation. This inconsistency is error-prone. High Priority Issues5. Missing Test CoverageI searched the spec directory and found NO tests for the new --rspack flag. The existing generator has comprehensive tests for --redux and --typescript, so this feature should have similar coverage including:
6. No Validation of Existing assets_bundler SettingThe code checks if assets_bundler exists but doesn't handle the case where it is already set to something else. The gsub on line 422 will replace ALL webpack_loader occurrences, potentially breaking existing configuration. 7. Missing Error Handling in switch-bundlerThe script aborts after installing dependencies but before dev dependencies, leaving the system in an inconsistent state if the first command succeeds but the second fails. Suggestions8. Code Quality: DuplicationThe pattern for installing dependencies is repeated multiple times. Consider extracting to a helper method. 9. User Experience: Add Warning When SwitchingThe switch-bundler script should warn users about potential breaking changes and ask for confirmation. 10. Documentation: Missing CHANGELOG EntryA feature of this significance should have a CHANGELOG entry. What is Done Well
Priority RecommendationsMust fix before merge:
Should fix before merge: Great work on this feature! The performance improvements from Rspack are significant. Please address the critical security and testing issues before merging. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
RSPACK_IMPLEMENTATION.md(1 hunks)lib/generators/react_on_rails/base_generator.rb(3 hunks)lib/generators/react_on_rails/install_generator.rb(4 hunks)lib/generators/react_on_rails/templates/base/base/bin/switch-bundler(1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
{Gemfile,Rakefile,config.ru,**/*.{rb,rake,gemspec,ru}}
📄 CodeRabbit inference engine (CLAUDE.md)
{Gemfile,Rakefile,config.ru,**/*.{rb,rake,gemspec,ru}}: All Ruby code must pass RuboCop with zero offenses before commit/push
RuboCop is the sole authority for Ruby file formatting; never manually format Ruby files
Files:
lib/generators/react_on_rails/install_generator.rblib/generators/react_on_rails/base_generator.rb
**/*.{js,jsx,ts,tsx,css,scss,json,yml,yaml,md}
📄 CodeRabbit inference engine (CLAUDE.md)
Prettier is the sole authority for formatting all non-Ruby files; never manually format them
Files:
RSPACK_IMPLEMENTATION.md
🧬 Code graph analysis (2)
lib/generators/react_on_rails/install_generator.rb (2)
lib/generators/react_on_rails/generator_helper.rb (1)
add_npm_dependencies(23-39)lib/generators/react_on_rails/base_generator.rb (2)
handle_npm_failure(248-260)add_dev_dependencies(207-217)
lib/generators/react_on_rails/base_generator.rb (1)
lib/react_on_rails/packer_utils.rb (1)
shakapacker_version(15-19)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (12)
- GitHub Check: dummy-app-integration-tests (3.2, 20)
- GitHub Check: dummy-app-integration-tests (3.4, 22)
- GitHub Check: claude-review
- GitHub Check: rspec-package-tests (3.4, latest)
- GitHub Check: rspec-package-tests (3.4, minimum)
- GitHub Check: rspec-package-tests (3.2, latest)
- GitHub Check: rspec-package-tests (3.2, minimum)
- GitHub Check: examples (3.2, minimum)
- GitHub Check: examples (3.4, latest)
- GitHub Check: markdown-link-check
- GitHub Check: build
- GitHub Check: build-and-test
🔇 Additional comments (15)
lib/generators/react_on_rails/base_generator.rb (2)
22-26: LGTM!The rspack option follows the established pattern for generator options and is clearly documented.
91-91: LGTM!The conditional calls to
configure_rspack_in_shakapackerare correctly placed to handle both fresh Shakapacker installations and existing configurations.Also applies to: 99-99
RSPACK_IMPLEMENTATION.md (1)
1-141: LGTM!The documentation is comprehensive, accurate, and well-structured. It clearly explains the implementation, usage, configuration changes, and benefits of the rspack option.
lib/generators/react_on_rails/install_generator.rb (5)
31-35: LGTM!The rspack option definition is consistent with other generator options and clearly documented.
82-83: LGTM!The rspack option is correctly propagated to the base generator alongside other options.
434-434: LGTM!The conditional call to
add_rspack_dependenciesis correctly placed in the dependency installation flow.
500-514: LGTM!The
add_rspack_dependenciesmethod follows the established pattern for dependency installation with proper error handling and fallback mechanisms.
516-538: Do not update BaseGenerator for rspack logicInstallGenerator defines and uses its own add_dev_dependencies (and does not inherit from BaseGenerator), so BaseGenerator’s hard-coded Webpack deps aren’t invoked here.
Likely an incorrect or invalid review comment.
lib/generators/react_on_rails/templates/base/base/bin/switch-bundler (7)
9-17: LGTM!The dependency constants accurately reflect the packages needed for each bundler and match the documented dependencies in RSPACK_IMPLEMENTATION.md.
19-44: LGTM!The initialization and validation logic is straightforward and provides clear error messages for invalid input.
46-61: LGTM!The YAML configuration update uses proper parsing with
YAML.load_fileandYAML.dump, which is more robust than string manipulation. This is the correct approach.
64-87: LGTM!The dependency removal logic correctly identifies and removes the opposing bundler's packages from both dependencies and devDependencies, with appropriate error handling.
91-123: LGTM!The dependency installation logic correctly detects the package manager and constructs appropriate commands for each, with proper error handling.
126-131: LGTM!The package manager detection logic is consistent with the pattern used in the install generator.
135-143: LGTM!The main execution block provides clear usage instructions and properly invokes the bundler switcher.
Code Review: PR #1852 - Add --rspack generator option for faster builds📋 SummaryThis PR adds Rspack bundler support to React on Rails generators, providing a faster alternative to Webpack. The implementation is well-structured and follows existing patterns, but there are several areas that need attention before merging. ✅ Strengths
🔴 Critical Issues1. Missing rspack option in install_generator.rb line 127File: invoke "react_on_rails:base", [], { typescript: options.typescript?, redux: options.redux? }This line is missing the Expected: invoke "react_on_rails:base", [],
{ typescript: options.typescript?, redux: options.redux?, rspack: options.rspack? }Impact: HIGH - The rspack option won't work without this fix 2. Missing rspack class option declarationFile: The diff shows adding the Expected (after line 29): # --rspack
class_option :rspack,
type: :boolean,
default: false,
desc: "Use Rspack instead of Webpack as the bundler. Default: false"Impact: HIGH - Without this declaration, the 3. Missing rspack option in base_generator.rbFile: The diff shows adding the rspack class option at lines 22-26, but the actual file only shows the redux option at lines 15-20. The rspack option is missing entirely. Expected (after line 20): # --rspack
class_option :rspack,
type: :boolean,
default: false,
desc: "Use Rspack instead of Webpack as the bundler"Impact: HIGH - Base generator won't recognize the rspack option 4. Missing configure_rspack_in_shakapacker methodFile: The method Impact: CRITICAL - This will cause immediate runtime errors 5. Missing rspack dependency installationFile: The add_react_on_rails_package
add_react_dependencies
add_css_dependencies
add_dev_dependenciesExpected (add after line 477): add_rspack_dependencies if options.rspack?Impact: HIGH - Rspack dependencies won't be installed 6. Missing add_rspack_dependencies methodFile: The Impact: CRITICAL - Method not found error when rspack option is used 7. add_dev_dependencies not updated for rspackFile: The current implementation always installs webpack dependencies, but according to the diff (lines 515-534), it should conditionally install rspack OR webpack dependencies based on the flag. Current: dev_deps = %w[
@pmmmwh/react-refresh-webpack-plugin
react-refresh
]Expected: dev_deps = if options.rspack?
%w[
@rspack/cli
@rspack/plugin-react-refresh
react-refresh
]
else
%w[
@pmmmwh/react-refresh-webpack-plugin
react-refresh
]
endImpact: HIGH - Will install wrong dependencies
|
Code Review for PR #1852: Add --rspack generator optionI've reviewed this PR and here's my comprehensive feedback: ✅ Strengths
🐛 Potential Issues1. YAML Regex Pattern Issue (base_generator.rb:416-418)The regex assumes source_path is always the first line after default: &default, which may not be true. Recommendation: Use YAML parsing instead of regex for safer manipulation. 2. Missing Error Handling (base_generator.rb:404-426)The configure_rspack_in_shakapacker method doesn't handle cases where the regex match fails, YAML structure is unexpected, or file write operations fail. 3. Incomplete JSON Require (bin/switch-bundler:72)Missing require 'json' at the top of the file. 4. Webpack Dependencies Still InstalledWhen using --rspack, the code doesn't prevent webpack dependencies from being installed by Shakapacker. 🧪 Test Coverage ConcernsCRITICAL: No automated tests were added for the new --rspack option. Tests should be added to spec/react_on_rails/generators/install_generator_spec.rb similar to existing tests for --redux and --typescript. 🎯 Before MergingPer CLAUDE.md requirements:
SummaryThis is a solid implementation that follows the project's conventions well. Main concerns:
Once tests are added and the YAML handling is improved, this will be ready to merge! 🤖 Generated with Claude Code |
justin808
force-pushed
the
justin808/rspack-generator-option
branch
from
0cee9aa to
5006113
Compare
Pull Request Review: Add --rspack generator optionSummaryThis PR adds support for Rspack bundler as an alternative to Webpack. The implementation is well-structured and follows existing patterns. Overall, this is a solid contribution with good documentation. Strengths
Critical Issues1. Missing JSON require in switch-bundler (line 73)
2. Regex fragility in configure_rspack_in_shakapacker (base_generator.rb:416-418)
3. Code duplication
Medium Priority Issues4. Missing test coverage
5. Defensive plugin loading
Security & Performance
Action Items Before MergeMust Fix:
Should Fix:
Overall AssessmentRating: Strong Approve (after addressing critical issues) Well-designed feature with clear value. The two critical issues must be fixed but are straightforward. Once addressed this will be a great addition. Generated with Claude Code |
Code Review for PR 1852I have reviewed this PR implementing the rspack option. This is a well-structured implementation. Strengths
Critical IssuesMissing JSON Require - HIGH PRIORITYbin/switch-bundler uses JSON.parse without requiring json library No Test Coverage - HIGH PRIORITYNo automated tests included for rspack option File Permissions - MEDIUMbin/switch-bundler needs executable permissions RecommendationsAdd automated tests for:
Priority fixes: JSON require, executable permissions, test coverage Overall solid implementation - request changes for critical fixes then approve. |
Code Review: Rspack Generator OptionThis is a well-structured PR. Here is my review: Strengths
Critical Issues1. YAML Regex Fragility (base_generator.rb:416-418)The regex pattern for inserting assets_bundler is brittle and assumes source_path is always first. Use YAML parser instead for reliability. 2. Switch-Bundler Script Lacks Safety (bin/switch-bundler:87-121)Script modifies package.json without backup or rollback. Add backup before modification. Medium Priority Issues
Low Priority Issues
SecurityGood security practices overall. Consider validating package manager exists before running system commands. Test CoverageExcellent coverage for main scenarios. Missing: --rspack --redux tests, shakapacker.yml YAML validation, switch-bundler functionality tests, error handling tests. SummaryHigh-quality work! Main recommendation: Address YAML parsing fragility before merging. Other issues can be follow-ups. Review following CLAUDE.md guidelines. |
Code Review - PR #1852: Add --rspack generator optionOverall, this is a well-structured implementation that adds Rspack support. The code follows existing patterns and provides good documentation. Strengths
Critical Issues - Must Fix Before Merge1. Missing require json in switch-bundler 2. Command injection vulnerability in switch-bundler 3. YAML formatting issue Additional Suggestions
VerdictGreat work! The unified config approach is well thought out. Please address the 3 critical security/bug issues above before merging. |
justin808
force-pushed
the
justin808/rspack-generator-option
branch
from
4aa0506 to
71c1758
Compare
justin808
force-pushed
the
justin808/rspack-generator-option
branch
from
71c1758 to
5059912
Compare
Code Review: Add --rspack generator option for faster buildsOverall AssessmentVerdict: ✅ Excellent implementation with strong attention to detail This PR successfully implements Rspack bundler support with thoughtful architecture, comprehensive testing, and good security practices. The code quality is high and follows the repository's conventions well. 🎯 Strengths1. Security Best Practices ✅
2. Unified Configuration Approach ✅The webpack config templates elegantly support both bundlers with dynamic bundler loading 3. Comprehensive Test Coverage ✅19 new test examples covering basic --rspack flag, TypeScript combination, dependency verification, and configuration generation 4. Excellent Documentation ✅Clear RSPACK_IMPLEMENTATION.md with implementation details, inline comments, and usage examples 5. Clean Code Quality ✅Follows RuboCop conventions (zero offenses) with proper error handling 💡 Code Quality ObservationsWell-Designed Features
Minor Considerations1. YAML Formatting Preservation (base_generator.rb:404-426)The regex-based YAML manipulation could be fragile if source_path has different whitespace or YAML structure changes. Suggestion: Consider adding test cases for YAML edge cases or document assumptions. 2. YAML.load_file Security (switch-bundler:51)Ruby 3.1+ recommends YAML.safe_load_file, but current approach is acceptable for local config files. 3. Trailing Newline VerificationPer CLAUDE.md: Ensure all new files have trailing newlines (git hooks should catch this). 4. Error HandlingLines 414-419: Consider logging a warning if regex substitution fails. 🔒 Security Review✅ Secure Practices
No Security Concerns Identified⚡ Performance Considerations
🧪 Test Coverage AssessmentExcellent Coverage ✅
Potential Additional Tests
📋 Checklist Review
🎯 RecommendationsBefore Merge
Future Enhancements
📊 Summary
✅ Final VerdictReady to merge after:
The implementation is well-thought-out, secure, and provides significant value. Great work on the unified configuration approach! 🎉 Review conducted following CLAUDE.md guidelines and repository conventions. 🤖 Generated with Claude Code |
justin808
force-pushed
the
justin808/rspack-generator-option
branch
2 times, most recently
from
0e33ff1 to
814746d
Compare
Implements --rspack flag for react_on_rails:install generator to use Rspack bundler instead of Webpack, providing ~20x faster builds. ## Changes - Added --rspack option to install_generator.rb and base_generator.rb - Conditional dependency installation (rspack vs webpack packages) - Auto-configures shakapacker.yml for rspack with SWC transpiler - Created bin/switch-bundler utility to switch bundlers post-install ## Key Features - Rspack packages: @rspack/core, @rspack/cli, @rspack/plugin-react-refresh - Compatible with --typescript and --redux options - Reversible via bin/switch-bundler script - Supports npm, yarn, and pnpm package managers ## Usage rails generate react_on_rails:install --rspack bin/switch-bundler rspack # Switch existing app Based on patterns from react_on_rails-demos PR #20 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Implements unified configuration approach where the same webpack config files work with both webpack and rspack bundlers, based on the assets_bundler setting in shakapacker.yml. ## Changes **development.js.tt**: - Add config import from shakapacker to access assets_bundler setting - Conditional React Refresh plugin loading: - Rspack: @rspack/plugin-react-refresh - Webpack: @pmmmwh/react-refresh-webpack-plugin - Prevents "window not found" errors when using rspack **serverWebpackConfig.js.tt**: - Replace hardcoded webpack require with bundler variable - Bundler conditionally requires @rspack/core or webpack - Use bundler.optimize.LimitChunkCountPlugin instead of webpack-specific - Eliminates warnings about webpack when using rspack **RSPACK_IMPLEMENTATION.md**: - Document webpack config template changes - Explain unified configuration approach ## Benefits - Single set of config files works for both bundlers - No warnings when using rspack about webpack.config.js - Seamless switching between bundlers via bin/switch-bundler - Follows pattern from react_on_rails-demos PR #20 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Adds comprehensive test coverage for the --rspack generator option: ## New Test Contexts **with --rspack**: - Verifies base generator and non-redux generator behavior - Tests bin/switch-bundler script creation - Validates rspack dependencies in package.json - Ensures webpack dependencies are NOT installed - Checks unified webpack config with bundler detection - Verifies server webpack config uses bundler variable **with --rspack --typescript**: - Tests combination of rspack and typescript options - Verifies TypeScript component file creation (.tsx) - Validates tsconfig.json generation - Checks both rspack and typescript dependencies installed - Ensures TypeScript typing is correct ## Test Coverage 19 new examples added, all passing: - Dependency management (rspack vs webpack packages) - Webpack configuration templates (bundler detection) - TypeScript integration with rspack - bin/switch-bundler utility script ## Validation All specs pass successfully with 0 failures. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
## Critical Fixes
1. **Add missing require "json"**
- File: bin/switch-bundler
- Issue: Script uses JSON.parse without requiring json library
- Fix: Added `require "json"` at the top
2. **Fix command injection vulnerability**
- File: bin/switch-bundler (lines 100-122)
- Issue: Using system() with string interpolation is vulnerable
- Fix: Changed to array form for all system() calls
- Before: `system("yarn add #{deps[:dependencies].join(' ')}")`
- After: `system("yarn", "add", *deps[:dependencies])`
3. **YAML formatting preserved**
- File: base_generator.rb
- Already using direct string manipulation (not YAML.dump)
- Preserves formatting and anchors correctly
## Security Impact
The command injection fix prevents potential security vulnerabilities where
malicious package names could execute arbitrary commands. Array form ensures
arguments are properly escaped.
## Testing
- All 19 rspack specs pass (0 failures)
- RuboCop checks pass with zero offenses
- Functionality verified
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
justin808
force-pushed
the
justin808/rspack-generator-option
branch
from
814746d to
4cf8041
Compare
|
@claude review this pr |
|
Claude finished @justin808's task —— View job PR Review: Add --rspack generator option for faster buildsReview Checklist
SummaryThis PR adds Rspack bundler support to React on Rails generators, providing a significantly faster build alternative to Webpack (~20x improvement with SWC). The implementation is well-structured and follows existing patterns consistently. The code quality is high, and the feature is well-tested and documented. Strengths1. Excellent Architecture
2. Security Best Practices
3. Comprehensive Test Coverage
4. Excellent Documentation
5. Performance Benefits
Issues & RecommendationsCritical Issues1. YAML Manipulation Fragility (base_generator.rb:404-426)Severity: Medium-High The Problems:
Recommendation: def configure_rspack_in_shakapacker
shakapacker_config_path = "config/shakapacker.yml"
return unless File.exist?(shakapacker_config_path)
puts Rainbow("🔧 Configuring Shakapacker for Rspack...").yellow
# Parse YAML config
config = YAML.load_file(shakapacker_config_path)
# Update default section
config["default"] ||= {}
config["default"]["assets_bundler"] = "rspack"
config["default"]["webpack_loader"] = "swc"
# Write back as YAML
File.write(shakapacker_config_path, YAML.dump(config))
puts Rainbow("✅ Updated shakapacker.yml for Rspack").green
endThis matches the approach already used in Minor Issues2. Missing Edge Case HandlingSeverity: Low The code doesn't handle the case where Recommendation: 3. Potential YAML Formatting ChangesSeverity: Very Low Using Note: This is acceptable given the trade-off for safety, but worth being aware of. Code Quality ObservationsWhat's Done Well
Style & Conventions
Testing AssessmentTest Coverage: Excellent ✅The test file includes comprehensive coverage:
What's Not TestedWhile coverage is good, consider adding:
Note: These are nice-to-haves, not blockers. Documentation ReviewRSPACK_IMPLEMENTATION.md: Excellent ✅
PR Description: Comprehensive ✅
CLAUDE.md Compliance CheckCritical Requirements from CLAUDE.mdPer the repository guidelines:
CHANGELOG Issue: Per CLAUDE.md lines 50-57:
This is a significant user-visible feature (new Recommendation: Add to CHANGELOG.md under "Unreleased" section: #### [PR 1852](https://github.com/shakacode/react_on_rails/pull/1852) by [justin808](https://github.com/justin808)
- Added `--rspack` flag to `react_on_rails:install` generator for significantly faster builds (~20x improvement with SWC)
- New `bin/switch-bundler` utility to switch between Webpack and Rspack post-installation
- Unified webpack configuration supports both bundlersSecurity Review✅ No Security Concerns Identified
Performance Considerations
Recommendations Before MergeMust Fix
Should Fix
Nice to Have
Final VerdictStatus: ✅ Approve with Minor Changes This is a high-quality implementation that adds significant value to React on Rails. The code is well-structured, secure, tested, and documented. Required Actions:
Why Approve:
The YAML manipulation issue is the only technical concern, and it's relatively minor given that it works correctly in the common case. However, the CHANGELOG entry is required per repository guidelines. Great work on this feature! 🎉 The unified config approach is particularly elegant, and the reversibility via |
## Changes 1. **Add CHANGELOG entry** - Added entry under "Unreleased > Added" section - Documents --rspack flag, performance benefits, and new utilities - Follows CHANGELOG.md format conventions 2. **Fix YAML manipulation fragility in base_generator.rb** - Replaced fragile regex-based string manipulation with proper YAML parsing - Uses YAML.load_file and YAML.dump for safe config updates - Handles edge cases: existing assets_bundler settings, custom configs - Matches the robust approach used in bin/switch-bundler ## Issues Fixed **Before:** - Regex wouldn't update existing assets_bundler (only added if missing) - Assumed specific whitespace formatting - Could break with environment-specific overrides - Silent failures on non-standard formatting **After:** - Properly parses YAML structure - Updates or creates assets_bundler setting correctly - Works with any valid YAML formatting - Handles all edge cases safely ## Testing - All 19 rspack specs pass (0 failures) - RuboCop checks pass (zero offenses) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
## Documentation Updates ### 1. Generator Details (api-reference/generator-details.md) - Added --rspack to generator options list - Added Rspack section in generator description - Created comprehensive "Rspack Support" section covering: - Benefits (~20x faster builds, unified config, easy switching) - What gets installed (packages and configuration) - Switching bundlers post-installation - Combining with other options (TypeScript, Redux) - Link to webpack configuration docs ### 2. Quick Start Guide (getting-started/quick-start.md) - Added --rspack option example in installation step - Added performance tip highlighting 20x improvement - Mentioned bin/switch-bundler utility for later switching ### 3. Webpack Configuration (core-concepts/webpack-configuration.md) - Added new "Rspack vs. Webpack" section covering: - Introduction to Rspack and performance benefits - Usage instructions (generation and switching) - Performance metrics (build times, SWC benefits) - Unified configuration approach with code examples - shakapacker.yml configuration details ## Documentation Structure The documentation is now comprehensive and appears in all appropriate places: - API Reference: Detailed generator option documentation - Getting Started: Quick introduction for new users - Core Concepts: Deep dive into configuration and usage All docs follow existing formatting conventions and include: - Clear code examples - Performance metrics - Cross-references between docs - Practical usage instructions 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
PR Review: Add --rspack generator option for faster buildsI've completed a comprehensive review of this PR. Overall, this is excellent work with a clean implementation that follows the repository's conventions. Here's my detailed feedback: ✅ Strengths1. Code Quality & Best Practices
2. Architecture & Design
3. Testing & Documentation
💡 Suggestions for Improvement1. Minor: Missing
|
| Category | Rating | Notes |
|---|---|---|
| Code Quality | ⭐⭐⭐⭐⭐ | Excellent, follows all conventions |
| Architecture | ⭐⭐⭐⭐⭐ | Smart unified config approach |
| Testing | ⭐⭐⭐⭐☆ | Good coverage, room for integration tests |
| Documentation | ⭐⭐⭐⭐⭐ | Thorough and well-organized |
| Security | ⭐⭐⭐⭐⭐ | No concerns |
| Performance | ⭐⭐⭐⭐⭐ | Significant improvement potential |
✅ Recommendation: APPROVE
This PR is ready to merge. The implementation is solid, well-tested, properly documented, and follows all repository conventions. The suggestions above are minor enhancements that can be addressed in future PRs if desired.
Key Achievement: The unified configuration approach is particularly elegant - it allows seamless switching between bundlers without maintaining separate config files. This is a significant UX improvement.
Great work @justin808! 🎉
📝 Pre-merge Checklist
Before merging, verify:
- CI checks passing ✅ (per PR description test plan)
- All RuboCop offenses resolved ✅ (mentioned in PR description)
- Trailing newlines present ✅ (verified in file reads)
- CHANGELOG.md updated ✅ (verified at line 28)
- No merge conflicts ✅
Review conducted with Claude Code following repository's CLAUDE.md guidelines
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
lib/generators/react_on_rails/install_generator.rb (1)
539-561: CSS minimizer plugin should only install when NOT using Rspack.The
add_css_dependenciesmethod installscss-minimizer-webpack-pluginunconditionally (line 509 of install_generator.rb), but this is webpack-specific. When using--rspack, Rspack has its own CSS minimization and shouldn't use the webpack plugin.Additionally,
base_generator.rbcontainsadd_dev_dependenciesthat only installs@pmmmwh/react-refresh-webpack-pluginwithout any rspack conditional, creating duplicate webpack-only dependencies even when the rspack option is passed to the base generator.Recommended fixes:
- Make
add_css_dependenciesconditional: excludecss-minimizer-webpack-pluginwhenoptions.rspack?- Update
base_generator.rb'sadd_dev_dependenciesto respect the rspack option (or remove duplicate method if install_generator methods should be used)
🧹 Nitpick comments (1)
RSPACK_IMPLEMENTATION.md (1)
1-160: LGTM! Thorough implementation documentation.This document provides excellent coverage of:
- All code changes across generators and templates
- Dependency differences between Webpack and Rspack
- Usage examples and configuration details
- Performance benefits and compatibility notes
The static analysis hints about missing language specifications for fenced code blocks are optional improvements and don't affect the quality of the documentation.
If you want to address the static analysis hints, add language specifiers to the fenced code blocks on lines 7, 64, and 84:
-``` +```text Build times: ~53-270msThis is purely optional and doesn't impact functionality.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (10)
CHANGELOG.md(1 hunks)RSPACK_IMPLEMENTATION.md(1 hunks)docs/api-reference/generator-details.md(3 hunks)docs/core-concepts/webpack-configuration.md(1 hunks)docs/getting-started/quick-start.md(2 hunks)lib/generators/react_on_rails/base_generator.rb(3 hunks)lib/generators/react_on_rails/install_generator.rb(4 hunks)lib/generators/react_on_rails/templates/base/base/bin/switch-bundler(1 hunks)lib/generators/react_on_rails/templates/base/base/config/webpack/development.js.tt(1 hunks)lib/generators/react_on_rails/templates/base/base/config/webpack/serverWebpackConfig.js.tt(2 hunks)
✅ Files skipped from review due to trivial changes (2)
- docs/getting-started/quick-start.md
- docs/api-reference/generator-details.md
🧰 Additional context used
🧠 Learnings (13)
📓 Common learnings
Learnt from: justin808
Repo: shakacode/react_on_rails PR: 1770
File: lib/generators/react_on_rails/templates/base/base/app/javascript/src/HelloWorld/ror_components/HelloWorld.client.jsx:2-2
Timestamp: 2025-09-16T08:01:11.146Z
Learning: React on Rails uses webpack CSS Modules configuration with namedExports: true, which requires the import syntax `import * as style from './file.module.css'` rather than the default export pattern. This configuration enables better tree shaking and bundle size optimization for CSS modules.
Learnt from: AbanoubGhadban
Repo: shakacode/react_on_rails PR: 1745
File: node_package/src/RSCRequestTracker.ts:8-14
Timestamp: 2025-07-08T05:57:29.630Z
Learning: The global `generateRSCPayload` function in React on Rails Pro (RORP) is provided by the framework during rendering requests, not implemented in application code. The `declare global` statements are used to document the expected interface that RORP will inject at runtime.
Learnt from: alexeyr-ci2
Repo: shakacode/react_on_rails PR: 1732
File: spec/dummy/client/app-react16/startup/ReduxSharedStoreApp.client.jsx:40-44
Timestamp: 2025-04-26T21:55:55.874Z
Learning: In the react_on_rails project, files under `app-react16` directories are copied/moved to corresponding `/app` directories during the conversion process (removing the `-react16` suffix), which affects their relative import paths at runtime.
Learnt from: AbanoubGhadban
Repo: shakacode/react_on_rails PR: 1644
File: lib/react_on_rails/helper.rb:190-197
Timestamp: 2025-02-18T13:08:01.477Z
Learning: RSC support validation in React on Rails Pro is handled through a chain of validations:
1. Pro version check in `run_stream_inside_fiber`
2. RSC support check during pack generation via `ReactOnRailsPro.configuration.enable_rsc_support`
3. RSC support validation during component registration
This makes additional validation in the helper methods unnecessary.
📚 Learning: 2025-07-08T05:57:29.630Z
Learnt from: AbanoubGhadban
Repo: shakacode/react_on_rails PR: 1745
File: node_package/src/RSCRequestTracker.ts:8-14
Timestamp: 2025-07-08T05:57:29.630Z
Learning: The global `generateRSCPayload` function in React on Rails Pro (RORP) is provided by the framework during rendering requests, not implemented in application code. The `declare global` statements are used to document the expected interface that RORP will inject at runtime.
Applied to files:
CHANGELOG.mdlib/generators/react_on_rails/templates/base/base/config/webpack/serverWebpackConfig.js.ttdocs/core-concepts/webpack-configuration.mdlib/generators/react_on_rails/templates/base/base/bin/switch-bundlerlib/generators/react_on_rails/base_generator.rblib/generators/react_on_rails/install_generator.rblib/generators/react_on_rails/templates/base/base/config/webpack/development.js.ttRSPACK_IMPLEMENTATION.md
📚 Learning: 2025-09-16T08:01:11.146Z
Learnt from: justin808
Repo: shakacode/react_on_rails PR: 1770
File: lib/generators/react_on_rails/templates/base/base/app/javascript/src/HelloWorld/ror_components/HelloWorld.client.jsx:2-2
Timestamp: 2025-09-16T08:01:11.146Z
Learning: React on Rails uses webpack CSS Modules configuration with namedExports: true, which requires the import syntax `import * as style from './file.module.css'` rather than the default export pattern. This configuration enables better tree shaking and bundle size optimization for CSS modules.
Applied to files:
CHANGELOG.mdlib/generators/react_on_rails/templates/base/base/config/webpack/serverWebpackConfig.js.ttdocs/core-concepts/webpack-configuration.mdlib/generators/react_on_rails/templates/base/base/bin/switch-bundlerlib/generators/react_on_rails/base_generator.rblib/generators/react_on_rails/install_generator.rblib/generators/react_on_rails/templates/base/base/config/webpack/development.js.ttRSPACK_IMPLEMENTATION.md
📚 Learning: 2025-02-12T16:38:06.537Z
Learnt from: Romex91
Repo: shakacode/react_on_rails PR: 1697
File: package-scripts.yml:28-28
Timestamp: 2025-02-12T16:38:06.537Z
Learning: The file `node_package/lib/ReactOnRails.full.js` is autogenerated during the build process and should not be present in the repository.
Applied to files:
CHANGELOG.mdlib/generators/react_on_rails/templates/base/base/config/webpack/serverWebpackConfig.js.ttlib/generators/react_on_rails/templates/base/base/bin/switch-bundlerlib/generators/react_on_rails/install_generator.rblib/generators/react_on_rails/templates/base/base/config/webpack/development.js.ttRSPACK_IMPLEMENTATION.md
📚 Learning: 2025-02-18T13:08:01.477Z
Learnt from: AbanoubGhadban
Repo: shakacode/react_on_rails PR: 1644
File: lib/react_on_rails/helper.rb:190-197
Timestamp: 2025-02-18T13:08:01.477Z
Learning: RSC support validation in React on Rails Pro is handled through a chain of validations:
1. Pro version check in `run_stream_inside_fiber`
2. RSC support check during pack generation via `ReactOnRailsPro.configuration.enable_rsc_support`
3. RSC support validation during component registration
This makes additional validation in the helper methods unnecessary.
Applied to files:
CHANGELOG.mddocs/core-concepts/webpack-configuration.mdlib/generators/react_on_rails/base_generator.rblib/generators/react_on_rails/install_generator.rbRSPACK_IMPLEMENTATION.md
📚 Learning: 2024-12-12T13:07:09.929Z
Learnt from: alexeyr-ci
Repo: shakacode/react_on_rails PR: 1644
File: node_package/src/ReactOnRailsRSC.ts:87-87
Timestamp: 2024-12-12T13:07:09.929Z
Learning: When handling errors in 'node_package/src/ReactOnRailsRSC.ts', include the error stack in error messages in development and test environments to aid debugging.
Applied to files:
CHANGELOG.mdlib/generators/react_on_rails/templates/base/base/config/webpack/development.js.tt
📚 Learning: 2025-10-23T17:22:01.074Z
Learnt from: AbanoubGhadban
Repo: shakacode/react_on_rails PR: 1875
File: lib/react_on_rails/utils.rb:112-124
Timestamp: 2025-10-23T17:22:01.074Z
Learning: In React on Rails, when Pro is installed but not licensed, the intended behavior is to raise an error on boot. The `react_on_rails_pro?` method validates licenses and should raise errors early (including during path resolution in methods like `server_bundle?`) to enforce licensing requirements rather than failing later with obscure errors.
Applied to files:
CHANGELOG.md
📚 Learning: 2025-04-26T21:55:55.874Z
Learnt from: alexeyr-ci2
Repo: shakacode/react_on_rails PR: 1732
File: spec/dummy/client/app-react16/startup/ReduxSharedStoreApp.client.jsx:40-44
Timestamp: 2025-04-26T21:55:55.874Z
Learning: In the react_on_rails project, files under `app-react16` directories are copied/moved to corresponding `/app` directories during the conversion process (removing the `-react16` suffix), which affects their relative import paths at runtime.
Applied to files:
CHANGELOG.mdlib/generators/react_on_rails/templates/base/base/config/webpack/serverWebpackConfig.js.ttdocs/core-concepts/webpack-configuration.mdlib/generators/react_on_rails/templates/base/base/bin/switch-bundlerlib/generators/react_on_rails/install_generator.rblib/generators/react_on_rails/templates/base/base/config/webpack/development.js.ttRSPACK_IMPLEMENTATION.md
📚 Learning: 2025-02-13T19:09:15.991Z
Learnt from: AbanoubGhadban
Repo: shakacode/react_on_rails PR: 1644
File: node_package/src/RSCWebpackLoader.ts:0-0
Timestamp: 2025-02-13T19:09:15.991Z
Learning: In React Server Components webpack loader, using `new Function('return import("react-server-dom-webpack/node-loader")')()` is necessary as a workaround to bypass TypeScript compilation issues with direct dynamic imports.
Applied to files:
lib/generators/react_on_rails/templates/base/base/config/webpack/serverWebpackConfig.js.ttlib/generators/react_on_rails/templates/base/base/config/webpack/development.js.tt
📚 Learning: 2025-09-29T14:45:42.687Z
Learnt from: AbanoubGhadban
Repo: shakacode/react_on_rails PR: 1833
File: lib/react_on_rails/dev/process_manager.rb:72-83
Timestamp: 2025-09-29T14:45:42.687Z
Learning: In Ruby bundler contexts, when bundler intercepts system commands for executables not in the Gemfile, both version checks (like `system("foreman", "--version")`) and execution commands (like `system("foreman", "start", ...)`) fail equally, both returning false. This means availability checks using version flags accurately reflect whether execution commands will work in the current bundler context.
Applied to files:
lib/generators/react_on_rails/templates/base/base/bin/switch-bundler
📚 Learning: 2024-07-27T10:08:35.868Z
Learnt from: theforestvn88
Repo: shakacode/react_on_rails PR: 1620
File: spec/dummy/client/app/startup/HelloTurboStream.jsx:3-3
Timestamp: 2024-07-27T10:08:35.868Z
Learning: The `RailsContext` import in `spec/dummy/client/app/startup/HelloTurboStream.jsx` is used later in the project, as clarified by the user theforestvn88.
Applied to files:
lib/generators/react_on_rails/templates/base/base/config/webpack/development.js.tt
📚 Learning: 2025-02-13T16:50:47.848Z
Learnt from: AbanoubGhadban
Repo: shakacode/react_on_rails PR: 1644
File: node_package/src/clientStartup.ts:18-21
Timestamp: 2025-02-13T16:50:47.848Z
Learning: In the react_on_rails module, the `reactOnRailsPageUnloaded` function in clientStartup.ts is intentionally kept private as it's only used internally as a callback for `onPageUnloaded`.
Applied to files:
lib/generators/react_on_rails/templates/base/base/config/webpack/development.js.tt
📚 Learning: 2025-09-15T21:24:48.207Z
Learnt from: AbanoubGhadban
Repo: shakacode/react_on_rails PR: 1781
File: node_package/src/ClientSideRenderer.ts:82-95
Timestamp: 2025-09-15T21:24:48.207Z
Learning: In React on Rails, the force_load feature includes both explicit `data-force-load="true"` usage and the ability to hydrate components during the page loading state (`document.readyState === 'loading'`). Both capabilities require a Pro license, so the condition `!railsContext.rorPro && (isComponentForceLoaded || document.readyState === 'loading')` correctly gates both scenarios.
Applied to files:
lib/generators/react_on_rails/templates/base/base/config/webpack/development.js.tt
🧬 Code graph analysis (2)
lib/generators/react_on_rails/base_generator.rb (1)
lib/react_on_rails/packer_utils.rb (1)
shakapacker_version(15-19)
lib/generators/react_on_rails/install_generator.rb (2)
lib/generators/react_on_rails/generator_helper.rb (1)
add_npm_dependencies(23-39)lib/generators/react_on_rails/base_generator.rb (2)
handle_npm_failure(248-260)add_dev_dependencies(207-217)
🪛 LanguageTool
RSPACK_IMPLEMENTATION.md
[grammar] ~146-~146: Ensure spelling is correct
Context: ...ccording to PR #20: - Build times: ~53-270ms with Rspack vs typical webpack builds -...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🪛 markdownlint-cli2 (0.18.1)
RSPACK_IMPLEMENTATION.md
7-7: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
64-64: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
84-84: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (13)
lib/generators/react_on_rails/base_generator.rb (3)
22-26: LGTM! Well-defined option.The rspack option is properly declared with clear description and default value, following the established pattern for other generator options.
404-421: LGTM! YAML parsing correctly implemented.The YAML-based approach correctly addresses the fragile regex manipulation from the past review. This implementation:
- Properly parses YAML using
YAML.load_file- Safely ensures
defaultsection exists- Sets both
assets_bundlerandwebpack_loaderconfiguration- Writes back using
YAML.dumpThis matches the pattern already used in the switch-bundler script (lines 50-59).
91-91: Verify bothconfigure_rspack_in_shakapackerinvocation paths are tested.Both code paths are present:
- Line 91: Called when
.shakapacker_just_installedmarker exists- Line 99: Called after copying config when
options.rspack?is trueBoth call the same method with identical conditions. While
install_generator_spec.rbcontains tests for--rspackscenarios, explicit test coverage differentiating between these two distinct invocation paths (marker-based vs. copy-based) cannot be confirmed from available test results.Manually verify that:
- Tests cover the fresh Shakapacker install path (when marker file exists)
- Tests cover the existing Shakapacker path (normal config copy)
- Both scenarios properly invoke
configure_rspack_in_shakapackerwithrspackoption enabledlib/generators/react_on_rails/templates/base/base/bin/switch-bundler (2)
47-62: LGTM! Consistent YAML handling.The YAML parsing approach matches the pattern in base_generator.rb and correctly:
- Validates file existence
- Parses YAML safely
- Ensures default section exists
- Sets bundler-specific configuration (assets_bundler and webpack_loader)
- Writes back using YAML.dump
100-122: LGTM! Secure system calls.The installation commands correctly use array form for
system()calls, preventing command injection vulnerabilities. The spread operator*deps[:dependencies]properly expands the array.lib/generators/react_on_rails/templates/base/base/config/webpack/serverWebpackConfig.js.tt (2)
6-8: LGTM! Clean bundler abstraction.The conditional require pattern cleanly supports both Webpack and Rspack:
- Checks
config.assets_bundlerat runtime- Requires the appropriate bundler module
- Enables unified configuration
45-45: No issues found—code is correct.Both Webpack and Rspack expose
optimize.LimitChunkCountPluginat the same API path. The template correctly assignsbundlerconditionally at lines 5-7 based onconfig.assets_bundler, ensuring it references the correct module (either@rspack/coreorwebpack). Line 45's usage ofbundler.optimize.LimitChunkCountPluginworks identically for both bundlers.CHANGELOG.md (1)
28-28: LGTM! Clear and comprehensive changelog entry.The changelog entry effectively documents:
- The new --rspack flag and its purpose
- Key features (unified config, switch-bundler utility)
- Performance benefits (~20x improvement claim)
- PR reference and contributor attribution
lib/generators/react_on_rails/templates/base/base/config/webpack/development.js.tt (1)
3-3: LGTM! Clean conditional plugin loading.The implementation correctly:
- Imports
configfrom shakapacker to accessassets_bundler- Conditionally loads the appropriate React Refresh plugin based on bundler
- Handles plugin instantiation properly for both branches
- Updates comments to be more accurate ("dev server" vs "webpack-dev-server")
Also applies to: 11-23
docs/core-concepts/webpack-configuration.md (1)
14-80: LGTM! Comprehensive and clear documentation.The documentation effectively covers:
- What Rspack is and why to use it
- How to generate with Rspack or switch post-install
- Performance benefits with specific metrics
- Unified configuration approach with code examples
- Configuration details for shakapacker.yml
The examples clearly demonstrate the conditional plugin loading pattern implemented in the actual templates.
lib/generators/react_on_rails/install_generator.rb (3)
31-35: LGTM! Consistent option declaration.The rspack option follows the established pattern used for other generator options (redux, typescript) with clear description and default value.
105-106: LGTM! Option properly propagated.The rspack option is correctly passed to the base generator invocation alongside typescript and redux options.
523-537: LGTM! Rspack dependencies correctly installed.The method follows the established pattern:
- Uses
add_npm_dependencieshelper with proper error handling- Falls back to direct npm commands if helper fails
- Tracks installation state with instance variables
- Installs core Rspack packages (@rspack/core, rspack-manifest-plugin)
| WEBPACK_DEPS = { | ||
| dependencies: %w[webpack webpack-assets-manifest webpack-merge], | ||
| dev_dependencies: %w[webpack-cli webpack-dev-server @pmmmwh/react-refresh-webpack-plugin] | ||
| }.freeze | ||
|
|
||
| RSPACK_DEPS = { | ||
| dependencies: %w[@rspack/core rspack-manifest-plugin], | ||
| dev_dependencies: %w[@rspack/cli @rspack/plugin-react-refresh] | ||
| }.freeze |
There was a problem hiding this comment.
🧩 Analysis chain
Verify webpack-dev-server and webpack-cli are in correct lists.
The constants define dependencies, but I notice:
webpack-cliandwebpack-dev-serverare indev_dependencies@rspack/cliis indev_dependencies
This seems correct, but verify that these tools are properly classified as dev dependencies for both bundlers.
🏁 Script executed:
#!/bin/bash
# Check how webpack-dev-server and webpack-cli are used in package.json templates
fd -e json package.json lib/generators | xargs cat | jq '.devDependencies | keys[] | select(. | contains("webpack"))'Length of output: 0
I need to gather more information to verify the dependency classification. Let me explore the repository structure and search for relevant documentation on bundler dependencies.
---
🏁 Script executed:
```shell
#!/bin/bash
# Find the switch-bundler file to verify it exists
fd -type f "switch-bundler" lib/generators
Length of output: 170
🌐 Web query:
webpack-dev-server webpack-cli devDependencies peerDependencies classification npm
💡 Result:
Short answer
- For application projects: install webpack, webpack-cli and webpack-dev-server as devDependencies (npm i -D webpack webpack-cli webpack-dev-server). [1][2]
- For libraries/plugins that integrate with webpack (loaders, plugins): declare webpack as a peerDependency (so the host app provides it) and also include a matching webpack in devDependencies for local dev/tests. [3][4]
Sources
- webpack-dev-server install & usage recommends local, dev install. [1][2]
- npm peerDependencies behavior and best practice (libraries declare peers; authors often keep peers in devDependencies for testing). [3][4]
🌐 Web query:
rspack @rspack/cli devDependencies npm package classification
💡 Result:
Short answer: @rspack/cli is a command‑line tool meant to be installed as a development dependency (devDependency), not a runtime dependency. The official quick‑start and migration docs show installing @rspack/core and @rspack/cli with -D (devDependencies). [1][2][3]
Note: @rspack packages (including @rspack/cli) were subject to a December 2024 supply‑chain incident; follow the project's guidance and use patched/official versions. [4]
Sources: [1] rspack quick start, [2] rspack CLI docs, [3] @rspack/cli npm page, [4] Socket security writeup.
🏁 Script executed:
#!/bin/bash
# Corrected search for switch-bundler file
fd -t f "switch-bundler" lib/generatorsLength of output: 68
🌐 Web query:
rspack-manifest-plugin npm devDependencies
💡 Result:
Install it as a devDependency:
npm install --save-dev rspack-manifest-plugin. [1]
Source: npm package page for rspack-manifest-plugin. [1]
References
[1] rspack-manifest-plugin — npm. [turn2search1]
---
🌐 Web query:
```web
webpack-assets-manifest devDependencies npm
💡 Result:
Use the package name "webpack-assets-manifest" and install it as a devDependency. Example npm commands:
- npm install --save-dev webpack-assets-manifest
- npm i -D webpack-assets-manifest
Current npm page (shows latest version and install instructions). [1][2]
Sources:
[1] npm package page for webpack-assets-manifest.
[2] npm install instructions (example v6+ / v3 notes).
---
🌐 Web query:
```web
webpack-merge devDependencies npm package
💡 Result:
Do you want (A) the list of devDependencies inside the webpack-merge package.json (for a specific version), or (B) instructions to install webpack-merge as a devDependency in your project?
---
🌐 Web query:
```web
webpack-merge npm install save-dev or dependencies
💡 Result:
Use a devDependency. webpack-merge is a build tool used only when assembling webpack configs, so install with --save-dev:
npm:
npm install --save-dev webpack-merge
yarn:
yarn add --dev webpack-merge
Sources: webpack guide recommending --save-dev and the webpack-merge npm page. (webpack.js.org)
Citations:
Move three build-time tools from dependencies to dev_dependencies.
webpack-assets-manifest, rspack-manifest-plugin, and webpack-merge should all be installed as devDependencies, not dependencies. These are build-time only tools:
webpack-assets-manifestandrspack-manifest-plugingenerate manifests during the build processwebpack-mergeis used only to assemble webpack configurations
Move these three packages to the dev_dependencies hash in both WEBPACK_DEPS and RSPACK_DEPS constants.
🤖 Prompt for AI Agents
In lib/generators/react_on_rails/templates/base/base/bin/switch-bundler around
lines 10 to 18, three build-time packages are incorrectly listed under
dependencies; move webpack-assets-manifest, rspack-manifest-plugin, and
webpack-merge from the dependencies arrays into the dev_dependencies arrays for
both WEBPACK_DEPS and RSPACK_DEPS so they are installed as devDependencies
(build-time only) rather than runtime dependencies.
## Changes 1. **Update main README** - Added Rspack to "What's New" section as first bullet point - Added Rspack to "Why React on Rails?" features table - Highlights ~20x faster builds with links to documentation 2. **Address comment #1: Remove redundant --no-rspack option** - File: docs/api-reference/generator-details.md:14 - Removed [--no-rspack] from options list (redundant, default is false) - Kept only [--rspack] for clarity 3. **Address comment #2: Document switch-bundler limitations** - File: docs/getting-started/quick-start.md:47 - Added detailed note about limitations in quick-start - File: docs/api-reference/generator-details.md - Added comprehensive "Limitations of bin/switch-bundler" section: * Custom webpack plugins not auto-updated * Manual updates needed for custom configs * Third-party webpack packages not detected * YAML formatting may change (but preserves functionality) - Cross-references to unified configuration docs 4. **TypeScript handling confirmed working** - Rspack uses SWC which handles TypeScript natively - No .ts file updates needed - --rspack --typescript combination works seamlessly ## Documentation Now Complete The Rspack feature is now documented in: - Main README (prominent placement) - Quick Start guide (with limitations) - Generator Details (comprehensive with limitations) - Webpack Configuration (technical details) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Rails automatically generates both --option and --no-option forms for all boolean generator options. The documentation should be consistent. Since --redux and --typescript both show [--option], [--no-option] format, rspack should follow the same pattern for consistency. While --no-rspack is redundant (default is false), it matches the existing documentation style and what Rails actually provides.
Summary
Implements
--rspackflag forreact_on_rails:installgenerator to use Rspack bundler instead of Webpack, providing significantly faster builds (~20x improvement with SWC).Based on implementation patterns from react_on_rails-demos PR #20.
Key Changes
--rspackoption toinstall_generator.rbandbase_generator.rbassets_bundler: 'rspack'andwebpack_loader: 'swc'bin/switch-bundlerutility: Allows switching between bundlers post-installationImplementation Details
Rspack Dependencies Installed
Production:
@rspack/core- Core Rspack bundlerrspack-manifest-plugin- Manifest generationDevelopment:
@rspack/cli- Rspack CLI tools@rspack/plugin-react-refresh- React Fast Refresh for Rspackreact-refresh- React Fast Refresh runtimeWebpack Dependencies NOT Installed (with --rspack)
webpack,webpack-cli,webpack-dev-serverwebpack-assets-manifest,webpack-merge@pmmmwh/react-refresh-webpack-pluginConfiguration Changes
When
--rspackis used,config/shakapacker.ymlis updated:Usage Examples
Generate new app with Rspack:
With TypeScript:
With Redux:
Switch existing app:
Performance Benefits
According to react_on_rails-demos PR #20:
Bundler Switching Utility
The new
bin/switch-bundlerscript allows easy switching between bundlers:Features:
shakapacker.ymlconfigurationUsage:
Compatibility
--typescriptoption--reduxoptionbin/switch-bundlerscriptTesting
Documentation
See
RSPACK_IMPLEMENTATION.mdfor detailed implementation documentation.Test Plan
--rspackflag--rspack --typescript--rspack --reduxbin/switch-bundlerutility🤖 Generated with Claude Code
This change is
Summary by CodeRabbit
New Features
Documentation