Commit 34824fd
Address code review comments for configuration documentation
This commit addresses all 8 code review comments on the configuration
simplification PR, improving documentation clarity and adding comprehensive
testing guidance.
## Documentation Improvements
- Fix: Changed "Deprecated:" to "Renamed to:" in configuration-deprecated.md
for better clarity
- Add: Filename heading for /config/shakapacker.yml in Prerequisites section
- Add: Migration note in configuration-pro.md explaining Pro docs will be
consolidated in future PR
## Testing Configuration Enhancements
- Enhance: Completely rewrote build_test_command section in configuration.md
- Clarified the two approaches are mutually exclusive
- Added clear pros/cons for each approach
- Provided detailed examples for both methods
- Linked to comprehensive testing guide
- NEW: Created comprehensive testing configuration guide
(docs/guides/testing-configuration.md)
- 390 lines of detailed guidance
- Covers both Shakapacker auto-compilation and React on Rails test helper
- Migration guides between approaches
- Troubleshooting section
- Performance considerations
- CI/CD guidance
- Decision matrix for choosing approaches
## Generator Template Updates
- Update: Commented out build_test_command in generator template by default
- Recommends simpler Shakapacker compile: true approach
- Provides clear alternative with test helper for advanced users
- Links to comprehensive testing guide
- Prevents confusion for new users
## Doctor Program Enhancements
- NEW: Added check_server_bundle_prerender_consistency() to doctor.rb
- Detects when prerender is enabled but server_bundle_js_file not configured
- Detects when server_bundle_js_file is set but prerender never used
- Scans view files for prerender: true usage
- Provides actionable recommendations
- NEW: Added check_build_test_configuration() to doctor.rb
- Detects conflicting test asset compilation configurations
- Checks for both compile: true and build_test_command being set
- Validates alignment between config and test helpers
- Detects missing test asset compilation setup
- Links to testing configuration guide
## Files Changed
- docs/api-reference/configuration-deprecated.md
- docs/api-reference/configuration-pro.md
- docs/api-reference/configuration.md
- docs/guides/testing-configuration.md (NEW)
- lib/generators/react_on_rails/templates/base/base/config/initializers/react_on_rails.rb.tt
- lib/react_on_rails/doctor.rb
All changes pass RuboCop and Prettier validation.
Addresses comments: #1 (not applicable), #2, #3, #4, #5, #6, #7, #8, #9
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <[email protected]>1 parent 1a4a204 commit 34824fd
File tree
6 files changed
+577
-11
lines changed- docs
- api-reference
- guides
- lib
- generators/react_on_rails/templates/base/base/config/initializers
- react_on_rails
6 files changed
+577
-11
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
31 | 31 | | |
32 | 32 | | |
33 | 33 | | |
34 | | - | |
| 34 | + | |
35 | 35 | | |
36 | 36 | | |
37 | 37 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
11 | 11 | | |
12 | 12 | | |
13 | 13 | | |
| 14 | + | |
| 15 | + | |
14 | 16 | | |
15 | 17 | | |
16 | 18 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
| 13 | + | |
| 14 | + | |
13 | 15 | | |
14 | 16 | | |
15 | 17 | | |
| |||
115 | 117 | | |
116 | 118 | | |
117 | 119 | | |
118 | | - | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
119 | 139 | | |
120 | | - | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
121 | 146 | | |
122 | 147 | | |
| 148 | + | |
123 | 149 | | |
124 | 150 | | |
125 | 151 | | |
126 | | - | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
127 | 155 | | |
128 | | - | |
129 | | - | |
130 | | - | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
131 | 159 | | |
132 | 160 | | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
133 | 174 | | |
134 | 175 | | |
135 | 176 | | |
| |||
0 commit comments