Commit 9af7271
## Summary
Adds comprehensive backward compatibility documentation to the v9
upgrade guide, addressing issue #809. Users upgrading from Shakapacker
8.x to 9.x now have a complete working example showing how to restore
the v8 CSS Modules behavior in large codebases.
## Changes
- Added "Restoring v8 Behavior (Backward Compatibility)" section to the
CSS Modules breaking change documentation
- Included complete working webpack config override example
- Added detailed explanations of each configuration option
- Provided debugging tips for inspecting webpack configuration
- Documented clear migration path from temporary workaround to full v9
adoption
- Referenced real-world example from React on Rails PR #1921
## Key Improvements
1. **Complete working example** - No longer just a reference to other
docs, but a full copy-paste solution
2. **Detailed explanations** - Each configuration option is explained
with comments
3. **Debugging guidance** - Shows how to inspect webpack config
structure
4. **Migration clarity** - Clear steps from v8 behavior to v9 named
exports
5. **Real-world validation** - Links to successful implementation in
React on Rails
## Problem Solved
The previous documentation mentioned overriding CSS Modules
configuration but didn't provide a complete example. Users had to:
- Figure out which webpack config file to modify
- Understand how to iterate through webpack rules
- Determine exact options needed for backward compatibility
This led to runtime failures (components not rendering) that were
difficult to debug since webpack builds succeeded but CSS classes were
undefined at runtime.
## Test Plan
- Documentation change only, no code changes required
- Verified markdown formatting with yarn lint
- Confirmed example matches working solution from React on Rails upgrade
## Related
- Fixes #809
- Referenced implementation:
shakacode/react_on_rails#1921
Generated with [Claude Code](https://claude.com/claude-code)
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Documentation**
* Updated v9 upgrade documentation with detailed webpack configuration
options for CSS Modules. Includes practical code examples for
configuring settings, implementation safety checks, migration guidance,
and best practices to help users maintain compatibility with previous
versions while successfully upgrading to v9.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
---------
Co-authored-by: Claude <[email protected]>
1 parent 1c13a1a commit 9af7271
1 file changed
+68
-2
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
155 | 155 | | |
156 | 156 | | |
157 | 157 | | |
158 | | - | |
159 | | - | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
| 204 | + | |
| 205 | + | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
| 209 | + | |
| 210 | + | |
| 211 | + | |
| 212 | + | |
| 213 | + | |
| 214 | + | |
| 215 | + | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
| 224 | + | |
| 225 | + | |
160 | 226 | | |
161 | 227 | | |
162 | 228 | | |
| |||
0 commit comments