@cparra/apexdocs 2.2.3 → 2.3.0

package/lib/service/parser.d.ts

@@ -1,10 +1,10 @@
 import { Type, ReflectionResult } from '@cparra/apex-reflection';
 import ApexBundle from '../model/apex-bundle';
 export interface TypeParser {
-    parse(reflect: (typeBody: string) => ReflectionResult): Type[];
+    parse(reflect: (apexBundle: ApexBundle) => ReflectionResult): Type[];
 }
 export declare class RawBodyParser implements TypeParser {
     typeBundles: ApexBundle[];
     constructor(typeBundles: ApexBundle[]);
-    parse(reflect: (typeBody: string) => ReflectionResult): Type[];
+    parse(reflect: (apexBundle: ApexBundle) => ReflectionResult): Type[];
 }

package/lib/service/parser.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RawBodyParser = void 0;
 const metadata_processor_1 = require("./metadata-processor");
+const logger_1 = require("../util/logger");
 class RawBodyParser {
     constructor(typeBundles) {
         this.typeBundles = typeBundles;
@@ -9,7 +10,8 @@ class RawBodyParser {
     parse(reflect) {
         return this.typeBundles
             .map((currentBundle) => {
-            const result = reflect(currentBundle.rawTypeContent);
+            logger_1.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 = metadata_processor_1.default.process(currentBundle.rawMetadataContent);

package/lib/service/parser.js.map

@@ -1 +1 @@
-{"version":3,"file":"parser.js","sourceRoot":"","sources":["../../src/service/parser.ts"],"names":[],"mappings":";;;AAEA,6DAAqD;AAMrD,MAAa,aAAa;IACxB,YAAmB,WAAyB;QAAzB,gBAAW,GAAX,WAAW,CAAc;IAAG,CAAC;IAEhD,KAAK,CAAC,OAA+C;QACnD,OAAO,IAAI,CAAC,WAAW;aACpB,GAAG,CAAC,CAAC,aAAa,EAAE,EAAE;YACrB,MAAM,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;YACrD,IAAI,CAAC,CAAC,MAAM,CAAC,UAAU,IAAI,CAAC,CAAC,aAAa,CAAC,kBAAkB,EAAE;gBAC7D,6CAA6C;gBAC7C,MAAM,cAAc,GAAG,4BAAiB,CAAC,OAAO,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC;gBACnF,cAAc,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;oBACpC,MAAM,WAAW,GAAG,GAAG,GAAG,KAAK,KAAK,EAAE,CAAC;oBACvC,MAAM,CAAC,UAAW,CAAC,WAAW,CAAC,IAAI,CAAC;wBAClC,cAAc,EAAE,WAAW;wBAC3B,IAAI,EAAE,WAAW;wBACjB,IAAI,EAAE,WAAW;qBAClB,CAAC,CAAC;gBACL,CAAC,CAAC,CAAC;aACJ;YACD,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;aACD,MAAM,CAAC,CAAC,gBAAgB,EAAE,EAAE;YAC3B,OAAO,gBAAgB,CAAC,UAAU,CAAC;QACrC,CAAC,CAAC;aACD,GAAG,CAAC,CAAC,gBAAgB,EAAE,EAAE,CAAC,gBAAgB,CAAC,UAAW,CAAC,CAAC;IAC7D,CAAC;CACF;AA1BD,sCA0BC"}
+{"version":3,"file":"parser.js","sourceRoot":"","sources":["../../src/service/parser.ts"],"names":[],"mappings":";;;AAEA,6DAAqD;AACrD,2CAAwC;AAMxC,MAAa,aAAa;IACxB,YAAmB,WAAyB;QAAzB,gBAAW,GAAX,WAAW,CAAc;IAAG,CAAC;IAEhD,KAAK,CAAC,OAAqD;QACzD,OAAO,IAAI,CAAC,WAAW;aACpB,GAAG,CAAC,CAAC,aAAa,EAAE,EAAE;YACrB,eAAM,CAAC,GAAG,CAAC,iBAAiB,aAAa,CAAC,QAAQ,EAAE,CAAC,CAAC;YACtD,MAAM,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;YACtC,IAAI,CAAC,CAAC,MAAM,CAAC,UAAU,IAAI,CAAC,CAAC,aAAa,CAAC,kBAAkB,EAAE;gBAC7D,6CAA6C;gBAC7C,MAAM,cAAc,GAAG,4BAAiB,CAAC,OAAO,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC;gBACnF,cAAc,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;oBACpC,MAAM,WAAW,GAAG,GAAG,GAAG,KAAK,KAAK,EAAE,CAAC;oBACvC,MAAM,CAAC,UAAW,CAAC,WAAW,CAAC,IAAI,CAAC;wBAClC,cAAc,EAAE,WAAW;wBAC3B,IAAI,EAAE,WAAW;wBACjB,IAAI,EAAE,WAAW;qBAClB,CAAC,CAAC;gBACL,CAAC,CAAC,CAAC;aACJ;YACD,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;aACD,MAAM,CAAC,CAAC,gBAAgB,EAAE,EAAE;YAC3B,OAAO,gBAAgB,CAAC,UAAU,CAAC;QACrC,CAAC,CAAC;aACD,GAAG,CAAC,CAAC,gBAAgB,EAAE,EAAE,CAAC,gBAAgB,CAAC,UAAW,CAAC,CAAC;IAC7D,CAAC;CACF;AA3BD,sCA2BC"}

package/lib/transpiler/markdown/class-file-generatorHelper.js

@@ -11,8 +11,8 @@ class ClassFileGeneratorHelper {
     static getFileLinkByTypeName(typeName) {
         const type = types_repository_1.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);
     }

package/lib/transpiler/markdown/class-file-generatorHelper.js.map

@@ -1 +1 @@
-{"version":3,"file":"class-file-generatorHelper.js","sourceRoot":"","sources":["../../../src/transpiler/markdown/class-file-generatorHelper.ts"],"names":[],"mappings":";;AACA,mEAA+D;AAE/D,MAAqB,wBAAwB;IACpC,MAAM,CAAC,iBAAiB,CAAC,UAAgB;QAC9C,OAAO,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,UAAgB;QACxC,OAAO,IAAI,UAAU,CAAC,IAAI,MAAM,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,IAAI,UAAU,CAAC,IAAI,MAAM,CAAC;IAC9F,CAAC;IAEM,MAAM,CAAC,qBAAqB,CAAC,QAAgB;QAClD,MAAM,IAAI,GAAG,kCAAe,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QAC/D,IAAI,CAAC,IAAI,EAAE;YACT,sEAAsE;YACtE,OAAO,QAAQ,CAAC;SACjB;QAED,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,UAAgB;;QAC3C,MAAM,eAAe,SAAG,UAAU,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC;QAC7G,aAAO,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,IAAI,mCAAI,MAAM,CAAC;IACzC,CAAC;CACF;AAvBD,2CAuBC"}
+{"version":3,"file":"class-file-generatorHelper.js","sourceRoot":"","sources":["../../../src/transpiler/markdown/class-file-generatorHelper.ts"],"names":[],"mappings":";;AACA,mEAA+D;AAE/D,MAAqB,wBAAwB;IACpC,MAAM,CAAC,iBAAiB,CAAC,UAAgB;QAC9C,OAAO,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,UAAgB;QACxC,OAAO,IAAI,UAAU,CAAC,IAAI,MAAM,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,IAAI,UAAU,CAAC,IAAI,MAAM,CAAC;IAC9F,CAAC;IAEM,MAAM,CAAC,qBAAqB,CAAC,QAAgB;QAClD,MAAM,IAAI,GAAG,kCAAe,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QAC/D,IAAI,CAAC,IAAI,EAAE;YACT,qFAAqF;YACrF,OAAO,IAAI,QAAQ,KAAK,QAAQ,GAAG,CAAC;SACrC;QAED,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,UAAgB;;QAC3C,MAAM,eAAe,SAAG,UAAU,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC;QAC7G,aAAO,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,IAAI,mCAAI,MAAM,CAAC;IACzC,CAAC;CACF;AAvBD,2CAuBC"}

package/lib/util/error-logger.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const logger_1 = require("./logger");
 class ErrorLogger {
     static logErrors(types) {
         types.forEach((currentType) => {
@@ -19,10 +20,10 @@ class ErrorLogger {
         var _a;
         if ((_a = currentType.docComment) === null || _a === void 0 ? void 0 : _a.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_1.Logger.error(`${typeName} - Doc comment parsing error. Level: Type`);
+            logger_1.Logger.error(`Comment:\n ${currentType.docComment.rawDeclaration}`);
+            logger_1.Logger.error(currentType.docComment.error);
+            logger_1.Logger.error('=================================');
         }
     }
     static logErrorsForClass(classMirror, parentType) {
@@ -30,37 +31,37 @@ class ErrorLogger {
         classMirror.constructors.forEach((currentConstructor) => {
             var _a;
             if ((_a = currentConstructor.docComment) === null || _a === void 0 ? void 0 : _a.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_1.Logger.error(`${typeName} - Doc comment parsing error. Level: Constructor`);
+                logger_1.Logger.error(`Comment:\n ${currentConstructor.docComment.rawDeclaration}`);
+                logger_1.Logger.error(currentConstructor.docComment.error);
+                logger_1.Logger.error('=================================');
             }
         });
         classMirror.fields.forEach((currentField) => {
             var _a;
             if ((_a = currentField.docComment) === null || _a === void 0 ? void 0 : _a.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_1.Logger.error(`${typeName} - Doc comment parsing error. Level: Field`);
+                logger_1.Logger.error(`Comment:\n ${currentField.docComment.rawDeclaration}`);
+                logger_1.Logger.error(currentField.docComment.error);
+                logger_1.Logger.error('=================================');
             }
         });
         classMirror.properties.forEach((currentProperty) => {
             var _a;
             if ((_a = currentProperty.docComment) === null || _a === void 0 ? void 0 : _a.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_1.Logger.error(`${typeName} - Doc comment parsing error. Level: Property`);
+                logger_1.Logger.error(`Comment:\n ${currentProperty.docComment.rawDeclaration}`);
+                logger_1.Logger.error(currentProperty.docComment.error);
+                logger_1.Logger.error('=================================');
             }
         });
         classMirror.methods.forEach((currentMethod) => {
             var _a;
             if ((_a = currentMethod.docComment) === null || _a === void 0 ? void 0 : _a.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_1.Logger.error(`${typeName} - Doc comment parsing error. Level: Method`);
+                logger_1.Logger.error(`Comment:\n ${currentMethod.docComment.rawDeclaration}`);
+                logger_1.Logger.error(currentMethod.docComment.error);
+                logger_1.Logger.error('=================================');
             }
         });
         classMirror.enums.forEach((currentEnum) => {
@@ -77,10 +78,10 @@ class ErrorLogger {
         interfaceMirror.methods.forEach((currentMethod) => {
             var _a;
             if ((_a = currentMethod.docComment) === null || _a === void 0 ? void 0 : _a.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_1.Logger.error(`${interfaceMirror.name} - Doc comment parsing error. Level: Method`);
+                logger_1.Logger.error(`Comment: ${currentMethod.docComment.rawDeclaration}`);
+                logger_1.Logger.error(currentMethod.docComment.error);
+                logger_1.Logger.error('=================================');
             }
         });
     }

package/lib/util/error-logger.js.map

@@ -1 +1 @@
-{"version":3,"file":"error-logger.js","sourceRoot":"","sources":["../../src/util/error-logger.ts"],"names":[],"mappings":";;AAEA,MAAqB,WAAW;IACvB,MAAM,CAAC,SAAS,CAAC,KAAa;QACnC,KAAK,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;YAC5B,IAAI,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,sBAAsB,CAAC,WAAiB,EAAE,UAAiB;QACxE,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;QAEhC,IAAI,WAAW,CAAC,SAAS,KAAK,OAAO,EAAE;YACrC,IAAI,CAAC,iBAAiB,CAAC,WAA0B,CAAC,CAAC;SACpD;aAAM,IAAI,WAAW,CAAC,SAAS,KAAK,WAAW,EAAE;YAChD,IAAI,CAAC,qBAAqB,CAAC,WAA8B,CAAC,CAAC;SAC5D;IACH,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,WAAiB,EAAE,UAAiB;;QAC/D,UAAI,WAAW,CAAC,UAAU,0CAAE,KAAK,EAAE;YACjC,MAAM,QAAQ,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,UAAW,CAAC,IAAI,IAAI,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC;YAC3F,OAAO,CAAC,GAAG,CAAC,GAAG,QAAQ,2CAA2C,CAAC,CAAC;YACpE,OAAO,CAAC,GAAG,CAAC,cAAc,WAAW,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;YACnE,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YAC1C,OAAO,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAC;SAClD;IACH,CAAC;IAEO,MAAM,CAAC,iBAAiB,CAAC,WAAwB,EAAE,UAAiB;QAC1E,MAAM,QAAQ,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,UAAW,CAAC,IAAI,IAAI,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC;QAC3F,WAAW,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,kBAAkB,EAAE,EAAE;;YACtD,UAAI,kBAAkB,CAAC,UAAU,0CAAE,KAAK,EAAE;gBACxC,OAAO,CAAC,GAAG,CAAC,GAAG,QAAQ,kDAAkD,CAAC,CAAC;gBAC3E,OAAO,CAAC,GAAG,CAAC,cAAc,kBAAkB,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;gBAC1E,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBACjD,OAAO,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAC;aAClD;QACH,CAAC,CAAC,CAAC;QAEH,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;;YAC1C,UAAI,YAAY,CAAC,UAAU,0CAAE,KAAK,EAAE;gBAClC,OAAO,CAAC,GAAG,CAAC,GAAG,QAAQ,4CAA4C,CAAC,CAAC;gBACrE,OAAO,CAAC,GAAG,CAAC,cAAc,YAAY,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;gBACpE,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBAC3C,OAAO,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAC;aAClD;QACH,CAAC,CAAC,CAAC;QAEH,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,EAAE;;YACjD,UAAI,eAAe,CAAC,UAAU,0CAAE,KAAK,EAAE;gBACrC,OAAO,CAAC,GAAG,CAAC,GAAG,QAAQ,+CAA+C,CAAC,CAAC;gBACxE,OAAO,CAAC,GAAG,CAAC,cAAc,eAAe,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;gBACvE,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBAC9C,OAAO,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAC;aAClD;QACH,CAAC,CAAC,CAAC;QAEH,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;;YAC5C,UAAI,aAAa,CAAC,UAAU,0CAAE,KAAK,EAAE;gBACnC,OAAO,CAAC,GAAG,CAAC,GAAG,QAAQ,6CAA6C,CAAC,CAAC;gBACtE,OAAO,CAAC,GAAG,CAAC,cAAc,aAAa,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;gBACrE,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBAC5C,OAAO,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAC;aAClD;QACH,CAAC,CAAC,CAAC;QAEH,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;YACxC,IAAI,CAAC,sBAAsB,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;QAEH,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,gBAAgB,EAAE,EAAE;YAClD,IAAI,CAAC,sBAAsB,CAAC,gBAAgB,EAAE,WAAW,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;QAEH,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;YAC3C,IAAI,CAAC,sBAAsB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,qBAAqB,CAAC,eAAgC;QACnE,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;;YAChD,UAAI,aAAa,CAAC,UAAU,0CAAE,KAAK,EAAE;gBACnC,OAAO,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC,IAAI,6CAA6C,CAAC,CAAC;gBAClF,OAAO,CAAC,GAAG,CAAC,YAAY,aAAa,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;gBACnE,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBAC5C,OAAO,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAC;aAClD;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAxFD,8BAwFC"}
+{"version":3,"file":"error-logger.js","sourceRoot":"","sources":["../../src/util/error-logger.ts"],"names":[],"mappings":";;AACA,qCAAkC;AAElC,MAAqB,WAAW;IACvB,MAAM,CAAC,SAAS,CAAC,KAAa;QACnC,KAAK,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;YAC5B,IAAI,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,sBAAsB,CAAC,WAAiB,EAAE,UAAiB;QACxE,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;QAEhC,IAAI,WAAW,CAAC,SAAS,KAAK,OAAO,EAAE;YACrC,IAAI,CAAC,iBAAiB,CAAC,WAA0B,CAAC,CAAC;SACpD;aAAM,IAAI,WAAW,CAAC,SAAS,KAAK,WAAW,EAAE;YAChD,IAAI,CAAC,qBAAqB,CAAC,WAA8B,CAAC,CAAC;SAC5D;IACH,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,WAAiB,EAAE,UAAiB;;QAC/D,UAAI,WAAW,CAAC,UAAU,0CAAE,KAAK,EAAE;YACjC,MAAM,QAAQ,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,UAAW,CAAC,IAAI,IAAI,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC;YAC3F,eAAM,CAAC,KAAK,CAAC,GAAG,QAAQ,2CAA2C,CAAC,CAAC;YACrE,eAAM,CAAC,KAAK,CAAC,cAAc,WAAW,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;YACpE,eAAM,CAAC,KAAK,CAAC,WAAW,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YAC3C,eAAM,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;SACnD;IACH,CAAC;IAEO,MAAM,CAAC,iBAAiB,CAAC,WAAwB,EAAE,UAAiB;QAC1E,MAAM,QAAQ,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,UAAW,CAAC,IAAI,IAAI,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC;QAC3F,WAAW,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,kBAAkB,EAAE,EAAE;;YACtD,UAAI,kBAAkB,CAAC,UAAU,0CAAE,KAAK,EAAE;gBACxC,eAAM,CAAC,KAAK,CAAC,GAAG,QAAQ,kDAAkD,CAAC,CAAC;gBAC5E,eAAM,CAAC,KAAK,CAAC,cAAc,kBAAkB,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;gBAC3E,eAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBAClD,eAAM,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;aACnD;QACH,CAAC,CAAC,CAAC;QAEH,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;;YAC1C,UAAI,YAAY,CAAC,UAAU,0CAAE,KAAK,EAAE;gBAClC,eAAM,CAAC,KAAK,CAAC,GAAG,QAAQ,4CAA4C,CAAC,CAAC;gBACtE,eAAM,CAAC,KAAK,CAAC,cAAc,YAAY,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;gBACrE,eAAM,CAAC,KAAK,CAAC,YAAY,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBAC5C,eAAM,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;aACnD;QACH,CAAC,CAAC,CAAC;QAEH,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,EAAE;;YACjD,UAAI,eAAe,CAAC,UAAU,0CAAE,KAAK,EAAE;gBACrC,eAAM,CAAC,KAAK,CAAC,GAAG,QAAQ,+CAA+C,CAAC,CAAC;gBACzE,eAAM,CAAC,KAAK,CAAC,cAAc,eAAe,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;gBACxE,eAAM,CAAC,KAAK,CAAC,eAAe,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBAC/C,eAAM,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;aACnD;QACH,CAAC,CAAC,CAAC;QAEH,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;;YAC5C,UAAI,aAAa,CAAC,UAAU,0CAAE,KAAK,EAAE;gBACnC,eAAM,CAAC,KAAK,CAAC,GAAG,QAAQ,6CAA6C,CAAC,CAAC;gBACvE,eAAM,CAAC,KAAK,CAAC,cAAc,aAAa,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;gBACtE,eAAM,CAAC,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBAC7C,eAAM,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;aACnD;QACH,CAAC,CAAC,CAAC;QAEH,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;YACxC,IAAI,CAAC,sBAAsB,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;QAEH,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,gBAAgB,EAAE,EAAE;YAClD,IAAI,CAAC,sBAAsB,CAAC,gBAAgB,EAAE,WAAW,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;QAEH,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;YAC3C,IAAI,CAAC,sBAAsB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,qBAAqB,CAAC,eAAgC;QACnE,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;;YAChD,UAAI,aAAa,CAAC,UAAU,0CAAE,KAAK,EAAE;gBACnC,eAAM,CAAC,KAAK,CAAC,GAAG,eAAe,CAAC,IAAI,6CAA6C,CAAC,CAAC;gBACnF,eAAM,CAAC,KAAK,CAAC,YAAY,aAAa,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;gBACpE,eAAM,CAAC,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBAC7C,eAAM,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;aACnD;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAxFD,8BAwFC"}

package/lib/util/logger.d.ts

@@ -2,6 +2,8 @@
  * Logs messages to the console.
  */
 export declare class Logger {
+    static currentFrame: number;
+    static frames: string[];
     /**
      * Logs a message with optional arguments.
      * @param message The message to log.
@@ -14,5 +16,6 @@ export declare class Logger {
      * @param args Optional arguments.
      */
     static error(message: string, ...args: string[]): void;
-    private static logSingle;
+    static logSingle(text: string, showSpinner?: boolean, color?: 'green' | 'red', overrideConsole?: boolean): void;
+    static clear(): void;
 }

package/lib/util/logger.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Logger = void 0;
 const chalk = require("chalk");
+const logUpdate = require("log-update");
 /**
  * Logs messages to the console.
  */
@@ -23,11 +24,35 @@ class Logger {
      * @param args Optional arguments.
      */
     static error(message, ...args) {
-        this.log(`${chalk.red(message)}`, ...args);
+        this.logSingle(message, false, 'red', false);
+        args.forEach((arg) => {
+            this.logSingle(message, false, 'red', false);
+        });
+    }
+    static logSingle(text, showSpinner = true, color = '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}`);
+        }
     }
-    static logSingle(message) {
-        process.stdout.write(`${chalk.green(new Date().toLocaleString() + ': ')}${message}\n`);
+    static clear() {
+        logUpdate.clear();
     }
 }
 exports.Logger = Logger;
+Logger.currentFrame = -1;
+Logger.frames = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'];
 //# sourceMappingURL=logger.js.map

package/lib/util/logger.js.map

@@ -1 +1 @@
-{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/util/logger.ts"],"names":[],"mappings":";;;AAAA,+BAA+B;AAE/B;;GAEG;AACH,MAAa,MAAM;IACjB;;;;OAIG;IACI,MAAM,CAAC,GAAG,CAAC,OAAe,EAAE,GAAG,IAAc;QAClD,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACnB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,OAAe,EAAE,GAAG,IAAc;QACpD,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;IAC7C,CAAC;IAEO,MAAM,CAAC,SAAS,CAAC,OAAe;QACtC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC,cAAc,EAAE,GAAG,IAAI,CAAC,GAAG,OAAO,IAAI,CAAC,CAAC;IACzF,CAAC;CACF;AAzBD,wBAyBC"}
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/util/logger.ts"],"names":[],"mappings":";;;AAAA,+BAA+B;AAC/B,wCAAwC;AAExC;;GAEG;AACH,MAAa,MAAM;IAKjB;;;;OAIG;IACI,MAAM,CAAC,GAAG,CAAC,OAAe,EAAE,GAAG,IAAc;QAClD,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACnB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,OAAe,EAAE,GAAG,IAAc;QACpD,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QAC7C,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACnB,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,MAAM,CAAC,SAAS,CAAC,IAAY,EAAE,WAAW,GAAG,IAAI,EAAE,QAAyB,OAAO,EAAE,eAAe,GAAG,IAAI;QAChH,IAAI,IAAI,CAAC,YAAY,GAAG,CAAC,EAAE;YACzB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;SACvB;QACD,MAAM,OAAO,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACzE,IAAI,UAAU,CAAC;QACf,IAAI,KAAK,KAAK,OAAO,EAAE;YACrB,UAAU,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC,cAAc,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC;SAC5E;aAAM;YACL,UAAU,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC,cAAc,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC;SAC1E;QACD,IAAI,eAAe,EAAE;YACnB,SAAS,CAAC,GAAG,OAAO,IAAI,UAAU,EAAE,CAAC,CAAC;SACvC;aAAM;YACL,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,OAAO,IAAI,UAAU,EAAE,CAAC,CAAC;SAClD;IACH,CAAC;IAEM,MAAM,CAAC,KAAK;QACjB,SAAS,CAAC,KAAK,EAAE,CAAC;IACpB,CAAC;;AAjDH,wBAkDC;AAjDQ,mBAAY,GAAG,CAAC,CAAC,CAAC;AAElB,aAAM,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cparra/apexdocs",
-  "version": "2.2.3",
+  "version": "2.3.0",
   "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
   "keywords": [
     "apex",
@@ -64,10 +64,11 @@
     ]
   },
   "dependencies": {
-    "@cparra/apex-reflection": "^1.5.0",
-    "fast-xml-parser": "^4.0.1",
+    "@cparra/apex-reflection": "^1.6.0",
     "chalk": "^4.1.2",
-    "html-entities": "^2.3.2",
+    "fast-xml-parser": "^4.0.1",
+    "log-update": "4.0.0",
+    "xss": "^1.0.11",
     "yargs": "^16.0.3"
   }
 }

package/src/application/Apexdocs.ts

@@ -9,6 +9,7 @@ import Transpiler from '../transpiler/transpiler';
 import { FileWriter } from '../service/file-writer';
 import { TypesRepository } from '../model/types-repository';
 import ErrorLogger from '../util/error-logger';
+import ApexBundle from '../model/apex-bundle';
 
 /**
  * Application entry-point to generate documentation out of Apex source files.
@@ -18,28 +19,30 @@ export class Apexdocs {
    * Generates documentation out of Apex source files.
    */
   static generate(): void {
+    Logger.log('Initializing...');
     const fileBodies = ApexFileReader.processFiles(new DefaultFileSystem());
     const manifest = createManifest(new RawBodyParser(fileBodies), this._reflectionWithLogger);
 
     const filteredTypes: Type[] = manifest.filteredByAccessModifierAndAnnotations(Settings.getInstance().scope);
     TypesRepository.getInstance().populate(filteredTypes);
+    Logger.clear();
 
-    Logger.log(`Parsed ${filteredTypes.length} files`);
+    Logger.logSingle(`Parsed ${filteredTypes.length} files`, false, 'green', false);
     const processor = Settings.getInstance().typeTranspiler;
     Transpiler.generate(filteredTypes, processor);
     const generatedFiles = processor.fileBuilder().files();
     FileWriter.write(generatedFiles, (fileName: string) => {
-      Logger.log(`${fileName} processed.`);
+      Logger.logSingle(`${fileName} processed.`, false, 'green', false);
     });
 
     // Error logging
     ErrorLogger.logErrors(filteredTypes);
   }
 
-  static _reflectionWithLogger = (declarationBody: string): ReflectionResult => {
-    const result = reflect(declarationBody);
+  static _reflectionWithLogger = (apexBundle: ApexBundle): ReflectionResult => {
+    const result = reflect(apexBundle.rawTypeContent);
     if (result.error) {
-      Logger.log(`Parsing error ${result.error?.message}`);
+      Logger.error(`${apexBundle.filePath} - Parsing error ${result.error?.message}`);
     }
     return result;
   };

package/src/model/apex-bundle.ts

@@ -1,3 +1,3 @@
 export default class ApexBundle {
-  constructor(public rawTypeContent: string, public rawMetadataContent: string | null) {}
+  constructor(public filePath: string, public rawTypeContent: string, public rawMetadataContent: string | null) {}
 }

package/src/model/file.ts

@@ -1,4 +1,8 @@
-import { encode } from 'html-entities';
+import xss = require('xss');
+
+const xssFilter = new xss.FilterXSS({
+  whiteList: { br: [], p: [], ul: [], li: [] },
+});
 
 export abstract class File {
   _contents = '';
@@ -12,7 +16,7 @@ export abstract class File {
   }
 
   addText(text: string, encodeHtml = true) {
-    const textToAdd = encodeHtml ? encode(text) : text;
+    const textToAdd = encodeHtml ? xssFilter.process(text) : text;
     this._contents += textToAdd;
     this.addBlankLine();
   }

package/src/model/markdown-file.ts

@@ -18,6 +18,12 @@ export class MarkdownFile extends File {
     this.addBlankLine();
   }
 
+  public addText(text: string, encodeHtml = true) {
+    text = MarkdownFile.replaceInlineLinks(text);
+    text = MarkdownFile.replaceInlineEmails(text);
+    super.addText(text, encodeHtml);
+  }
+
   startCodeBlock() {
     this._contents += '```';
     const sourceLanguage = 'apex';
@@ -86,4 +92,24 @@ export class MarkdownFile extends File {
     }
     return text;
   }
+
+  protected static replaceInlineEmails(text: string) {
+    // Parsing links using {@link ClassName} format
+    const linkFormatRegEx = '{@email (.*?)}';
+    const expression = new RegExp(linkFormatRegEx, 'gi');
+    let match;
+    const matches = [];
+
+    do {
+      match = expression.exec(text);
+      if (match) {
+        matches.push(match);
+      }
+    } while (match);
+
+    for (const currentMatch of matches) {
+      text = text.replace(currentMatch[0], `[${currentMatch[1]}](mailto:${currentMatch[1]})`);
+    }
+    return text;
+  }
 }

package/src/model/markdown-generation-util/doc-comment-annotation-util.ts

@@ -19,7 +19,6 @@ export function addCustomDocCommentAnnotations(markdownFile: MarkdownFile, docCo
     const words = text.split(/[-_]+/);
     const capitalizedWords = [];
     for (const word of words) {
-      console.log(`current word ${word}`);
       capitalizedWords.push(word.charAt(0).toUpperCase() + word.slice(1));
     }
     return capitalizedWords.join(' ');

package/src/model/markdown-home-file.ts

@@ -12,11 +12,6 @@ export class MarkdownHomeFile extends MarkdownFile {
     this.addTypeEntries(types);
   }
 
-  public addText(text: string, encodeHtml = true) {
-    text = MarkdownFile.replaceInlineLinks(text);
-    super.addText(text, encodeHtml);
-  }
-
   private addTypeEntries(types: Type[]) {
     const groupedClasses: Map<string, Type[]> = this.group(types);
     groupedClasses.forEach((value: Type[], key: string) => {

package/src/model/markdown-type-file.ts

@@ -32,11 +32,6 @@ export class MarkdownTypeFile extends MarkdownFile implements WalkerListener {
     walker.walk(this);
   }
 
-  public addText(text: string, encodeHtml = true) {
-    text = MarkdownFile.replaceInlineLinks(text);
-    super.addText(text, encodeHtml);
-  }
-
   public onTypeDeclaration(typeMirror: Type): void {
     this.addTitle(typeMirror.name, this.headingLevel);
     declareType(this, typeMirror);

package/src/service/apex-file-reader.ts

@@ -12,13 +12,13 @@ export class ApexFileReader {
    * Reads from .cls files and returns their raw body.
    */
   static processFiles(fileSystem: FileSystem, rootPath: string = this.sourceDirectory): ApexBundle[] {
-    let bodies: ApexBundle[] = [];
+    let bundles: ApexBundle[] = [];
 
     const directoryContents = fileSystem.readDirectory(rootPath);
     directoryContents.forEach((currentFilePath) => {
       const currentPath = fileSystem.joinPath(rootPath, currentFilePath);
       if (this.readRecursively && fileSystem.isDirectory(currentPath)) {
-        bodies = bodies.concat(this.processFiles(fileSystem, currentPath));
+        bundles = bundles.concat(this.processFiles(fileSystem, currentPath));
       }
 
       if (!this.isApexFile(currentFilePath)) {
@@ -28,9 +28,9 @@ export class ApexFileReader {
       const rawApexFile = fileSystem.readFile(currentPath);
       const metadataPath = fileSystem.joinPath(rootPath, `${currentFilePath}-meta.xml`);
       const rawMetadataFile = fileSystem.exists(metadataPath) ? fileSystem.readFile(metadataPath) : null;
-      bodies.push(new ApexBundle(rawApexFile, rawMetadataFile));
+      bundles.push(new ApexBundle(currentFilePath, rawApexFile, rawMetadataFile));
     });
-    return bodies;
+    return bundles;
   }
 
   private static isApexFile(currentFile: string): boolean {

package/src/service/manifest-factory.ts

@@ -1,12 +1,16 @@
 import Manifest from '../model/manifest';
 import { TypeParser } from './parser';
 import { ReflectionResult } from '@cparra/apex-reflection';
+import ApexBundle from '../model/apex-bundle';
 
 /**
  * Builds a new Manifest object, sourcing its types from the received TypeParser.
  * @param typeParser In charge of returning the list of reflected types.
  * @param reflect Reflection function.
  */
-export function createManifest(typeParser: TypeParser, reflect: (typeBody: string) => ReflectionResult): Manifest {
+export function createManifest(
+  typeParser: TypeParser,
+  reflect: (apexBundle: ApexBundle) => ReflectionResult,
+): Manifest {
   return new Manifest(typeParser.parse(reflect));
 }

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/transpiler/markdown/class-file-generatorHelper.ts

@@ -13,8 +13,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);

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('=================================');
       }
     });
   }