Merge branch 'main' into test-date-improve

.github/ISSUE_TEMPLATE/config.yml

@@ -1,7 +1,7 @@
 blank_issues_enabled: false
 contact_links:
   - name: Discord Chat
-    url: discord.gg/4qDjAmDj4P
+    url: https://chat.fakerjs.dev
     about: Ask questions and discuss with other users in real time.
   - name: Questions & Discussions
     url: https://github.com/faker-js/faker.js/discussions

.github/workflows/ci.yml

@@ -70,3 +70,6 @@ jobs:
 
       - name: Lint
         run: pnpm run lint
+
+      - name: Check formatting
+        run: pnpm prettier --check .

.gitignore

@@ -72,6 +72,7 @@ versions.json
 # Dist
 /dist
 /docs/.vitepress/dist
+/docs/api/typedoc.json
 /lib
 
 # Faker

.vscode/extensions.json

@@ -1,3 +1,7 @@
 {
-  "recommendations": ["editorconfig.editorconfig", "esbenp.prettier-vscode"]
+  "recommendations": [
+    "dbaeumer.vscode-eslint",
+    "editorconfig.editorconfig",
+    "esbenp.prettier-vscode"
+  ]
 }

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+  // Enable eslint validation for js and ts files
+  "eslint.validate": ["javascript", "typescript"],
+
+  // Always use the `package.json`'s `typescript`
+  "typescript.tsdk": "node_modules/typescript/lib"
+}

CODE_OF_CONDUCT.md

@@ -35,7 +35,7 @@ This Code of Conduct applies both within project spaces and in public spaces whe
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by [contacting a Moderator or Maintainer via Discord](https://discord.com/invite/4qDjAmDj4P). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by [contacting a Moderator or Maintainer via Discord](https://chat.fakerjs.dev). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
 
 Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
 

README.md

@@ -3,7 +3,7 @@
   <h1>Faker</h1>
   <p>Generate massive amounts of fake (but realistic) data for testing and development.</p>
 
-  [![Chat on Discord](https://img.shields.io/discord/929487054990110771)](https://discord.com/invite/4qDjAmDj4P)
+  [![Chat on Discord](https://img.shields.io/discord/929487054990110771)](https://chat.fakerjs.dev)
   [![Continuous Integration](https://github.com/faker-js/faker/actions/workflows/ci.yml/badge.svg)](https://github.com/faker-js/faker/actions/workflows/ci.yml)
   [![npm version](https://badgen.net/npm/v/@faker-js/faker)](https://www.npmjs.com/package/@faker-js/faker)
   [![npm downloads](https://badgen.net/npm/dm/@faker-js/faker)](https://www.npmjs.com/package/@faker-js/faker)

docs/.vitepress/.gitignore

@@ -0,0 +1 @@
+api-pages.mjs

docs/.vitepress/config.mjs

@@ -1,4 +1,5 @@
 import { defineConfig } from 'vitepress';
+import { apiPages } from './api-pages.mjs';
 
 const nav = [
   { text: 'Guide', link: '/guide/' },
@@ -22,61 +23,7 @@ const sidebar = {
     },
     {
       text: 'API',
-      children: [
-        {
-          text: 'Address',
-          link: '/api/address',
-          collapsable: false, // optional, defaults to true
-        },
-        {
-          text: 'Commerce',
-          link: '/api/commerce',
-        },
-        {
-          text: 'Company',
-          link: '/api/company',
-        },
-        {
-          text: 'Database',
-          link: '/api/database',
-        },
-        {
-          text: 'Datatype',
-          link: '/api/datatype',
-        },
-        {
-          text: 'Date',
-          link: '/api/date',
-        },
-        {
-          text: 'Fake',
-          link: '/api/fake',
-        },
-        {
-          text: 'Finance',
-          link: '/api/finance',
-        },
-        {
-          text: 'Hacker',
-          link: '/api/hacker',
-        },
-        {
-          text: 'Helpers',
-          link: '/api/helpers',
-        },
-        {
-          text: 'Image',
-          link: '/api/image',
-        },
-        {
-          text: 'Internet',
-          link: '/api/internet',
-        },
-        {
-          text: 'Localization',
-          link: '/api/localization',
-        },
-      ],
+      children: apiPages,
     },
     {
       text: 'Migrating from Faker v5',

docs/api/.gitignore

@@ -0,0 +1,3 @@
+*.md
+!fake.md
+!localization.md