docs: Faker and utility pages #1940

cypress/e2e/api.cy.ts

@@ -43,7 +43,7 @@ describe('API Test', () => {
 
         cy.request({
           method: 'HEAD',
-          url: `/api/${link}`,
+          url: link,
           failOnStatusCode: false,
         })
           .should(({ status }) => {

docs/.vitepress/api-pages.ts

@@ -2,6 +2,7 @@
 // Run 'pnpm run generate:api-docs' to update
 export const apiPages = [
   { text: 'Overview', link: '/api/' },
+  { text: 'Faker', link: '/api/faker.html' },
   { text: 'Airline', link: '/api/airline.html' },
   { text: 'Animal', link: '/api/animal.html' },
   { text: 'Color', link: '/api/color.html' },
@@ -28,4 +29,5 @@ export const apiPages = [
   { text: 'System', link: '/api/system.html' },
   { text: 'Vehicle', link: '/api/vehicle.html' },
   { text: 'Word', link: '/api/word.html' },
+  { text: 'Utilities', link: '/api/utils.html' },
 ];

docs/.vitepress/components/api-docs/method.ts

@@ -1,6 +1,5 @@
 export interface Method {
   readonly name: string;
-  readonly title: string;
   readonly description: string; // HTML
   readonly parameters: MethodParameter[];
   readonly returns: string;

docs/.vitepress/components/api-docs/method.vue

@@ -8,6 +8,9 @@ const props = defineProps<{ method: Method }>();
 
 function seeAlsoToUrl(see: string): string {
   const [, module, method] = see.replace(/\(.*/, '').split('\.');
+  if (!method) {
+    return 'faker.html#' + slugify(module);
+  }
   return module + '.html#' + slugify(method);
 }
 </script>

docs/api/ApiIndex.vue

@@ -97,13 +97,11 @@ onUnmounted(() => window.removeEventListener('keydown', apiSearchFocusHandler));
       <div class="api-groups">
         <div v-for="item of section.items" :key="item.text" class="api-group">
           <h3>
-            <a :href="item.link + '.html'">{{ item.text }}</a>
+            <a :href="item.link">{{ item.text }}</a>
           </h3>
           <ul>
             <li v-for="h of item.headers" :key="h.anchor">
-              <a :href="item.link + '.html#' + slugify(h.anchor)">{{
-                h.text
-              }}</a>
+              <a :href="item.link + '#' + slugify(h.anchor)">{{ h.text }}</a>
             </li>
           </ul>
         </div>

docs/guide/localization.md

@@ -128,6 +128,7 @@ In this example there are 5 locales. Each of these is checked in order, and the
 | `sk`          | Slovakian                 | `fakerSK`          |
 | `sr_RS_latin` | Serbian (Latin)           | `fakerSR_RS_latin` |
 | `sv`          | Swedish                   | `fakerSV`          |
+| `th`          | Thai                      | `fakerTH`          |
 | `tr`          | Turkish                   | `fakerTR`          |
 | `uk`          | Ukrainian                 | `fakerUK`          |
 | `ur`          | Urdu                      | `fakerUR`          |

package.json

@@ -57,6 +57,7 @@
     "build:code": "tsx ./scripts/bundle.ts",
     "build:types": "tsc --emitDeclarationOnly --outDir dist/types",
     "build": "run-s build:clean build:code build:types",
+    "generate": "run-s generate:locales generate:api-docs",
     "generate:api-docs": "tsx ./scripts/apidoc.ts",
     "generate:locales": "tsx ./scripts/generateLocales.ts",
     "docs:build": "run-s docs:prepare docs:build:run",
@@ -69,6 +70,7 @@
     "docs:diff": "tsx ./scripts/diff.ts",
     "format": "prettier --cache --write .",
     "lint": "eslint --cache --cache-strategy content .",
+    "ts-check": "run-s ts-check:scripts ts-check:tests",
     "ts-check:scripts": "tsc --project tsconfig.check-scripts.json",
     "ts-check:tests": "tsc --project tsconfig.check-tests.json",
     "test": "vitest",
@@ -80,14 +82,14 @@
     "docs:test:e2e:open": "run-p --race docs:serve \"cypress open\"",
     "release": "standard-version",
     "prepublishOnly": "pnpm run clean && pnpm install && pnpm run build",
-    "preflight": "pnpm install && run-s generate:* format lint build test:update-snapshots"
+    "preflight": "pnpm install && run-s generate format lint build test:update-snapshots ts-check"
   },
   "devDependencies": {
     "@actions/github": "~5.1.1",
     "@algolia/client-search": "~4.16.0",
     "@types/glob": "~8.1.0",
     "@types/markdown-it": "~12.2.3",
-    "@types/node": "~18.15.10",
+    "@types/node": "~18.15.11",
     "@types/prettier": "~2.7.2",
     "@types/react": "~18.0.29",
     "@types/sanitize-html": "~2.9.0",
@@ -100,16 +102,16 @@
     "@vueuse/core": "~9.13.0",
     "c8": "~7.13.0",
     "conventional-changelog-cli": "~2.2.2",
-    "cypress": "~12.8.1",
-    "esbuild": "~0.17.14",
-    "eslint": "~8.36.0",
+    "cypress": "~12.9.0",
+    "esbuild": "~0.17.15",
+    "eslint": "~8.37.0",
     "eslint-config-prettier": "~8.8.0",
     "eslint-define-config": "~1.17.0",
     "eslint-gitignore": "~0.1.0",
-    "eslint-plugin-deprecation": "~1.3.3",
-    "eslint-plugin-jsdoc": "~40.1.0",
+    "eslint-plugin-deprecation": "~1.4.0",
+    "eslint-plugin-jsdoc": "~40.1.1",
     "eslint-plugin-prettier": "~4.2.1",
-    "glob": "~9.3.2",
+    "glob": "~9.3.4",
     "npm-run-all": "~4.1.5",
     "picocolors": "~1.0.0",
     "prettier": "2.8.7",