From 8db9d6e8743d080431093b643b0a238d73c422e8 Mon Sep 17 00:00:00 2001 From: Shinigami Date: Sun, 11 Sep 2022 20:23:42 +0800 Subject: docs: upgrading guide (#1365) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Leyla Jähnig leyla.jaehnig@gmx.de Co-authored-by: ST-DDT ST-DDT@gmx.de --- docs/guide/migration-guide-v5.md | 83 ---------------------------------------- docs/guide/migration-guide-v6.md | 50 ------------------------ docs/guide/upgrading.md | 59 ++++++++++++++++++++++++++++ 3 files changed, 59 insertions(+), 133 deletions(-) delete mode 100644 docs/guide/migration-guide-v5.md delete mode 100644 docs/guide/migration-guide-v6.md create mode 100644 docs/guide/upgrading.md (limited to 'docs/guide') diff --git a/docs/guide/migration-guide-v5.md b/docs/guide/migration-guide-v5.md deleted file mode 100644 index 13f23c3a..00000000 --- a/docs/guide/migration-guide-v5.md +++ /dev/null @@ -1,83 +0,0 @@ -# Migrating from Faker v5 to v6 - -## ESM Support - -**New Format**: We're now ESM compatible! We've dropped the Browser bundle in favor of ESM. - -So if you'd like to use `Faker` in the **browser**, simply include it using a [JavaScript module](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules#applying_the_module_to_your_html). - -```html - -``` - -## Remove all references to `faker` from your project. The new package is located at `@faker-js/faker` - -:::warning -You **MUST** swap all references from the `faker` package to the new `@faker-js/faker` package. - -In addition to releasing all _future_ versions under the `@faker-js/faker` package namespace, we have also provided all _historical_ versions of Faker. - -If you depend on a specific version of Faker you still can reference the version directly. - -`npm i @faker-js/faker@5.5.3 -D` will work just fine 😄. -::: - -## TypeScript - -:::tip TypeScript Improvements -Faker now ships with its own types! Remove `@types/faker` from your `package.json` to avoid conflicts. -::: - -## Tree-shaking - -:::warning -Tree shaking is not yet fully supported due to some structural issues. But we plan to make Faker fully tree-shakable in the future. -::: - -For now Faker supports tree-shaking for some parts, and we highly recommend that you take advantage of your bundler's tree-shaking capabilities and change how you import Faker right now. - -Instead of using: - -```ts -// js -const faker = require('@faker-js/faker'); - -// ts -import faker from '@faker-js/faker'; -``` - -You should switch to: - -```ts -// js -const { faker } = require('@faker-js/faker'); - -// ts -import { faker } from '@faker-js/faker'; -``` - -If you only need one specific language, we highly recommend to make use of the locale specific imports like: - -```ts -// js -const fakerDe = require('@faker-js/faker/locale/de'); - -// ts -import fakerDe from '@faker-js/faker/locale/de'; -``` - -This is especially true if you're importing Faker in the browser. - -Faker is a giant package made up of many megabytes of strings. Only import what you need. - -_We plan to load the locales in another way in a future major release._ - ---- - -Happy Faking! - -- Shini, Jess, and the Faker Team diff --git a/docs/guide/migration-guide-v6.md b/docs/guide/migration-guide-v6.md deleted file mode 100644 index 6a91a143..00000000 --- a/docs/guide/migration-guide-v6.md +++ /dev/null @@ -1,50 +0,0 @@ -# Migrating from Faker v6 to v7 - -## Node 12 no longer supported - -You need at least Node 14 to use Faker. - -## Default export removed - -If you were previously importing faker like this: - -```js -import faker from '@faker-js/faker'; -``` - -You must instead use: - -```js -import { faker } from '@faker-js/faker'; -``` - -## Deprecated methods changed - -Several methods were renamed or moved: - -| Old method | New alternative | -| -------------------------- | ------------------------------------------------------ | -| faker.random.number | faker.datatype.number | -| faker.random.float | faker.datatype.float | -| faker.random.arrayElement | faker.helpers.arrayElement | -| faker.random.arrayElements | faker.helpers.arrayElements | -| faker.random.objectElement | faker.helpers.objectKey
faker.helpers.objectValue | -| faker.random.uuid | faker.datatype.uuid | -| faker.random.boolean | faker.datatype.boolean | -| faker.random.image | faker.image.image | -| faker.random.hexaDecimal | faker.datatype.hexadecimal | -| faker.helpers.randomize | faker.helpers.arrayElement | -| faker.datatype.hexaDecimal | faker.datatype.hexadecimal | -| faker.name.title | faker.name.jobTitle | - -## Deprecated methods removed - -Some methods were removed without a direct alternative. If you are using any of these methods you should build an object containing the specific properties you need. - -| Removed method | -| ------------------------------- | -| faker.helpers.createCard | -| faker.helpers.contextualCard | -| faker.helpers.userCard | -| faker.time | -| faker.helpers.createTransaction | diff --git a/docs/guide/upgrading.md b/docs/guide/upgrading.md new file mode 100644 index 00000000..ac95b6b5 --- /dev/null +++ b/docs/guide/upgrading.md @@ -0,0 +1,59 @@ +# Upgrading to v7 + +This is the migration guide for upgrading from v6 to v7. + +::: info +Not the version you are looking for? + +- [v6.fakerjs.dev](https://v6.fakerjs.dev/migration-guide-v5/) + +::: + +## Node 12 no longer supported + +You need at least Node 14 to use Faker. + +## Default export removed + +If you were previously importing faker like this: + +```js +import faker from '@faker-js/faker'; +``` + +You must instead use: + +```js +import { faker } from '@faker-js/faker'; +``` + +## Deprecated methods changed + +Several methods were renamed or moved: + +| Old method | New alternative | +| -------------------------- | ------------------------------------------------------ | +| faker.random.number | faker.datatype.number | +| faker.random.float | faker.datatype.float | +| faker.random.arrayElement | faker.helpers.arrayElement | +| faker.random.arrayElements | faker.helpers.arrayElements | +| faker.random.objectElement | faker.helpers.objectKey
faker.helpers.objectValue | +| faker.random.uuid | faker.datatype.uuid | +| faker.random.boolean | faker.datatype.boolean | +| faker.random.image | faker.image.image | +| faker.random.hexaDecimal | faker.datatype.hexadecimal | +| faker.helpers.randomize | faker.helpers.arrayElement | +| faker.datatype.hexaDecimal | faker.datatype.hexadecimal | +| faker.name.title | faker.name.jobTitle | + +## Deprecated methods removed + +Some methods were removed without a direct alternative. If you are using any of these methods you should build an object containing the specific properties you need. + +| Removed method | +| ------------------------------- | +| faker.helpers.createCard | +| faker.helpers.contextualCard | +| faker.helpers.userCard | +| faker.time | +| faker.helpers.createTransaction | -- cgit v1.2.3