@cparra/apexdocs 3.0.0-rc.0 → 3.1.0

package/src/test-helpers/InterfaceMirrorBuilder.ts

@@ -1,39 +0,0 @@
-import { Annotation, DocComment, InterfaceMirror, MethodMirror } from '@cparra/apex-reflection';
-
-/**
- * Builder class to create Interface objects.
- * For testing purposes only.
- */
-export class InterfaceMirrorBuilder {
-  private name = 'SampleClass';
-  private annotations: Annotation[] = [];
-  private docComment?: DocComment;
-  private methods: MethodMirror[] = [];
-
-  withName(name: string): InterfaceMirrorBuilder {
-    this.name = name;
-    return this;
-  }
-
-  addAnnotation(annotation: Annotation): InterfaceMirrorBuilder {
-    this.annotations.push(annotation);
-    return this;
-  }
-
-  addMethod(method: MethodMirror): InterfaceMirrorBuilder {
-    this.methods.push(method);
-    return this;
-  }
-
-  build(): InterfaceMirror {
-    return {
-      annotations: this.annotations,
-      name: this.name,
-      type_name: 'interface',
-      methods: this.methods,
-      access_modifier: 'public',
-      docComment: this.docComment,
-      extended_interfaces: [],
-    };
-  }
-}

package/src/test-helpers/MethodMirrorBuilder.ts

@@ -1,77 +0,0 @@
-import { Annotation, DocComment, MethodMirror, ParameterMirror } from '@cparra/apex-reflection';
-
-type Parameter = ParameterMirror;
-
-export class MethodMirrorBuilder {
-  private name = 'sampleMethod';
-  private annotations: Annotation[] = [];
-  private docComment?: DocComment;
-  private typeReference: { type: string; rawDeclaration: string } = {
-    type: 'void',
-    rawDeclaration: 'void',
-  };
-  private parameters: Parameter[] = [];
-
-  withName(name: string): MethodMirrorBuilder {
-    this.name = name;
-    return this;
-  }
-
-  addAnnotation(annotation: Annotation): MethodMirrorBuilder {
-    this.annotations.push(annotation);
-    return this;
-  }
-
-  withDocComment(docComment: DocComment): MethodMirrorBuilder {
-    this.docComment = docComment;
-    return this;
-  }
-
-  withTypeReference(param: { type: string; rawDeclaration: string }) {
-    this.typeReference = param;
-    return this;
-  }
-
-  addParameter(parameter: Parameter): MethodMirrorBuilder {
-    this.parameters.push(parameter);
-    return this;
-  }
-
-  build(): MethodMirror {
-    return {
-      access_modifier: 'public',
-      annotations: this.annotations,
-      name: this.name,
-      memberModifiers: [],
-      typeReference: this.typeReference,
-      parameters: this.parameters,
-      docComment: this.docComment,
-    };
-  }
-}
-
-export class ParameterBuilder {
-  private name = 'param';
-  private typeReference: { type: string; rawDeclaration: string } = {
-    type: 'String',
-    rawDeclaration: 'String',
-  };
-
-  withName(name: string): ParameterBuilder {
-    this.name = name;
-    return this;
-  }
-
-  withTypeReference(param: { type: string; rawDeclaration: string }) {
-    this.typeReference = param;
-    return this;
-  }
-
-  build(): Parameter {
-    return {
-      memberModifiers: [],
-      name: this.name,
-      typeReference: this.typeReference,
-    };
-  }
-}

package/src/test-helpers/SettingsBuilder.ts

@@ -1,17 +0,0 @@
-import { SettingsConfig } from '../core/openApiSettings';
-
-/**
- * Builder class to create SettingsConfig objects.
- * For testing purposes only.
- */
-export class SettingsBuilder {
-  build(): SettingsConfig {
-    return {
-      sourceDirectory: './',
-      outputDir: './',
-      openApiTitle: 'Apex API',
-      openApiFileName: 'openapi',
-      version: '1.0.0',
-    };
-  }
-}

package/src/util/error-logger.ts

@@ -1,92 +0,0 @@
-import { ClassMirror, InterfaceMirror, Type } from '@cparra/apex-reflection';
-import { Logger } from './logger';
-
-export default class ErrorLogger {
-  public static logErrors(types: Type[]): void {
-    types.forEach((currentType) => {
-      this.logErrorsForSingleType(currentType);
-    });
-  }
-
-  private static logErrorsForSingleType(currentType: Type): void {
-    this.logTypeErrors(currentType);
-
-    if (currentType.type_name === 'class') {
-      this.logErrorsForClass(currentType as ClassMirror);
-    } else if (currentType.type_name === 'interface') {
-      this.logErrorsForInterface(currentType as InterfaceMirror);
-    }
-  }
-
-  private static logTypeErrors(currentType: Type, parentType?: Type) {
-    if (currentType.docComment?.error) {
-      const typeName = parentType ? `${parentType!.name}.${currentType.name}` : currentType.name;
-      Logger.error(`${typeName} - Doc comment parsing error. Level: Type`);
-      Logger.error(`Comment:\n ${currentType.docComment.rawDeclaration}`);
-      Logger.error(currentType.docComment.error);
-      Logger.error('=================================');
-    }
-  }
-
-  private static logErrorsForClass(classMirror: ClassMirror, parentType?: Type): void {
-    const typeName = parentType ? `${parentType!.name}.${classMirror.name}` : classMirror.name;
-    classMirror.constructors.forEach((currentConstructor) => {
-      if (currentConstructor.docComment?.error) {
-        Logger.error(`${typeName} - Doc comment parsing error. Level: Constructor`);
-        Logger.error(`Comment:\n ${currentConstructor.docComment.rawDeclaration}`);
-        Logger.error(currentConstructor.docComment.error);
-        Logger.error('=================================');
-      }
-    });
-
-    classMirror.fields.forEach((currentField) => {
-      if (currentField.docComment?.error) {
-        Logger.error(`${typeName} - Doc comment parsing error. Level: Field`);
-        Logger.error(`Comment:\n ${currentField.docComment.rawDeclaration}`);
-        Logger.error(currentField.docComment.error);
-        Logger.error('=================================');
-      }
-    });
-
-    classMirror.properties.forEach((currentProperty) => {
-      if (currentProperty.docComment?.error) {
-        Logger.error(`${typeName} - Doc comment parsing error. Level: Property`);
-        Logger.error(`Comment:\n ${currentProperty.docComment.rawDeclaration}`);
-        Logger.error(currentProperty.docComment.error);
-        Logger.error('=================================');
-      }
-    });
-
-    classMirror.methods.forEach((currentMethod) => {
-      if (currentMethod.docComment?.error) {
-        Logger.error(`${typeName} - Doc comment parsing error. Level: Method`);
-        Logger.error(`Comment:\n ${currentMethod.docComment.rawDeclaration}`);
-        Logger.error(currentMethod.docComment.error);
-        Logger.error('=================================');
-      }
-    });
-
-    classMirror.enums.forEach((currentEnum) => {
-      this.logErrorsForSingleType(currentEnum);
-    });
-
-    classMirror.interfaces.forEach((currentInterface) => {
-      this.logErrorsForSingleType(currentInterface);
-    });
-
-    classMirror.classes.forEach((currentClass) => {
-      this.logErrorsForSingleType(currentClass);
-    });
-  }
-
-  private static logErrorsForInterface(interfaceMirror: InterfaceMirror): void {
-    interfaceMirror.methods.forEach((currentMethod) => {
-      if (currentMethod.docComment?.error) {
-        Logger.error(`${interfaceMirror.name} - Doc comment parsing error. Level: Method`);
-        Logger.error(`Comment: ${currentMethod.docComment.rawDeclaration}`);
-        Logger.error(currentMethod.docComment.error);
-        Logger.error('=================================');
-      }
-    });
-  }
-}

package/src/util/fp.ts

@@ -1,3 +0,0 @@
-export function apply<T extends unknown[], U extends unknown[], R>(fn: (...args: [...T, ...U]) => R, ...front: T) {
-  return (...tailArgs: U) => fn(...front, ...tailArgs);
-}

package/src/util/logger.ts

@@ -1,44 +0,0 @@
-import chalk from 'chalk';
-/**
- * Logs messages to the console.
- */
-export class Logger {
-  static currentFrame = 0;
-
-  /**
-   * Logs a message with optional arguments.
-   * @param message The message to log.
-   * @param args Optional arguments.
-   */
-  public static log(message: string, ...args: string[]) {
-    this.logSingle(message);
-    args.forEach((arg) => {
-      this.logSingle(arg);
-    });
-  }
-
-  /**
-   * Logs an error message with optional arguments.
-   * @param message The error message to log.
-   * @param args Optional arguments.
-   */
-  public static error(message: unknown, ...args: string[]) {
-    this.logSingle(message, 'red');
-    args.forEach(() => {
-      this.logSingle(message, 'red');
-    });
-  }
-
-  public static logSingle(text: unknown, color: 'green' | 'red' = 'green') {
-    if (this.currentFrame > 9) {
-      this.currentFrame = 0;
-    }
-
-    const logMessage = `${this.getChalkFn(color)(new Date().toLocaleString() + ': ')}${text}\n`;
-    process.stdout.write(logMessage);
-  }
-
-  private static getChalkFn(color: 'green' | 'red') {
-    return color === 'green' ? chalk.green : chalk.red;
-  }
-}

package/src/util/string-utils.ts

@@ -1,7 +0,0 @@
-export const camel2title = (camelCase: string) =>
-  camelCase
-    .replace(/\//g, ' ')
-    .replace(/([A-Z])/g, (match) => ` ${match}`)
-    .replace(/\b\w/g, (match) => match.toUpperCase())
-    .replace(/^./, (match) => match.toUpperCase())
-    .trim();

package/tsconfig.json

@@ -1,25 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "es6",
-    "module": "commonjs",
-    "declaration": true,
-    "outDir": "./dist",
-    "strict": true,
-    "sourceMap": true,
-    "esModuleInterop": true,
-    "lib": [
-      "ES2021"
-    ],
-    "baseUrl": "./",
-    "paths": {
-      "#utils/*": ["src/util/*"],
-    }
-  },
-  "include": [
-    "src", "jest.d.ts"
-  ],
-  "exclude": [
-    "node_modules",
-    "**/__tests__/*"
-  ]
-}

package/tslint.json

@@ -1,6 +0,0 @@
-{
-    "extends": [
-        "tslint:recommended",
-        "tslint-config-prettier"
-    ]
-}