@cparra/apexdocs 2.2.4 → 2.4.0

package/src/service/parser.ts

@@ -1,18 +1,20 @@
 import { Type, ReflectionResult } from '@cparra/apex-reflection';
 import ApexBundle from '../model/apex-bundle';
 import MetadataProcessor from './metadata-processor';
+import { Logger } from '../util/logger';
 
 export interface TypeParser {
-  parse(reflect: (typeBody: string) => ReflectionResult): Type[];
+  parse(reflect: (apexBundle: ApexBundle) => ReflectionResult): Type[];
 }
 
 export class RawBodyParser implements TypeParser {
   constructor(public typeBundles: ApexBundle[]) {}
 
-  parse(reflect: (typeBody: string) => ReflectionResult): Type[] {
+  parse(reflect: (apexBundle: ApexBundle) => ReflectionResult): Type[] {
     return this.typeBundles
       .map((currentBundle) => {
-        const result = reflect(currentBundle.rawTypeContent);
+        Logger.log(`Parsing file: ${currentBundle.filePath}`);
+        const result = reflect(currentBundle);
         if (!!result.typeMirror && !!currentBundle.rawMetadataContent) {
           // If successful and there is a metadata file
           const metadataParams = MetadataProcessor.process(currentBundle.rawMetadataContent);

package/src/settings.ts

@@ -11,6 +11,7 @@ export interface SettingsConfig {
   outputDir: string;
   targetGenerator: GeneratorChoices;
   indexOnly: boolean;
+  defaultGroupName: string;
 }
 
 export class Settings {
@@ -59,4 +60,8 @@ export class Settings {
   get indexOnly(): boolean {
     return this.config.indexOnly;
   }
+
+  public getDefaultGroupName(): string {
+    return this.config.defaultGroupName;
+  }
 }

package/src/transpiler/markdown/class-file-generatorHelper.ts

@@ -1,5 +1,6 @@
 import { Type } from '@cparra/apex-reflection';
 import { TypesRepository } from '../../model/types-repository';
+import { Settings } from '../../settings';
 
 export default class ClassFileGeneratorHelper {
   public static getSanitizedGroup(classModel: Type) {
@@ -13,8 +14,8 @@ export default class ClassFileGeneratorHelper {
   public static getFileLinkByTypeName(typeName: string) {
     const type = TypesRepository.getInstance().getByName(typeName);
     if (!type) {
-      // If the type is not found we simply return the file name we received
-      return typeName;
+      // If the type is not found we return a Markdown hyperlink with whatever we received.
+      return `[${typeName}](${typeName})`;
     }
 
     return this.getFileLink(type);
@@ -22,6 +23,6 @@ export default class ClassFileGeneratorHelper {
 
   private static getClassGroup(classModel: Type): string {
     const groupAnnotation = classModel.docComment?.annotations.find((annotation) => annotation.name === 'group');
-    return groupAnnotation?.body ?? 'Misc';
+    return groupAnnotation?.body ?? Settings.getInstance().getDefaultGroupName();
   }
 }

package/src/util/error-logger.ts

@@ -1,4 +1,5 @@
 import { ClassMirror, InterfaceMirror, Type } from '@cparra/apex-reflection';
+import { Logger } from './logger';
 
 export default class ErrorLogger {
   public static logErrors(types: Type[]): void {
@@ -20,10 +21,10 @@ export default class ErrorLogger {
   private static logTypeErrors(currentType: Type, parentType?: Type) {
     if (currentType.docComment?.error) {
       const typeName = parentType ? `${parentType!.name}.${currentType.name}` : currentType.name;
-      console.log(`${typeName} - Doc comment parsing error. Level: Type`);
-      console.log(`Comment:\n ${currentType.docComment.rawDeclaration}`);
-      console.log(currentType.docComment.error);
-      console.log('=================================');
+      Logger.error(`${typeName} - Doc comment parsing error. Level: Type`);
+      Logger.error(`Comment:\n ${currentType.docComment.rawDeclaration}`);
+      Logger.error(currentType.docComment.error);
+      Logger.error('=================================');
     }
   }
 
@@ -31,37 +32,37 @@ export default class ErrorLogger {
     const typeName = parentType ? `${parentType!.name}.${classMirror.name}` : classMirror.name;
     classMirror.constructors.forEach((currentConstructor) => {
       if (currentConstructor.docComment?.error) {
-        console.log(`${typeName} - Doc comment parsing error. Level: Constructor`);
-        console.log(`Comment:\n ${currentConstructor.docComment.rawDeclaration}`);
-        console.log(currentConstructor.docComment.error);
-        console.log('=================================');
+        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) {
-        console.log(`${typeName} - Doc comment parsing error. Level: Field`);
-        console.log(`Comment:\n ${currentField.docComment.rawDeclaration}`);
-        console.log(currentField.docComment.error);
-        console.log('=================================');
+        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) {
-        console.log(`${typeName} - Doc comment parsing error. Level: Property`);
-        console.log(`Comment:\n ${currentProperty.docComment.rawDeclaration}`);
-        console.log(currentProperty.docComment.error);
-        console.log('=================================');
+        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) {
-        console.log(`${typeName} - Doc comment parsing error. Level: Method`);
-        console.log(`Comment:\n ${currentMethod.docComment.rawDeclaration}`);
-        console.log(currentMethod.docComment.error);
-        console.log('=================================');
+        Logger.error(`${typeName} - Doc comment parsing error. Level: Method`);
+        Logger.error(`Comment:\n ${currentMethod.docComment.rawDeclaration}`);
+        Logger.error(currentMethod.docComment.error);
+        Logger.error('=================================');
       }
     });
 
@@ -81,10 +82,10 @@ export default class ErrorLogger {
   private static logErrorsForInterface(interfaceMirror: InterfaceMirror): void {
     interfaceMirror.methods.forEach((currentMethod) => {
       if (currentMethod.docComment?.error) {
-        console.log(`${interfaceMirror.name} - Doc comment parsing error. Level: Method`);
-        console.log(`Comment: ${currentMethod.docComment.rawDeclaration}`);
-        console.log(currentMethod.docComment.error);
-        console.log('=================================');
+        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/logger.ts

@@ -1,9 +1,14 @@
 import * as chalk from 'chalk';
+import * as logUpdate from 'log-update';
 
 /**
  * Logs messages to the console.
  */
 export class Logger {
+  static currentFrame = -1;
+
+  static frames = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'];
+
   /**
    * Logs a message with optional arguments.
    * @param message The message to log.
@@ -22,10 +27,31 @@ export class Logger {
    * @param args Optional arguments.
    */
   public static error(message: string, ...args: string[]) {
-    this.log(`${chalk.red(message)}`, ...args);
+    this.logSingle(message, false, 'red', false);
+    args.forEach((arg) => {
+      this.logSingle(message, false, 'red', false);
+    });
+  }
+
+  public static logSingle(text: string, showSpinner = true, color: 'green' | 'red' = 'green', overrideConsole = true) {
+    if (this.currentFrame > 9) {
+      this.currentFrame = 0;
+    }
+    const spinner = showSpinner ? `${this.frames[this.currentFrame++]}` : '';
+    let logMessage;
+    if (color === 'green') {
+      logMessage = `${chalk.green(new Date().toLocaleString() + ': ')}${text}\n`;
+    } else {
+      logMessage = `${chalk.red(new Date().toLocaleString() + ': ')}${text}\n`;
+    }
+    if (overrideConsole) {
+      logUpdate(`${spinner} ${logMessage}`);
+    } else {
+      process.stdout.write(`${spinner} ${logMessage}`);
+    }
   }
 
-  private static logSingle(message: string) {
-    process.stdout.write(`${chalk.green(new Date().toLocaleString() + ': ')}${message}\n`);
+  public static clear() {
+    logUpdate.clear();
   }
 }

package/docs/Some-group/GroupedClass.md

@@ -1,7 +0,0 @@
-# GroupedClass
-
-Some desc
-
-
-**Group** Some group
-

package/docs/index.html

@@ -1,21 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-  <meta charset="UTF-8">
-  <title>Document</title>
-  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
-  <meta name="description" content="Description">
-  <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
-  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css">
-</head>
-<body>
-  <div id="app"></div>
-  <script>
-    window.$docsify = {
-      name: '',
-      repo: ''
-    }
-  </script>
-  <script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
-</body>
-</html>

package/docs/index.md

@@ -1,9 +0,0 @@
----
-layout: default
----
-# Classes
-## Sample Interfaces
-
-### [SampleInterface](/Sample-Interfaces/SampleInterface.md)
-
-This is an interface description.