docs: add migration guide for v2 - #125
Conversation
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces a comprehensive migration guide for users upgrading Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request adds a comprehensive migration guide for upgrading from v1 to v2 of @rspack/dev-server. The guide is well-structured and covers key breaking changes, including Node.js version requirements, dependency updates, and removed features. I've identified a minor formatting issue and an area where the explanation could be clearer for users.
Note: Security Review has been skipped due to the limited scope of the PR.
| - When `bypass` was used and that function returned a boolean, it would automatically result in a 404 request. This can’t be achieved in a similar way now, or, if it returned a string, you can do what was done in the example above. | ||
| - `bypass` also allowed sending data; this can no longer be done. If you really need to do it, you’d have to create a new route in the proxy that sends the same data, or alternatively create a new route on the main server and, following the example above, send the data you wanted. |
There was a problem hiding this comment.
The references to "the example above" on lines 51 and 52 are a bit confusing, as the preceding examples are for proxy[].path and logLevel, not for replacing bypass. To improve clarity, consider rephrasing to avoid referring to an unrelated example, or provide a small example for using pathFilter or router as a replacement for bypass if possible.
|
|
||
| ### Upgraded Express to v5 | ||
|
|
||
| `express`` has been updated to v5, see [Introducing Express v5: A New Era for the Node.js Framework](https://expressjs.com/2024/10/15/v5-release.html) for details. |
There was a problem hiding this comment.
There's a small formatting typo here. The extra backtick breaks the code formatting for express.
| `express`` has been updated to v5, see [Introducing Express v5: A New Era for the Node.js Framework](https://expressjs.com/2024/10/15/v5-release.html) for details. | |
| `express` has been updated to v5, see [Introducing Express v5: A New Era for the Node.js Framework](https://expressjs.com/2024/10/15/v5-release.html) for details. |
There was a problem hiding this comment.
Pull request overview
Adds a dedicated migration guide to help users upgrade @rspack/dev-server from v1 to v2 by documenting breaking changes and replacement configuration patterns.
Changes:
- Document Node.js engine requirement changes (dropping Node 18).
- Document dependency-related breaking changes (e.g.,
http-proxy-middlewarev3, Express v5). - Document removed/renamed features and configuration (e.g.,
spdy, SockJS, Bonjour,/rspack-dev-server/*routes & query flags).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ### Upgraded Express to v5 | ||
|
|
||
| `express`` has been updated to v5, see [Introducing Express v5: A New Era for the Node.js Framework](https://expressjs.com/2024/10/15/v5-release.html) for details. |
There was a problem hiding this comment.
There’s an extra backtick in the inline code formatting for the Express package name; it renders incorrectly as `express``.
| `express`` has been updated to v5, see [Introducing Express v5: A New Era for the Node.js Framework](https://expressjs.com/2024/10/15/v5-release.html) for details. | |
| `express` has been updated to v5, see [Introducing Express v5: A New Era for the Node.js Framework](https://expressjs.com/2024/10/15/v5-release.html) for details. |
Add comprehensive migration documentation covering breaking changes when upgrading from v1 to v2, including Node.js version requirements, dependency updates, and removed features.