From 9b3d6b52673d7e2e81e2c3d30685e5268e0fac85 Mon Sep 17 00:00:00 2001
From: Shinigami <chrissi92@hotmail.de>
Date: Tue, 25 Jan 2022 22:38:35 +0100
Subject: docs: provide migration guide (#282)

---
 docs/.vitepress/config.mjs |  4 ++++
 docs/migration/index.md    | 53 ++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 57 insertions(+)
 create mode 100644 docs/migration/index.md

(limited to 'docs')

diff --git a/docs/.vitepress/config.mjs b/docs/.vitepress/config.mjs
index c824f327..5794d259 100644
--- a/docs/.vitepress/config.mjs
+++ b/docs/.vitepress/config.mjs
@@ -78,6 +78,10 @@ const sidebar = {
         },
       ],
     },
+    {
+      text: 'Migration from faker.js v5',
+      link: '/migration/',
+    },
   ],
 };
 
diff --git a/docs/migration/index.md b/docs/migration/index.md
new file mode 100644
index 00000000..6e4be2da
--- /dev/null
+++ b/docs/migration/index.md
@@ -0,0 +1,53 @@
+# Migration from faker.js v5
+
+There are now two bundles: `cjs` and `esm`
+
+The browser bundle was dropped in favor of `esm`
+
+So if you like to use `Faker` in the **browser**, just use:
+
+```html
+<script type="module">
+  import { faker } from 'https://unpkg.com/@faker-js/faker';
+
+  console.log(`${faker.name.firstName()} ${faker.name.lastName()}`);
+</script>
+```
+
+A stackblitz playground can be found here: https://stackblitz.com/edit/typescript-damv7h
+
+:::tip
+Faker now provides TypeScript types out of the box.
+So you can remove `@types/faker` completely.
+:::
+
+You no longer need to import `faker` as a standard import, but as a tree shakeable instance.
+
+For JS:
+
+```js
+const { faker } = require('@faker-js/faker');
+
+// Or specific locale
+const fakerDe = require('@faker-js/faker/locale/de');
+```
+
+For TS:
+
+```ts
+import { faker } from '@faker-js/faker';
+
+// Or specific locale
+import fakerDe from '@faker-js/faker/locale/de';
+```
+
+:::tip
+If you have many files using these imports, we suggest to use e.g. VSCode's search and replace functionality.
+:::
+
+---
+
+:::warning
+You need to switch from the package `faker` to `@faker-js/faker`.  
+We also provided all historical versions under the new organization scope. So if you depend on a specific version you still can use `"@faker-js/faker": "5.5.3"`.
+:::
-- 
cgit v1.2.3