Merge branch 'next' into refactor/string/rename-special-to-symbol

Author: ST-DDT

scripts/apidoc.ts

@@ -1,45 +1,11 @@
-import { resolve } from 'path';
 import { faker } from '../src';
-import {
-  writeApiPagesIndex,
-  writeApiSearchIndex,
-} from './apidoc/apiDocsWriter';
-import { processModuleMethods } from './apidoc/moduleMethods';
+import { generate } from './apidoc/generate';
 import { initMarkdownRenderer } from './apidoc/signature';
-import { newTypeDocApp, patchProject } from './apidoc/typedoc';
-import type { PageIndex } from './apidoc/utils';
-import { pathOutputDir } from './apidoc/utils';
-
-const pathOutputJson = resolve(pathOutputDir, 'typedoc.json');
 
 async function build(): Promise<void> {
   await initMarkdownRenderer();
   faker.setDefaultRefDate(Date.UTC(2023, 0, 1));
-
-  const app = newTypeDocApp();
-
-  app.bootstrap({
-    entryPoints: ['src/index.ts'],
-    pretty: true,
-    cleanOutputDir: true,
-  });
-
-  const project = app.convert();
-
-  if (!project) {
-    throw new Error('Failed to convert project');
-  }
-
-  // Useful for manually analyzing the content
-  await app.generateJson(project, pathOutputJson);
-
-  patchProject(project);
-
-  const modulesPages: PageIndex = [];
-  modulesPages.push(...processModuleMethods(project));
-  writeApiPagesIndex(modulesPages);
-
-  writeApiSearchIndex(project);
+  await generate();
 }
 
 build().catch(console.error);

scripts/apidoc/generate.ts

@@ -0,0 +1,22 @@
+import { resolve } from 'path';
+import { writeApiPagesIndex, writeApiSearchIndex } from './apiDocsWriter';
+import { processModuleMethods } from './moduleMethods';
+import { loadProject } from './typedoc';
+import { pathOutputDir } from './utils';
+
+const pathOutputJson = resolve(pathOutputDir, 'typedoc.json');
+
+/**
+ * Generates the API documentation.
+ */
+export async function generate(): Promise<void> {
+  const [app, project] = loadProject();
+
+  // Useful for manually analyzing the content
+  await app.generateJson(project, pathOutputJson);
+
+  const modules = processModuleMethods(project);
+  writeApiPagesIndex(modules);
+
+  writeApiSearchIndex(project);
+}

scripts/apidoc/typedoc.ts

@@ -4,6 +4,7 @@ import type {
   DeclarationReflection,
   ProjectReflection,
   SignatureReflection,
+  TypeDocOptions,
 } from 'typedoc';
 import {
   Application,
@@ -19,10 +20,38 @@ import {
 } from './parameterDefaults';
 import { mapByName } from './utils';
 
+/**
+ * Loads the project using TypeDoc.
+ *
+ * @param options The options to use for the project.
+ * @returns The TypeDoc application and the project reflection.
+ */
+export function loadProject(
+  options: Partial<TypeDocOptions> = {
+    entryPoints: ['src/index.ts'],
+    pretty: true,
+    cleanOutputDir: true,
+  }
+): [Application, ProjectReflection] {
+  const app = newTypeDocApp();
+
+  app.bootstrap(options);
+
+  const project = app.convert();
+
+  if (!project) {
+    throw new Error('Failed to convert project');
+  }
+
+  patchProjectParameterDefaults(project);
+
+  return [app, project];
+}
+
 /**
  * Creates and configures a new typedoc application.
  */
-export function newTypeDocApp(): Application {
+function newTypeDocApp(): Application {
   const app = new Application();
 
   app.options.addReader(new TSConfigReader());
@@ -37,17 +66,6 @@ export function newTypeDocApp(): Application {
   return app;
 }
 
-/**
- * Apply our patches to the generated typedoc data.
- *
- * This is moved to a separate method to allow printing/saving the original content before patching it.
- *
- * @param project The project to patch.
- */
-export function patchProject(project: ProjectReflection): void {
-  patchProjectParameterDefaults(project);
-}
-
 /**
  * Selects the modules from the project that needs to be documented.
  *

scripts/generateLocales.ts

@@ -132,7 +132,7 @@ function tryLoadLocalesMainIndexFile(pathModules: string): LocaleDefinition {
   let localeDef: LocaleDefinition;
   // This call might fail, if the module setup is broken.
   // Unfortunately, we try to fix it with this script
-  // Thats why have a fallback logic here, we only need the title and separator anyway
+  // Thats why have a fallback logic here, we only need the title anyway
   try {
     // eslint-disable-next-line @typescript-eslint/no-var-requires
     localeDef = require(pathModules).default;
@@ -147,7 +147,6 @@ function tryLoadLocalesMainIndexFile(pathModules: string): LocaleDefinition {
       );
       localeDef = {
         title: localeIndex.match(/title: '(.*)',/)[1],
-        separator: localeIndex.match(/separator: '(.*)',/)?.[1],
       };
     } catch {
       console.error(`Failed to load ${pathModules} or manually parse it.`, e);
@@ -287,7 +286,6 @@ for (const locale of locales) {
   const localeDef = tryLoadLocalesMainIndexFile(pathModules);
   // We use a fallback here to at least generate a working file.
   const localeTitle = localeDef?.title ?? `TODO: Insert Title for ${locale}`;
-  const localeSeparator = localeDef?.separator;
 
   localeIndexImports += `import ${locale} from './${locale}';\n`;
   localeIndexType += `  | '${locale}'\n`;
@@ -298,14 +296,12 @@ for (const locale of locales) {
   generateLocaleFile(locale);
 
   // src/locales/**/index.ts
-  const separator = localeSeparator ? `\nseparator: '${localeSeparator}',` : '';
-
   generateRecursiveModuleIndexes(
     pathModules,
     locale,
     'LocaleDefinition',
     1,
-    `title: '${localeTitle}',${separator}`
+    `title: '${localeTitle}',`
   );
 }
 

src/definitions/definitions.ts

@@ -56,5 +56,4 @@ export type LocaleDefinition = {
    * The name of the language.
    */
   title: string;
-  separator?: string;
 } & LocaleEntry<Definitions>;

src/faker.ts

@@ -42,10 +42,7 @@ export interface FakerOptions {
   localeFallback?: UsableLocale;
 }
 
-const metadataKeys: ReadonlyArray<keyof LocaleDefinition> = [
-  'title',
-  'separator',
-];
+const metadataKeys: ReadonlyArray<keyof LocaleDefinition> = ['title'];
 
 export class Faker {
   locales: UsedLocales;

src/locales/ar/index.ts

@@ -15,7 +15,6 @@ import vehicle from './vehicle';
 
 const ar: LocaleDefinition = {
   title: 'Arabic',
-  separator: ' & ',
   cell_phone,
   color,
   commerce,

src/locales/az/index.ts

@@ -14,7 +14,6 @@ import phone_number from './phone_number';
 
 const az: LocaleDefinition = {
   title: 'Azerbaijani',
-  separator: ' və ',
   color,
   commerce,
   company,

src/locales/el/index.ts

@@ -20,7 +20,6 @@ import team from './team';
 
 const el: LocaleDefinition = {
   title: 'Greek',
-  separator: ' & ',
   app,
   business,
   cell_phone,

src/locales/en/index.ts

@@ -28,7 +28,6 @@ import word from './word';
 
 const en: LocaleDefinition = {
   title: 'English',
-  separator: ' & ',
   animal,
   app,
   business,

src/locales/es_MX/index.ts

@@ -16,7 +16,6 @@ import team from './team';
 
 const es_MX: LocaleDefinition = {
   title: 'Spanish (Mexico)',
-  separator: ' & ',
   cell_phone,
   color,
   commerce,

src/locales/ge/index.ts

@@ -12,7 +12,6 @@ import phone_number from './phone_number';
 
 const ge: LocaleDefinition = {
   title: 'Georgian',
-  separator: ' და ',
   cell_phone,
   company,
   internet,

src/locales/he/index.ts

@@ -15,7 +15,6 @@ import phone_number from './phone_number';
 
 const he: LocaleDefinition = {
   title: 'Hebrew',
-  separator: 'ו ',
   cell_phone,
   color,
   commerce,

src/locales/hy/index.ts

@@ -13,7 +13,6 @@ import phone_number from './phone_number';
 
 const hy: LocaleDefinition = {
   title: 'Armenian',
-  separator: ' և ',
   color,
   date,
   internet,

src/locales/lv/index.ts

@@ -16,7 +16,6 @@ import phone_number from './phone_number';
 
 const lv: LocaleDefinition = {
   title: 'Latvian',
-  separator: ' un ',
   cell_phone,
   color,
   commerce,

src/locales/mk/index.ts

@@ -13,7 +13,6 @@ import phone_number from './phone_number';
 
 const mk: LocaleDefinition = {
   title: 'Macedonian',
-  separator: ' и ',
   cell_phone,
   company,
   date,

src/locales/ru/index.ts

@@ -16,7 +16,6 @@ import phone_number from './phone_number';
 
 const ru: LocaleDefinition = {
   title: 'Russian',
-  separator: ' и ',
   color,
   commerce,
   company,

src/locales/ur/index.ts

@@ -20,7 +20,6 @@ import vehicle from './vehicle';
 
 const ur: LocaleDefinition = {
   title: 'Urdu',
-  separator: ' اور ',
   animal,
   app,
   business,

src/modules/internet/user-agent.ts

@@ -54,30 +54,6 @@ type Browser = 'chrome' | 'iexplorer' | 'firefox' | 'safari' | 'opera';
  * @param faker An existing faker instance.
  */
 export function generate(faker: Faker): string {
-  const weightedKeyFromObject = <T extends Record<string, number>>(
-    obj: T
-  ): keyof T => {
-    //returns a random key from the passed object; keys are weighted by the decimal probability in their value
-    const rand = faker.number.int(100) / 100;
-    let min = 0;
-    let max = 0;
-    let return_val: string;
-
-    for (const key in obj) {
-      if (Object.prototype.hasOwnProperty.call(obj, key)) {
-        max = obj[key] + min;
-        return_val = key;
-        if (rand >= min && rand <= max) {
-          break;
-        }
-
-        min = min + obj[key];
-      }
-    }
-
-    return return_val;
-  };
-
   const randomLang = (): string =>
     faker.helpers.arrayElement([
       'AB',
@@ -179,39 +155,29 @@ export function generate(faker: Faker): string {
     ]);
 
   const randomBrowserAndOS = (): [Browser, OS] => {
-    const browser: Browser = weightedKeyFromObject({
-      chrome: 0.45132810566,
-      iexplorer: 0.27477061836,
-      firefox: 0.19384170608,
-      safari: 0.06186781118,
-      opera: 0.01574236955,
-    });
-    const os: OS = weightedKeyFromObject(
-      {
-        chrome: { win: 0.89, mac: 0.09, lin: 0.02 },
-        firefox: { win: 0.83, mac: 0.16, lin: 0.01 },
-        opera: { win: 0.91, mac: 0.03, lin: 0.06 },
-        safari: { win: 0.04, mac: 0.96 },
-        iexplorer: { win: 1 },
-      }[browser]
-    );
+    const browserToOsMap = {
+      chrome: ['win', 'mac', 'lin'],
+      firefox: ['win', 'mac', 'lin'],
+      opera: ['win', 'mac', 'lin'],
+      safari: ['win', 'mac'],
+      iexplorer: ['win'],
+    } satisfies Record<Browser, OS[]>;
+    const browser: Browser = faker.helpers.objectKey(browserToOsMap);
+    const os: OS = faker.helpers.arrayElement(browserToOsMap[browser]);
 
     return [browser, os];
   };
 
-  const randomProc = (arch: OS): string => {
-    const procs = {
-      lin: ['i686', 'x86_64'],
-      mac: { Intel: 0.48, PPC: 0.01, 'U; Intel': 0.48, 'U; PPC': 0.01 },
-      win: ['', 'WOW64', 'Win64; x64'],
-    };
-    const archValue = procs[arch];
-    const proc = Array.isArray(archValue)
-      ? faker.helpers.arrayElement(archValue)
-      : weightedKeyFromObject(archValue);
-
-    return proc;
-  };
+  const randomProc = (arch: OS): string =>
+    faker.helpers.arrayElement(
+      (
+        {
+          lin: ['i686', 'x86_64'],
+          mac: ['Intel', 'PPC', 'U; Intel', 'U; PPC'],
+          win: ['', 'WOW64', 'Win64; x64'],
+        } satisfies Record<OS, string[]>
+      )[arch]
+    );
 
   const randomRevision = (dots: number): string => {
     let return_val = '';