@cparra/apexdocs 2.1.4 → 2.2.2

package/lib/service/file-system.js

@@ -17,6 +17,9 @@ class DefaultFileSystem {
     joinPath(...paths) {
         return path.join(...paths);
     }
+    exists(path) {
+        return fs.existsSync(path);
+    }
 }
 exports.DefaultFileSystem = DefaultFileSystem;
 //# sourceMappingURL=file-system.js.map

package/lib/service/file-system.js.map

@@ -1 +1 @@
-{"version":3,"file":"file-system.js","sourceRoot":"","sources":["../../src/service/file-system.ts"],"names":[],"mappings":";;;AAAA,yBAAyB;AACzB,6BAA6B;AAS7B,MAAa,iBAAiB;IAC5B,WAAW,CAAC,UAAkB;QAC5B,OAAO,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,WAAW,EAAE,CAAC;IAC/C,CAAC;IAED,aAAa,CAAC,eAAuB;QACnC,OAAO,EAAE,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;IACzC,CAAC;IAED,QAAQ,CAAC,UAAkB;QACzB,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QAC5C,OAAO,OAAO,CAAC,QAAQ,EAAE,CAAC;IAC5B,CAAC;IAED,QAAQ,CAAC,GAAG,KAAe;QACzB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;IAC7B,CAAC;CACF;AAjBD,8CAiBC"}
+{"version":3,"file":"file-system.js","sourceRoot":"","sources":["../../src/service/file-system.ts"],"names":[],"mappings":";;;AAAA,yBAAyB;AACzB,6BAA6B;AAU7B,MAAa,iBAAiB;IAC5B,WAAW,CAAC,UAAkB;QAC5B,OAAO,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,WAAW,EAAE,CAAC;IAC/C,CAAC;IAED,aAAa,CAAC,eAAuB;QACnC,OAAO,EAAE,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;IACzC,CAAC;IAED,QAAQ,CAAC,UAAkB;QACzB,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QAC5C,OAAO,OAAO,CAAC,QAAQ,EAAE,CAAC;IAC5B,CAAC;IAED,QAAQ,CAAC,GAAG,KAAe;QACzB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;IAC7B,CAAC;IAED,MAAM,CAAC,IAAY;QACjB,OAAO,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;CACF;AArBD,8CAqBC"}

package/lib/service/metadata-processor.d.ts

@@ -0,0 +1,3 @@
+export default class MetadataProcessor {
+    static process(input: string): Map<string, string>;
+}

package/lib/service/metadata-processor.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const fast_xml_parser_1 = require("fast-xml-parser");
+class MetadataProcessor {
+    static process(input) {
+        var _a, _b;
+        const map = new Map();
+        const xml = new fast_xml_parser_1.XMLParser().parse(input);
+        map.set('apiVersion', (_a = xml.ApexClass.apiVersion) !== null && _a !== void 0 ? _a : '');
+        map.set('status', (_b = xml.ApexClass.status) !== null && _b !== void 0 ? _b : '');
+        return map;
+    }
+}
+exports.default = MetadataProcessor;
+//# sourceMappingURL=metadata-processor.js.map

package/lib/service/metadata-processor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata-processor.js","sourceRoot":"","sources":["../../src/service/metadata-processor.ts"],"names":[],"mappings":";;AAAA,qDAA4C;AAE5C,MAAqB,iBAAiB;IAC7B,MAAM,CAAC,OAAO,CAAC,KAAa;;QACjC,MAAM,GAAG,GAAG,IAAI,GAAG,EAAkB,CAAC;QACtC,MAAM,GAAG,GAAG,IAAI,2BAAS,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAEzC,GAAG,CAAC,GAAG,CAAC,YAAY,QAAE,GAAG,CAAC,SAAS,CAAC,UAAU,mCAAI,EAAE,CAAC,CAAC;QAEtD,GAAG,CAAC,GAAG,CAAC,QAAQ,QAAE,GAAG,CAAC,SAAS,CAAC,MAAM,mCAAI,EAAE,CAAC,CAAC;QAC9C,OAAO,GAAG,CAAC;IACb,CAAC;CACF;AAVD,oCAUC"}

package/lib/service/parser.d.ts

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

package/lib/service/parser.js

@@ -1,13 +1,29 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RawBodyParser = void 0;
+const metadata_processor_1 = require("./metadata-processor");
 class RawBodyParser {
-    constructor(typeBodies) {
-        this.typeBodies = typeBodies;
+    constructor(typeBundles) {
+        this.typeBundles = typeBundles;
     }
     parse(reflect) {
-        return this.typeBodies
-            .map((rawBody) => reflect(rawBody))
+        return this.typeBundles
+            .map((currentBundle) => {
+            const result = reflect(currentBundle.rawTypeContent);
+            if (!!result.typeMirror && !!currentBundle.rawMetadataContent) {
+                // If successful and there is a metadata file
+                const metadataParams = metadata_processor_1.default.process(currentBundle.rawMetadataContent);
+                metadataParams.forEach((value, key) => {
+                    const declaration = `${key}: ${value}`;
+                    result.typeMirror.annotations.push({
+                        rawDeclaration: declaration,
+                        name: declaration,
+                        type: declaration,
+                    });
+                });
+            }
+            return result;
+        })
             .filter((reflectionResult) => {
             return reflectionResult.typeMirror;
         })

package/lib/service/parser.js.map

@@ -1 +1 @@
-{"version":3,"file":"parser.js","sourceRoot":"","sources":["../../src/service/parser.ts"],"names":[],"mappings":";;;AAMA,MAAa,aAAa;IACxB,YAAmB,UAAoB;QAApB,eAAU,GAAV,UAAU,CAAU;IAAG,CAAC;IAE3C,KAAK,CAAC,OAA+C;QACnD,OAAO,IAAI,CAAC,UAAU;aACnB,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;aAClC,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;AAXD,sCAWC"}
+{"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"}

package/lib/settings.d.ts

@@ -6,6 +6,7 @@ export interface SettingsConfig {
     scope: string[];
     outputDir: string;
     targetGenerator: GeneratorChoices;
+    indexOnly: boolean;
 }
 export declare class Settings {
     config: SettingsConfig;
@@ -18,4 +19,5 @@ export declare class Settings {
     get scope(): string[];
     get outputDir(): string;
     get typeTranspiler(): ProcessorTypeTranspiler;
+    get indexOnly(): boolean;
 }

package/lib/settings.js

@@ -38,6 +38,9 @@ class Settings {
                 throw Error('Invalid target generator');
         }
     }
+    get indexOnly() {
+        return this.config.indexOnly;
+    }
 }
 exports.Settings = Settings;
 //# sourceMappingURL=settings.js.map

package/lib/settings.js.map

@@ -1 +1 @@
-{"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":";;;AACA,4FAAwF;AACxF,iGAAwF;AAYxF,MAAa,QAAQ;IAGnB,YAA2B,MAAsB;QAAtB,WAAM,GAAN,MAAM,CAAgB;IAAG,CAAC;IAE9C,MAAM,CAAC,KAAK,CAAC,MAAsB;QACxC,QAAQ,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IAEM,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;SACtD;QACD,OAAO,QAAQ,CAAC,QAAQ,CAAC;IAC3B,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;IACrC,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC3B,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,IAAI,cAAc;QAChB,QAAQ,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE;YACnC,KAAK,QAAQ;gBACX,OAAO,IAAI,0CAAmB,EAAE,CAAC;YACnC,KAAK,SAAS;gBACZ,OAAO,IAAI,gCAAoB,EAAE,CAAC;YACpC;gBACE,MAAM,KAAK,CAAC,0BAA0B,CAAC,CAAC;SAC3C;IACH,CAAC;CACF;AA1CD,4BA0CC"}
+{"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":";;;AACA,4FAAwF;AACxF,iGAAwF;AAaxF,MAAa,QAAQ;IAGnB,YAA2B,MAAsB;QAAtB,WAAM,GAAN,MAAM,CAAgB;IAAG,CAAC;IAE9C,MAAM,CAAC,KAAK,CAAC,MAAsB;QACxC,QAAQ,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IAEM,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;SACtD;QACD,OAAO,QAAQ,CAAC,QAAQ,CAAC;IAC3B,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;IACrC,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC3B,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,IAAI,cAAc;QAChB,QAAQ,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE;YACnC,KAAK,QAAQ;gBACX,OAAO,IAAI,0CAAmB,EAAE,CAAC;YACnC,KAAK,SAAS;gBACZ,OAAO,IAAI,gCAAoB,EAAE,CAAC;YACpC;gBACE,MAAM,KAAK,CAAC,0BAA0B,CAAC,CAAC;SAC3C;IACH,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;CACF;AA9CD,4BA8CC"}

package/lib/transpiler/transpiler.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const settings_1 = require("../settings");
 class Transpiler {
     static generate(types, processor) {
         var _a, _b;
@@ -11,6 +12,9 @@ class Transpiler {
             return 0;
         });
         (_a = processor.onBeforeProcess) === null || _a === void 0 ? void 0 : _a.call(processor, sortedTypes);
+        if (settings_1.Settings.getInstance().indexOnly === true) {
+            return;
+        }
         sortedTypes.forEach((currentType) => {
             processor.onProcess(currentType);
         });

package/lib/transpiler/transpiler.js.map

@@ -1 +1 @@
-{"version":3,"file":"transpiler.js","sourceRoot":"","sources":["../../src/transpiler/transpiler.ts"],"names":[],"mappings":";;AAGA,MAAqB,UAAU;IAC7B,MAAM,CAAC,QAAQ,CAAC,KAAa,EAAE,SAAkC;;QAC/D,MAAM,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,SAAS,EAAE,EAAE;YACtD,IAAI,SAAS,CAAC,IAAI,GAAG,SAAS,CAAC,IAAI;gBAAE,OAAO,CAAC,CAAC,CAAC;YAC/C,IAAI,SAAS,CAAC,IAAI,GAAG,SAAS,CAAC,IAAI;gBAAE,OAAO,CAAC,CAAC;YAC9C,OAAO,CAAC,CAAC;QACX,CAAC,CAAC,CAAC;QAEH,MAAA,SAAS,CAAC,eAAe,+CAAzB,SAAS,EAAmB,WAAW,EAAE;QACzC,WAAW,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;YAClC,SAAS,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;QACH,MAAA,SAAS,CAAC,cAAc,+CAAxB,SAAS,EAAkB,WAAW,EAAE;IAC1C,CAAC;CACF;AAdD,6BAcC"}
+{"version":3,"file":"transpiler.js","sourceRoot":"","sources":["../../src/transpiler/transpiler.ts"],"names":[],"mappings":";;AAEA,0CAAuC;AAEvC,MAAqB,UAAU;IAC7B,MAAM,CAAC,QAAQ,CAAC,KAAa,EAAE,SAAkC;;QAC/D,MAAM,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,SAAS,EAAE,EAAE;YACtD,IAAI,SAAS,CAAC,IAAI,GAAG,SAAS,CAAC,IAAI;gBAAE,OAAO,CAAC,CAAC,CAAC;YAC/C,IAAI,SAAS,CAAC,IAAI,GAAG,SAAS,CAAC,IAAI;gBAAE,OAAO,CAAC,CAAC;YAC9C,OAAO,CAAC,CAAC;QACX,CAAC,CAAC,CAAC;QAEH,MAAA,SAAS,CAAC,eAAe,+CAAzB,SAAS,EAAmB,WAAW,EAAE;QAEzC,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,SAAS,KAAK,IAAI,EAAE;YAC7C,OAAO;SACR;QAED,WAAW,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;YAClC,SAAS,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;QACH,MAAA,SAAS,CAAC,cAAc,+CAAxB,SAAS,EAAkB,WAAW,EAAE;IAC1C,CAAC;CACF;AAnBD,6BAmBC"}

package/lib/util/error-logger.d.ts

@@ -0,0 +1,8 @@
+import { Type } from '@cparra/apex-reflection';
+export default class ErrorLogger {
+    static logErrors(types: Type[]): void;
+    private static logErrorsForSingleType;
+    private static logTypeErrors;
+    private static logErrorsForClass;
+    private static logErrorsForInterface;
+}

package/lib/util/error-logger.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class ErrorLogger {
+    static logErrors(types) {
+        types.forEach((currentType) => {
+            this.logErrorsForSingleType(currentType);
+        });
+    }
+    static logErrorsForSingleType(currentType, parentType) {
+        this.logTypeErrors(currentType);
+        if (currentType.type_name === 'class') {
+            this.logErrorsForClass(currentType);
+        }
+        else if (currentType.type_name === 'interface') {
+            this.logErrorsForInterface(currentType);
+        }
+    }
+    static logTypeErrors(currentType, parentType) {
+        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('=================================');
+        }
+    }
+    static logErrorsForClass(classMirror, parentType) {
+        const typeName = parentType ? `${parentType.name}.${classMirror.name}` : classMirror.name;
+        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('=================================');
+            }
+        });
+        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('=================================');
+            }
+        });
+        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('=================================');
+            }
+        });
+        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('=================================');
+            }
+        });
+        classMirror.enums.forEach((currentEnum) => {
+            this.logErrorsForSingleType(currentEnum, classMirror);
+        });
+        classMirror.interfaces.forEach((currentInterface) => {
+            this.logErrorsForSingleType(currentInterface, classMirror);
+        });
+        classMirror.classes.forEach((currentClass) => {
+            this.logErrorsForSingleType(currentClass, classMirror);
+        });
+    }
+    static logErrorsForInterface(interfaceMirror) {
+        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('=================================');
+            }
+        });
+    }
+}
+exports.default = ErrorLogger;
+//# sourceMappingURL=error-logger.js.map

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

@@ -0,0 +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"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cparra/apexdocs",
-  "version": "2.1.4",
+  "version": "2.2.2",
   "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
   "keywords": [
     "apex",
@@ -24,7 +24,8 @@
     "postversion": "git push && git push --tags",
     "docs:init": "docsify init docs",
     "docs:serve": "docsify serve docs",
-    "execute:example": "node lib/cli/generate.js -s examples/force-app -t docs --scope global public private -g docsify"
+    "execute:example": "node lib/cli/generate.js -s examples/force-app -t docs --scope global public private -g docsify",
+    "execute:example:index:only": "node lib/cli/generate.js -s examples/force-app -t docs --scope global public private -g docsify --indexOnly"
   },
   "author": "Cesar Parra",
   "license": "MIT",
@@ -63,7 +64,8 @@
     ]
   },
   "dependencies": {
-    "@cparra/apex-reflection": "^1.1.3",
+    "@cparra/apex-reflection": "^1.4.0",
+    "fast-xml-parser": "^4.0.1",
     "chalk": "^4.1.2",
     "html-entities": "^2.3.2",
     "yargs": "^16.0.3"

package/src/application/Apexdocs.ts

@@ -1,6 +1,6 @@
 import { ApexFileReader } from '../service/apex-file-reader';
 import { DefaultFileSystem } from '../service/file-system';
-import { ReflectionResult, reflect, Type } from '@cparra/apex-reflection';
+import { ReflectionResult, reflect, Type, ClassMirror } from '@cparra/apex-reflection';
 import { Logger } from '../util/logger';
 import { createManifest } from '../service/manifest-factory';
 import { RawBodyParser } from '../service/parser';
@@ -8,6 +8,7 @@ import { Settings } from '../settings';
 import Transpiler from '../transpiler/transpiler';
 import { FileWriter } from '../service/file-writer';
 import { TypesRepository } from '../model/types-repository';
+import ErrorLogger from '../util/error-logger';
 
 /**
  * Application entry-point to generate documentation out of Apex source files.
@@ -30,6 +31,9 @@ export class Apexdocs {
     FileWriter.write(generatedFiles, (fileName: string) => {
       Logger.log(`${fileName} processed.`);
     });
+
+    // Error logging
+    ErrorLogger.logErrors(filteredTypes);
   }
 
   static _reflectionWithLogger = (declarationBody: string): ReflectionResult => {

package/src/cli/generate.ts

@@ -39,6 +39,11 @@ const argv = yargs.options({
     describe:
       'Define the static file generator for which the documents will be created. Currently supports jekyll, and docsify.',
   },
+  indexOnly: {
+    type: 'boolean',
+    default: false,
+    describe: 'Defines whether only the index file should be  generated.',
+  },
 }).argv;
 
 Settings.build({
@@ -47,6 +52,7 @@ Settings.build({
   scope: argv.scope,
   outputDir: argv.targetDir,
   targetGenerator: argv.targetGenerator as GeneratorChoices,
+  indexOnly: argv.indexOnly,
 });
 
 Apexdocs.generate();

package/src/model/apex-bundle.ts

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

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

@@ -11,6 +11,7 @@ describe('File Reader', () => {
       group: true,
       outputDir: '',
       scope: [],
+      indexOnly: false,
     } as SettingsConfig);
   });
 
@@ -32,6 +33,9 @@ describe('File Reader', () => {
       readFile(_: string): string {
         return '';
       },
+      exists(): boolean {
+        return true;
+      },
     });
     expect(result.length).toBe(0);
   });
@@ -50,6 +54,9 @@ describe('File Reader', () => {
       readFile(_: string): string {
         return '';
       },
+      exists(): boolean {
+        return true;
+      },
     });
     expect(result.length).toBe(0);
   });
@@ -72,8 +79,11 @@ describe('File Reader', () => {
       readFile(_: string): string {
         return 'public class MyClass{}';
       },
+      exists(): boolean {
+        return true;
+      },
     });
     expect(result.length).toBe(1);
-    expect(result[0]).toBe('public class MyClass{}');
+    expect(result[0].rawTypeContent).toBe('public class MyClass{}');
   });
 });

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

@@ -1,5 +1,6 @@
 import { Settings } from '../settings';
 import { FileSystem } from './file-system';
+import ApexBundle from '../model/apex-bundle';
 
 const APEX_FILE_EXTENSION = '.cls';
 
@@ -10,8 +11,8 @@ export class ApexFileReader {
   /**
    * Reads from .cls files and returns their raw body.
    */
-  static processFiles(fileSystem: FileSystem, rootPath: string = this.sourceDirectory): string[] {
-    let bodies: string[] = [];
+  static processFiles(fileSystem: FileSystem, rootPath: string = this.sourceDirectory): ApexBundle[] {
+    let bodies: ApexBundle[] = [];
 
     const directoryContents = fileSystem.readDirectory(rootPath);
     directoryContents.forEach((currentFilePath) => {
@@ -24,8 +25,10 @@ export class ApexFileReader {
         return;
       }
 
-      const rawFile = fileSystem.readFile(currentPath);
-      bodies.push(rawFile);
+      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));
     });
     return bodies;
   }

package/src/service/file-system.ts

@@ -6,6 +6,7 @@ export interface FileSystem {
   isDirectory: (path: string) => boolean;
   readFile: (path: string) => string;
   joinPath: (...paths: string[]) => string;
+  exists: (path: string) => boolean;
 }
 
 export class DefaultFileSystem implements FileSystem {
@@ -25,4 +26,8 @@ export class DefaultFileSystem implements FileSystem {
   joinPath(...paths: string[]): string {
     return path.join(...paths);
   }
+
+  exists(path: string): boolean {
+    return fs.existsSync(path);
+  }
 }

package/src/service/metadata-processor.ts

@@ -0,0 +1,13 @@
+import { XMLParser } from 'fast-xml-parser';
+
+export default class MetadataProcessor {
+  public static process(input: string) {
+    const map = new Map<string, string>();
+    const xml = new XMLParser().parse(input);
+
+    map.set('apiVersion', xml.ApexClass.apiVersion ?? '');
+
+    map.set('status', xml.ApexClass.status ?? '');
+    return map;
+  }
+}

package/src/service/parser.ts

@@ -1,15 +1,32 @@
 import { Type, ReflectionResult } from '@cparra/apex-reflection';
+import ApexBundle from '../model/apex-bundle';
+import MetadataProcessor from './metadata-processor';
 
 export interface TypeParser {
   parse(reflect: (typeBody: string) => ReflectionResult): Type[];
 }
 
 export class RawBodyParser implements TypeParser {
-  constructor(public typeBodies: string[]) {}
+  constructor(public typeBundles: ApexBundle[]) {}
 
   parse(reflect: (typeBody: string) => ReflectionResult): Type[] {
-    return this.typeBodies
-      .map((rawBody) => reflect(rawBody))
+    return this.typeBundles
+      .map((currentBundle) => {
+        const result = reflect(currentBundle.rawTypeContent);
+        if (!!result.typeMirror && !!currentBundle.rawMetadataContent) {
+          // If successful and there is a metadata file
+          const metadataParams = MetadataProcessor.process(currentBundle.rawMetadataContent);
+          metadataParams.forEach((value, key) => {
+            const declaration = `${key}: ${value}`;
+            result.typeMirror!.annotations.push({
+              rawDeclaration: declaration,
+              name: declaration,
+              type: declaration,
+            });
+          });
+        }
+        return result;
+      })
       .filter((reflectionResult) => {
         return reflectionResult.typeMirror;
       })

package/src/settings.ts

@@ -10,6 +10,7 @@ export interface SettingsConfig {
   scope: string[];
   outputDir: string;
   targetGenerator: GeneratorChoices;
+  indexOnly: boolean;
 }
 
 export class Settings {
@@ -54,4 +55,8 @@ export class Settings {
         throw Error('Invalid target generator');
     }
   }
+
+  get indexOnly(): boolean {
+    return this.config.indexOnly;
+  }
 }

package/src/transpiler/transpiler.ts

@@ -1,5 +1,6 @@
 import { Type } from '@cparra/apex-reflection';
 import ProcessorTypeTranspiler from './processor-type-transpiler';
+import { Settings } from '../settings';
 
 export default class Transpiler {
   static generate(types: Type[], processor: ProcessorTypeTranspiler): void {
@@ -10,6 +11,11 @@ export default class Transpiler {
     });
 
     processor.onBeforeProcess?.(sortedTypes);
+
+    if (Settings.getInstance().indexOnly === true) {
+      return;
+    }
+
     sortedTypes.forEach((currentType) => {
       processor.onProcess(currentType);
     });

package/src/util/error-logger.ts

@@ -0,0 +1,91 @@
+import { ClassMirror, InterfaceMirror, Type } from '@cparra/apex-reflection';
+
+export default class ErrorLogger {
+  public static logErrors(types: Type[]): void {
+    types.forEach((currentType) => {
+      this.logErrorsForSingleType(currentType);
+    });
+  }
+
+  private static logErrorsForSingleType(currentType: Type, parentType?: 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;
+      console.log(`${typeName} - Doc comment parsing error. Level: Type`);
+      console.log(`Comment:\n ${currentType.docComment.rawDeclaration}`);
+      console.log(currentType.docComment.error);
+      console.log('=================================');
+    }
+  }
+
+  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) {
+        console.log(`${typeName} - Doc comment parsing error. Level: Constructor`);
+        console.log(`Comment:\n ${currentConstructor.docComment.rawDeclaration}`);
+        console.log(currentConstructor.docComment.error);
+        console.log('=================================');
+      }
+    });
+
+    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('=================================');
+      }
+    });
+
+    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('=================================');
+      }
+    });
+
+    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('=================================');
+      }
+    });
+
+    classMirror.enums.forEach((currentEnum) => {
+      this.logErrorsForSingleType(currentEnum, classMirror);
+    });
+
+    classMirror.interfaces.forEach((currentInterface) => {
+      this.logErrorsForSingleType(currentInterface, classMirror);
+    });
+
+    classMirror.classes.forEach((currentClass) => {
+      this.logErrorsForSingleType(currentClass, classMirror);
+    });
+  }
+
+  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('=================================');
+      }
+    });
+  }
+}