Merge branch 'main' into jsdocs/fix-missing

Author: Shinigami92

.github/workflows/ci.yml

@@ -31,7 +31,7 @@ jobs:
           version: 6
 
       - name: Set node version to ${{ matrix.node_version }}
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node_version }}
           cache: 'pnpm'
@@ -80,7 +80,7 @@ jobs:
           version: 6
 
       - name: Set node version to 16
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
           node-version: 16
           cache: 'pnpm'
@@ -111,7 +111,7 @@ jobs:
           version: 6
 
       - name: Set node version to 16
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
           node-version: 16
           cache: 'pnpm'

.prettierrc.cjs

@@ -4,9 +4,7 @@
  * @type {import('prettier').Options}
  */
 module.exports = {
-  plugins: [
-    /* require.resolve("prettier-plugin-organize-imports") */
-  ],
+  plugins: [require.resolve('prettier-plugin-organize-imports')],
   singleQuote: true,
   overrides: [
     {

docs/.vitepress/theme/components/index.mjs

@@ -1,5 +1,5 @@
-import Playground from './Playground.vue';
 import Badge from './Badge.vue';
+import Playground from './Playground.vue';
 
 export default {
   Playground,

docs/.vitepress/theme/index.mjs

@@ -1,6 +1,6 @@
-import './index.css';
-import GlobalComponents from './components';
 import DefaultTheme from 'vitepress/theme';
+import GlobalComponents from './components';
+import './index.css';
 
 export default {
   ...DefaultTheme,

docs/migration-guide-v5/index.md

@@ -36,33 +36,49 @@ Faker now ships with its own types! Remove `@types/faker` from your `package.jso
 
 ### Tree-shaking
 
-Faker now supports tree-shaking! We highly recommend that you take advantage of your bundler's tree-shaking capabilities and change how you import Faker. This is especially true if you're importing Faker in the browser.
+:::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.
+:::
 
-Faker is a giant package made up of many megabytes of strings. Only import what you need.
+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.
 
-:::tip
-Migrating to the new tree-shakeable syntax should be quick and painless.
-:::
+Instead of using:
 
-For JS:
+```ts
+// js
+const faker = require('@faker-js/faker');
 
-```js
+// ts
+import faker from '@faker-js/faker';
+```
+
+You should switch to:
+
+```ts
+// js
 const { faker } = require('@faker-js/faker');
 
-// Or specific locale
-const fakerDe = require('@faker-js/faker/locale/de');
+// ts
+import { faker } from '@faker-js/faker';
 ```
 
-For TS:
+If you only need one specific language, we highly recommend to make use of the locale specific imports like:
 
 ```ts
-import { faker } from '@faker-js/faker';
+// js
+const fakerDe = require('@faker-js/faker/locale/de');
 
-// Or specific locale
+// ts
 import fakerDe from '@faker-js/faker/locale/de';
 ```
 
-Please [open an issue on GitHub](https://github.com/faker-js/faker/issues/new?assignees=&labels=pending+triage&template=freestyle.md) if we've missed any steps.
+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!
 

package.json

@@ -101,7 +101,7 @@
     "conventional-changelog-cli": "~2.2.2",
     "cypress": "~9.5.0",
     "esbuild": "~0.14.23",
-    "eslint": "~8.9.0",
+    "eslint": "~8.10.0",
     "eslint-config-prettier": "~8.4.0",
     "eslint-define-config": "~1.2.5",
     "eslint-gitignore": "~0.1.0",
@@ -112,6 +112,7 @@
     "npm-run-all": "~4.1.5",
     "picocolors": "~1.0.0",
     "prettier": "2.5.1",
+    "prettier-plugin-organize-imports": "~2.3.4",
     "rimraf": "~3.0.2",
     "sanitize-html": "~2.7.0",
     "simple-git-hooks": "~2.7.0",
@@ -124,7 +125,7 @@
     "vitepress": "~0.22.3",
     "vitest": "~0.5.4"
   },
-  "packageManager": "[email protected].1",
+  "packageManager": "[email protected].2",
   "engines": {
     "node": ">=14.0.0",
     "npm": ">=7.0.0"