feat: standalone module functions #3748

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft

ST-DDT wants to merge 25 commits into next from feat/standalone-module-functions

scripts/generate-module-tree.ts

-Original file line number
+Diff line change
@@ -0,0 +1,208 @@
+    import { writeFileSync } from 'node:fs';
+    import { resolve } from 'node:path';
+    import { SyntaxKind } from 'ts-morph';
+    import { getDeprecated, getJsDocs } from './apidocs/processing/jsdocs';
+    import { getProject } from './apidocs/project';
+    import { toCamelCase, toKebabCase } from './shared/character-case';
+    import { formatTypescript } from './shared/format';
+    import { FILE_PATH_SRC } from './shared/paths';
+    const project = getProject();
+    const directories = project
+      .getDirectoryOrThrow('src')
+      .getDirectoryOrThrow('modules')
+      .getDirectories();
+    const moduleNames = new Set(directories.map((dir) => dir.getBaseName()));
+    //#region Module
+    for (const directory of directories) {
+      const moduleName = directory.getBaseName();
+      console.log(`Processing module: ${moduleName}`);
+      //#region Module
+      const moduleFile = directory.getSourceFileOrThrow('module.ts');
+      const header = moduleFile
+        .getStatements()[0]
+        ?.getLeadingCommentRanges()
+        .map((c) => c.getText());
+      const imports = new Set([
+        `import { SimpleModuleBase } from '../../internal/module-base';`,
+        `import { ModuleBase } from '../../internal/module-base';`,
+        `import type { Faker } from '../../faker';`,
+        `import type { Casing, NumberRange } from '../../utils/types';`,
+        `import type { LiteralUnion } from '../../internal/types';`,
+        `import type { Distributor } from '../../distributors/distributor';`,
+      ]);
+      if (moduleName === 'image') {
+        imports.add(`import type { SexType } from '../person';`);
+      }
+      const exports: string[] = moduleFile
+        .getExportDeclarations()
+        .map((exp) => exp.getText());
+      const typesFile = directory.getSourceFile('_types.ts');
+      if (typesFile) {
+        const typesToImport = [
+          typesFile.getEnums(),
+          typesFile.getTypeAliases(),
+          typesFile.getInterfaces(),
+        ]
+          .flat()
+          .filter((decl) => decl.isExported())
+          .map((decl) => decl.getName());
+        if (typesToImport.length > 0) {
+          imports.add(
+            `import type { ${typesToImport.join(', ')} } from './_types';`
+          );
+        }
+      }
+      const content: string[] = [];
+      const classes = moduleFile?.getClasses() ?? [];
+      //#region Module Classes
+      for (const cls of classes) {
+        content.push(getJsDocs(cls).getText());
+        const methodNames = cls.getMethods().map((method) => method.getName());
+        for (const method of cls.getMethods()) {
+          if (method.getName() !== 'fake') {
+            method.remove();
+          }
+        }
+        for (const methodName of methodNames) {
+          if (methodName === 'fake') {
+            continue;
+          }
+          const methodFile = directory.getSourceFileOrThrow(
+            `${toKebabCase(methodName)}.ts`
+          );
+          const typesToImport = [
+            methodFile.getEnums(),
+            methodFile.getTypeAliases(),
+            methodFile.getInterfaces(),
+          ]
+            .flat()
+            .filter((decl) => decl.isExported())
+            .map((decl) => decl.getName());
+          imports.add(
+            `import { ${methodName} as ${toCamelCase(moduleName, methodName)} } from './${toKebabCase(methodName)}';`
+          );
+          if (typesToImport.length > 0) {
+            imports.add(
+              `import type { ${typesToImport.join(', ')} } from './${toKebabCase(methodName)}';`
+            );
+          }
+          const functions = methodFile
+            .getChildrenOfKind(SyntaxKind.FunctionDeclaration)
+            .filter((fn) => fn.isExported())
+            .filter((fn) => fn.getName() === methodName);
+          const parts: string[] = [];
+          const restoreFakerTreeInvocations = (
+            _: string,
+            module: string,
+            method: string
+          ): string =>
+            methodNames.includes(`${module}${method}`)
+              ? `faker.${moduleName}.${module}${method}(`
+              : moduleNames.has(module)
+                ? `faker.${module}.${toCamelCase(method)}(`
+                : `faker.${module}${method}(`;
+          for (const child of functions) {
+            //#region Module Functions
+            const jsDocs = child.getJsDocs()[0];
+            if (child.hasBody()) {
+              const params = child
+                .getSignature()
+                .getParameters()
+                .slice(1)
+                .map((param) => param.getName());
+              const isDeprecated = jsDocs && getDeprecated(jsDocs);
+              child.setBodyText(
+                `${
+                  isDeprecated
+                    ? '// eslint-disable-next-line @typescript-eslint/no-deprecated -- Internal call\n'
+                    : ''
+                }return ${toCamelCase(moduleName, methodName)}(this.faker.fakerCore, ${params.join(', ')});`
+              );
+            }
+            if (jsDocs) {
+              const description = jsDocs
+                .getFullText()
+                // Param
+                .replace(' * @param fakerCore The FakerCore to use.\n', '')
+                .replaceAll(/ +\*\n +\*\n/g, ' *\n')
+                // Examples
+                .replaceAll(
+                  new RegExp(`${methodName}\\(fakerCore(?:, ?)?`, 'g'),
+                  `faker.${moduleName}.${methodName}(`
+                )
+                // Method References
+                .replaceAll(
+                  /\b([a-z]+)([A-Z][a-zA-Z]+)\(fakerCore(?:, ?)?/g,
+                  restoreFakerTreeInvocations
+                )
+                .replaceAll(
+                  /\b([a-zA-Z]+)\(fakerCore(?:, ?)?/g,
+                  (_, method: string) =>
+                    `faker.${moduleName}.${toCamelCase(method)}(`
+                );
+              parts.push(description);
+            }
+            const signature = child
+              .getSignature()
+              .getDeclaration()
+              .getText()
+              // Adapt signature
+              .replace('export function ', '')
+              .replace(/\((\n +)?fakerCore: FakerCore,?/, '(')
+              // Adapt nested options defaults
+              .replaceAll(
+                /(?<= +\* .*?)\bgetDefaultRefDate\(fakerCore(?:, ?)?/g,
+                'faker.defaultRefDate('
+              )
+              .replaceAll(
+                /(?<= +\* .*?)\b([a-z]+)([A-Z][a-zA-Z]+)\(fakerCore(?:, ?)?/g,
+                restoreFakerTreeInvocations
+              );
+            parts.push(signature);
+            //#endregion
+          }
+          cls.addMember(parts.join('\n'));
+        }
+        //#endregion
+        content.push(cls.getText(), '');
+      }
+      content.unshift(...header, ...imports, '', ...exports, '');
+      writeFileSync(
+        resolve(FILE_PATH_SRC, 'modules', moduleName, 'module.ts'),
+        await formatTypescript(content.join('\n')),
+        'utf8'
+      );
+      //#endregion
+    }
+    //#endregion

scripts/shared/character-case.ts

-Original file line number
+Diff line change
@@ -0,0 +1,19 @@
+    export function toKebabCase(...values: string[]): string {
+      return values
+        .join('-')
+        .replaceAll(/([a-z])([A-Z])/g, '$1-$2')
+        .replaceAll(/[\s_]+/g, '-')
+        .toLowerCase();
+    }
+    export function toCamelCase(...values: string[]): string {
+      const text = values
+        .flatMap((value) => value.split(/[\s_-]+/))
+        .map(toPascalCase)
+        .join('');
+      return text.substring(0, 1).toLowerCase() + text.substring(1);
+    }
+    export function toPascalCase(value: string): string {
+      return value.substring(0, 1).toUpperCase() + value.substring(1);
+    }

scripts/shared/paths.ts

-Original file line number
+Diff line change
@@ Expand Up @@
     /**
      * The path to the src directory.
      */
-    const FILE_PATH_SRC = resolve(FILE_PATH_PROJECT, 'src');
+    export const FILE_PATH_SRC = resolve(FILE_PATH_PROJECT, 'src');
     /**
      * The path to the locale source files.
      */
@@ Expand Down @@

Navigation Menu

Uh oh!

Uh oh!

feat: standalone module functions #3748

Uh oh!

Diff view

Diff view

Uh oh!

There are no files selected for viewing

Uh oh!

Uh oh!

Uh oh!

Uh oh!

feat: standalone module functions #3748

Are you sure you want to change the base?

Uh oh!

feat: standalone module functions #3748

Uh oh!

Diff view

Diff view

Uh oh!

There are no files selected for viewing

Uh oh!

Uh oh!