Skip to content

Commit 8cfb76b

Browse files
committed
Update docs for v9.1.1 release and add export utility documentation
- Set release date for v9.1.1 as October 9, 2025 - Add note about switch_bundler integration in CHANGELOG - Add Debugging Configuration section to README - Add config export utility to rspack migration guide with comparison workflow - Document integration with switch_bundler feature
1 parent d8d150e commit 8cfb76b

3 files changed

Lines changed: 52 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111

1212
Changes since the last non-beta release.
1313

14+
## [v9.1.1] - October 9, 2025
15+
1416
### Added
1517

1618
- **New config export utility for debugging webpack/rspack configurations** [PR #647](https://github.com/shakacode/shakapacker/pull/647) by [justin808](https://github.com/justin808).
@@ -27,6 +29,7 @@ Changes since the last non-beta release.
2729
- Sanitizes filenames to prevent path traversal
2830
- Helpful `.gitignore` suggestions
2931
- **Usage:** `bin/export-bundler-config --doctor` or `bundle exec rake shakapacker:export_bundler_config`
32+
- Works seamlessly with `rake shakapacker:switch_bundler` for comparing webpack vs rspack configs
3033
- Lays groundwork for future config diff feature (tracked in [#667](https://github.com/shakacode/shakapacker/issues/667))
3134

3235
### Fixed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -767,6 +767,27 @@ Please note that if you want opt-in to use esbuild-loader, you can skip [React](
767767
768768
To switch between Babel, SWC, or esbuild, or to configure environment-specific transpiler settings, see the [Transpiler Migration Guide](./docs/transpiler-migration.md).
769769
770+
### Debugging Configuration
771+
772+
Shakapacker provides a powerful utility to export and analyze your webpack/rspack configuration:
773+
774+
```bash
775+
# Export all configs for troubleshooting (recommended)
776+
bin/export-bundler-config --doctor
777+
778+
# Or via rake task
779+
bundle exec rake shakapacker:export_bundler_config -- --doctor
780+
```
781+
782+
This exports development and production configurations for both client and server bundles to `shakapacker-config-exports/` directory in annotated YAML format. Perfect for:
783+
784+
- Debugging configuration issues
785+
- Comparing webpack vs rspack configs (works with `rake shakapacker:switch_bundler`)
786+
- Understanding differences between development and production
787+
- Analyzing client vs server bundle configurations
788+
789+
For more options and usage examples, see the [Troubleshooting Guide](./docs/troubleshooting.md#exporting-webpack--rspack-configuration).
790+
770791
### Integrations
771792
772793
Shakapacker out of the box supports JS and static assets (fonts, images etc.) compilation. To enable support for CoffeeScript or TypeScript install relevant packages:

docs/rspack_migration_guide.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -269,6 +269,34 @@ bin/shakapacker --mode production
269269
3. **Enable Caching:** Rspack has built-in persistent caching
270270
4. **Use SWC:** The built-in SWC loader is significantly faster than Babel
271271

272+
## Debugging Configuration
273+
274+
To compare your webpack and rspack configurations during migration:
275+
276+
```bash
277+
# Export webpack configs before switching
278+
bin/export-bundler-config --doctor
279+
280+
# Switch to rspack
281+
rails shakapacker:switch_bundler rspack --install-deps
282+
283+
# Export rspack configs to compare
284+
bin/export-bundler-config --doctor
285+
286+
# Compare the files in shakapacker-config-exports/
287+
diff shakapacker-config-exports/webpack-production-client.yaml \
288+
shakapacker-config-exports/rspack-production-client.yaml
289+
```
290+
291+
The config export utility creates annotated YAML files that make it easy to:
292+
293+
- Verify plugin replacements are correct
294+
- Compare loader configurations
295+
- Identify missing or different options
296+
- Debug configuration issues
297+
298+
See the [Troubleshooting Guide](./troubleshooting.md#exporting-webpack--rspack-configuration) for more details.
299+
272300
## Resources
273301

274302
- [Rspack Documentation](https://rspack.rs)

0 commit comments

Comments
 (0)