docs: add a webpack-hot-middleware migration guide - #2391
Conversation
One file, migration-from-webpack-hot-middleware.md: prerequisites (the node.js and webpack floors this package has and that one does not), the server and webpack-configuration changes, every server and client option mapped, the behavior differences that bite (the `reload` default, warnings in the overlay, the dropped module map), the framework recipes that used to need third-party bridges, the troubleshooting carried over from that project's README, and a checklist. README keeps a pointer instead of a second copy.
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2391 +/- ##
=======================================
Coverage 94.19% 94.19%
=======================================
Files 4 4
Lines 1240 1240
Branches 380 380
=======================================
Hits 1168 1168
Misses 64 64
Partials 8 8 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Team Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Included review availability: Your plan provides up to 8 included reviews per hour; 5 remain after this review. WalkthroughThe README now links to a dedicated migration guide. The guide documents prerequisites, package changes, middleware replacement, client entry changes, framework wrappers, compiler configuration, option mappings, behavior differences, programmatic APIs, troubleshooting, and a migration checklist. It also defines the compatibility boundary for the built-in Merge Risk: ⚪ Minimal · up to This documentation-only change adds a migration guide and updates the README pointer; no actionable merge-blocking risk remains after normal checks and review. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Full details: Docstring CoverageExplanation No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.) ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Team
Run ID: ce6ca997-7ab3-4cc0-a9b1-fac20921472f
📒 Files selected for processing (2)
README.mdmigration-from-webpack-hot-middleware.md
Included review availability: Your plan provides up to 8 included reviews per hour; 7 remain after this review.
Removing webpack-hot-middleware does not upgrade the package that replaces it, so the guide now says to install it and shows the validation error an older version answers `hot` with (taken from schema-utils, not written from memory). The opening claimed the wire format was unchanged, which oversold it: the endpoint and its transport are, the payloads, option names and a few defaults are not, and the two sections that cover them are linked from there.
There was a problem hiding this comment.
Actionable comments posted: 1
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Team
Run ID: 3f7a16de-0a7a-4880-85dd-f5e7281afffd
📒 Files selected for processing (2)
README.mdmigration-from-webpack-hot-middleware.md
🚧 Files skipped from review as they are similar to previous changes (1)
- README.md
Included review availability: Your plan provides up to 8 included reviews per hour; 6 remain after this review.
Every other fence in the guide names its language; this one did not, which markdownlint reports as MD040.
1 participant
Summary
Now that
hothas landed (#2322),webpack-hot-middlewareusers need a route across. The README's short section could not carry it, so this addsmigration-from-webpack-hot-middleware.md— one file with the whole move — and leaves the README with a pointer rather than a second copy.It covers the prerequisites (the Node.js and webpack floors this package has and that one does not), the server and webpack-configuration changes, every server and client option mapped, the behavior differences that bite (the
reloaddefault flipped totrue, warnings now shown in the overlay, the payload's dropped module map), the frameworks that used to need third-party bridges, the troubleshooting carried over from that project's README, and a checklist.What kind of change does this PR introduce?
docs
Did you add tests for your changes?
n/a — documentation only, no source changes.
npm run lintis green, which matters here because ESLint parses the fenced JS blocks and Prettier and cspell read the Markdown.Does this PR introduce a breaking change?
No.
If relevant, what needs to be documented once your changes are merged or what have you already documented?
This is the documentation. One follow-up is worth considering: a note in
webpack-hot-middleware's own README pointing at this guide, since that is where its users look — happy to raise it separately.Use of AI
Written with Claude Code. Every claim was checked against the two code bases rather than recalled:
webpack-hot-middleware'smiddleware.js,client.jsandhelpers.jsfor the option defaults, the payload shape and thepathMatchsemantics, and this package's mergedhotimplementation, schema and README for the mapping. Reviewed and verified by a human before submitting.🤖 Generated with Claude Code
https://claude.ai/code/session_01KUpsHWHZG2FxHzJxRUvVv3
Generated by Claude Code
Summary by CodeRabbit
webpack-hot-middlewareto the built-inhotoption inwebpack-dev-middleware.