docs: migration guide for v10 #3559
Conversation
✅ Deploy Preview for fakerjs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## next #3559 +/- ##
=======================================
Coverage 99.96% 99.96%
=======================================
Files 2888 2888
Lines 221958 221958
Branches 931 930 -1
=======================================
Hits 221891 221891
Misses 67 67 🚀 New features to boost your workflow:
|
|
@matthewmayer THANKS a lot that you started to take this over 🚀 But I was not that far as you are already. Here is my current diff: DetailsLets merge forces and I will start reviewing your work 👍 |
|
Ah my bad didn't realise. Feel free to leave comments, or make edits directly to my draft. |
|
In https://github.com/faker-js/faker/pull/3559/files#diff-3def678deb1b1d5a53948eb8491817dde4dc881e032e785fc61cc93d334eefcdR107 we have a roadmap section. Will we add a v10 section in a later PR after v10.0 got already released? |
|
Yeah I think we could probably remove the roadmap. We might have a wishlist of future changes but they would not be tied to specific major versions. |
|
I found
found two methods in I think the section in the |
There was a problem hiding this comment.
Pull Request Overview
This PR updates the migration guide from v9 to v10, adjusting Node.js requirements, explaining the new ESM-only package with CommonJS compatibility, and refreshing the list of removed deprecated methods.
- Update guide headings, Node version support, and ESM/CommonJS guidance
- Refresh tables of removed methods and their replacements
- Update sidebar entry text for the upgrading guide
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/guide/upgrading.md | Revised migration guide to v10: headings, Node requirements, ESM/CJS usage, and updated removal tables |
| docs/.vitepress/config.ts | Updated sidebar label from "Upgrading to v9" to "Upgrading to v10" |
Comments suppressed due to low confidence (4)
docs/guide/upgrading.md:24
- The heading only mentions Node v18 but the guide requires a minimum of Node.js v20.19.0 (so Node v19 is also unsupported). Consider updating the heading to reflect the accurate minimum version (e.g., "Minimum Node.js v20.19.0+").
### Node v18 No Longer Supported
docs/guide/upgrading.md:15
- The "Not the version you are looking for?" section only links to v9, but links to older migrations were removed. Restoring links to v8, v7, etc., would help users upgrading from earlier releases.
- [Upgrading to v9](https://v9.fakerjs.dev/guide/upgrading.html)
docs/guide/upgrading.md:41
- The error snippet beginning with "Uncaught:" isn't inside a code block, so it won't render as formatted code. Wrap these lines in triple backticks to preserve formatting.
Uncaught:
docs/guide/upgrading.md:35
- The example destructures
fakerES, which isn't exported by the package; this may confuse readers. Consider showing how to import specific locales or remove the unused alias.
const { faker, fakerES } = require('@faker-js/faker'); // this still works
WIP migration guide for
Preview is here https://deploy-preview-3559.fakerjs.dev/guide/upgrading.html