Merge branch 'main' into refactor-datatype-number

Author: Shinigami92

package.json

@@ -57,6 +57,7 @@
     "build": "run-s build:clean build:code build:types",
     "generate:api-docs": "esno ./scripts/apidoc.ts",
     "generate:locales": "esno ./scripts/generateLocales.ts",
+    "copy:mime-types": "esno ./scripts/copyMimeTypes.ts",
     "docs:build": "run-s docs:prepare docs:build:run",
     "docs:build:run": "vitepress build docs",
     "docs:build:ci": "run-s build docs:build",
@@ -108,6 +109,7 @@
     "eslint-plugin-prettier": "~4.0.0",
     "esno": "~0.14.1",
     "lint-staged": "~12.3.7",
+    "mime-db": "~1.52.0",
     "npm-run-all": "~4.1.5",
     "picocolors": "~1.0.0",
     "prettier": "2.6.2",

pnpm-lock.yaml

@@ -1,11 +1,13 @@
 import { writeFileSync } from 'node:fs';
 import { resolve } from 'node:path';
-import type { Options } from 'prettier';
-import { format } from 'prettier';
-import prettierConfig from '../../.prettierrc.cjs';
 import type { Method } from '../../docs/.vitepress/components/api-docs/method';
 import type { PageIndex } from './utils';
-import { pathDocsDir, pathOutputDir } from './utils';
+import {
+  formatMarkdown,
+  formatTypescript,
+  pathDocsDir,
+  pathOutputDir,
+} from './utils';
 
 const pathDocsApiPages = resolve(pathDocsDir, '.vitepress', 'api-pages.ts');
 
@@ -18,21 +20,6 @@ editLink: false
 
 `;
 
-const prettierMarkdown: Options = {
-  ...prettierConfig,
-  parser: 'markdown',
-};
-
-const prettierTypescript: Options = {
-  ...prettierConfig,
-  parser: 'typescript',
-};
-
-const prettierBabel: Options = {
-  ...prettierConfig,
-  parser: 'babel',
-};
-
 /**
  * Writes the api page for the given module to the correct location.
  *
@@ -75,7 +62,7 @@ export function writeApiDocsModulePage(
   <ApiDocsMethod v-for="method of methods" :key="method.name" :method="method" v-once />
   `.replace(/\n +/g, '\n');
 
-  content = vitePressInFileOptions + format(content, prettierMarkdown);
+  content = vitePressInFileOptions + formatMarkdown(content);
 
   writeFileSync(resolve(pathOutputDir, lowerModuleName + '.md'), content);
 }
@@ -98,7 +85,7 @@ export function writeApiDocsDirectPage(methodName: string): void {
   <ApiDocsMethod v-for="method of methods" :key="method.name" :method="method" v-once />
   `.replace(/\n +/g, '\n');
 
-  content = vitePressInFileOptions + format(content, prettierMarkdown);
+  content = vitePressInFileOptions + formatMarkdown(content);
 
   writeFileSync(resolve(pathOutputDir, methodName + '.md'), content);
 }
@@ -122,7 +109,7 @@ export const ${lowerModuleName}: Method[] = ${JSON.stringify(
     2
   )}`;
 
-  contentTs = format(contentTs, prettierTypescript);
+  contentTs = formatTypescript(contentTs);
 
   writeFileSync(resolve(pathOutputDir, lowerModuleName + '.ts'), contentTs);
 }
@@ -142,7 +129,7 @@ export function writeApiPagesIndex(pages: PageIndex): void {
     export const apiPages = ${JSON.stringify(pages)};
     `.replace(/\n +/, '\n');
 
-  apiPagesContent = format(apiPagesContent, prettierBabel);
+  apiPagesContent = formatTypescript(apiPagesContent);
 
   writeFileSync(pathDocsApiPages, apiPagesContent);
 }

scripts/apidoc/apiDocsWriter.ts

@@ -1,6 +1,6 @@
 import * as TypeDoc from 'typedoc';
 import type { Method } from '../../docs/.vitepress/components/api-docs/method';
-import faker from '../../src';
+import { faker } from '../../src';
 import { writeApiDocsData, writeApiDocsModulePage } from './apiDocsWriter';
 import { analyzeSignature, toBlock } from './signature';
 import type { PageIndex } from './utils';

scripts/apidoc/moduleMethods.ts

@@ -14,8 +14,8 @@ import type {
   Method,
   MethodParameter,
 } from '../../docs/.vitepress/components/api-docs/method';
-import faker from '../../src';
-import { pathOutputDir } from './utils';
+import { faker } from '../../src';
+import { formatTypescript, pathOutputDir } from './utils';
 // TODO ST-DDT 2022-02-20: Actually import this/fix module import errors
 // import vitepressConfig from '../../docs/.vitepress/config';
 
@@ -228,6 +228,11 @@ function typeToText(type_: Type, short = false): string {
     case 'reference':
       if (!type.typeArguments || !type.typeArguments.length) {
         return type.name;
+      } else if (type.name === 'LiteralUnion') {
+        return [
+          typeToText(type.typeArguments[0]),
+          typeToText(type.typeArguments[1]),
+        ].join(' | ');
       } else {
         return `${type.name}<${type.typeArguments
           .map((t) => typeToText(t, short))
@@ -240,6 +245,8 @@ function typeToText(type_: Type, short = false): string {
         type.indexType,
         short
       )}]`;
+    case 'literal':
+      return formatTypescript(type.toString()).replace(/;\n$/, '');
     default:
       return type.toString();
   }

scripts/apidoc/signature.ts

@@ -1,5 +1,8 @@
 import { resolve } from 'node:path';
+import type { Options } from 'prettier';
+import { format } from 'prettier';
 import * as TypeDoc from 'typedoc';
+import prettierConfig from '../../.prettierrc.cjs';
 import {
   DefaultParameterAwareSerializer,
   parameterDefaultReader,
@@ -44,3 +47,31 @@ export function newTypeDocApp(): TypeDoc.Application {
 export function patchProject(project: TypeDoc.ProjectReflection): void {
   patchProjectParameterDefaults(project);
 }
+
+/**
+ * Formats markdown contents.
+ *
+ * @param text The text to format.
+ */
+export function formatMarkdown(text: string): string {
+  return format(text, prettierMarkdown);
+}
+
+/**
+ * Formats typedoc contents.
+ *
+ * @param text The text to format.
+ */
+export function formatTypescript(text: string): string {
+  return format(text, prettierTypescript);
+}
+
+const prettierMarkdown: Options = {
+  ...prettierConfig,
+  parser: 'markdown',
+};
+
+const prettierTypescript: Options = {
+  ...prettierConfig,
+  parser: 'typescript',
+};

scripts/apidoc/utils.ts

@@ -0,0 +1,39 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import type { Options } from 'prettier';
+import { format } from 'prettier';
+import options from '../.prettierrc.cjs';
+
+const rootPath = path.resolve(__dirname, '..');
+const mimeDbPath = path.resolve(rootPath, 'node_modules/mime-db/db.json');
+const mimeDbLicencePath = path.resolve(
+  rootPath,
+  'node_modules/mime-db/LICENSE'
+);
+const mimeTypesTsPath = path.resolve(
+  rootPath,
+  'src/locales/en/system/mimeTypes.ts'
+);
+const prettierTsOptions: Options = { ...options, parser: 'typescript' };
+fs.readFile(mimeDbPath, 'utf8', (err, data) => {
+  if (err) {
+    throw err;
+  }
+
+  const licence = fs.readFileSync(mimeDbLicencePath, { encoding: 'utf8' });
+  const mimeTypeFileContent = `// This file is generated by scripts/copyMimeTypes.ts\n// Do not edit this file directly. Instead, update mime-db and run \`pnpm run copy:mime-types\`\n\n/*\n${
+    licence as string
+  }*/\n\nexport default ${data as string};\n`;
+
+  fs.writeFile(
+    mimeTypesTsPath,
+    format(mimeTypeFileContent, prettierTsOptions),
+    (err) => {
+      if (err) {
+        throw err;
+      }
+
+      console.log(`Mime types copied to ${mimeTypesTsPath as string}`);
+    }
+  );
+});

scripts/copyMimeTypes.ts

@@ -128,7 +128,7 @@ export class Address {
     if (zipRange) {
       return String(this.faker.datatype.number(zipRange));
     }
-    return this.faker.address.zipCode();
+    return this.zipCode();
   }
 
   /**
@@ -228,7 +228,7 @@ export class Address {
    */
   streetName(): string {
     let result: string;
-    let suffix = this.faker.address.streetSuffix();
+    let suffix = this.streetSuffix();
     if (suffix !== '') {
       suffix = ' ' + suffix;
     }
@@ -498,7 +498,7 @@ export class Address {
   ): [string, string] {
     // If there is no coordinate, the best we can do is return a random GPS coordinate.
     if (coordinate === undefined) {
-      return [this.faker.address.latitude(), this.faker.address.longitude()];
+      return [this.latitude(), this.longitude()];
     }
 
     radius = radius || 10.0;

src/address.ts

@@ -46,11 +46,11 @@ export class Commerce {
    */
   productName(): string {
     return (
-      this.faker.commerce.productAdjective() +
+      this.productAdjective() +
       ' ' +
-      this.faker.commerce.productMaterial() +
+      this.productMaterial() +
       ' ' +
-      this.faker.commerce.product()
+      this.product()
     );
   }
 

src/commerce.ts

@@ -1,15 +1,10 @@
 import type { Faker } from '.';
-import type { Fake } from './fake';
-
-let f: Fake['fake'];
 
 /**
  * Module to generate company related entries.
  */
 export class Company {
   constructor(private readonly faker: Faker) {
-    f = this.faker.fake;
-
     // Bind `this` so namespaced is working correctly
     for (const name of Object.getOwnPropertyNames(Company.prototype)) {
       if (name === 'constructor' || typeof this[name] !== 'function') {
@@ -49,7 +44,7 @@ export class Company {
       format = this.faker.datatype.number(formats.length - 1);
     }
 
-    return f(formats[format]);
+    return this.faker.fake(formats[format]);
   }
 
   /**
@@ -59,7 +54,7 @@ export class Company {
    * faker.company.companySuffix() // 'and Sons'
    */
   companySuffix(): string {
-    return this.faker.random.arrayElement(this.faker.company.suffixes());
+    return this.faker.random.arrayElement(this.suffixes());
   }
 
   /**
@@ -69,7 +64,7 @@ export class Company {
    * faker.company.catchPhrase() // 'Upgradable systematic flexibility'
    */
   catchPhrase(): string {
-    return f(
+    return this.faker.fake(
       '{{company.catchPhraseAdjective}} {{company.catchPhraseDescriptor}} {{company.catchPhraseNoun}}'
     );
   }
@@ -81,7 +76,9 @@ export class Company {
    * faker.company.bs() // 'cultivate synergistic e-markets'
    */
   bs(): string {
-    return f('{{company.bsBuzz}} {{company.bsAdjective}} {{company.bsNoun}}');
+    return this.faker.fake(
+      '{{company.bsBuzz}} {{company.bsAdjective}} {{company.bsNoun}}'
+    );
   }
 
   /**