@cparra/apexdocs 2.1.2 → 2.2.0

package/README.md

@@ -110,12 +110,13 @@ apexdocs-generate
 The CLI supports the following parameters:
 
 | Parameter         | Alias | Description                                                                                                              | Default                             | Required |
-| ----------------- | ----- |--------------------------------------------------------------------------------------------------------------------------| ----------------------------------- | -------- |
+|-------------------|-------|--------------------------------------------------------------------------------------------------------------------------|-------------------------------------|----------|
 | --sourceDir       | -s    | The directory location which contains your apex .cls classes.                                                            | N/A                                 | Yes      |
 | --targetDir       | -t    | The directory location where documentation will be generated to.                                                         | `docs`                              | No       |
 | --recursive       | -r    | Whether .cls classes will be searched for recursively in the directory provided.                                         | `true`                              | No       |
 | --scope           | -p    | A list of scopes to document. Values should be separated by a space, e.g --scope public private                          | `global namespaceaccessible public` | No       |
 | --targetGenerator | -g    | Define the static file generator for which the documents will be created. Currently supports jekyll and docsify.         | `jekyll`                            | No       |
+| --indexOnly       | N/A   | Defines whether only the index file should be  generated.                                                                | `false`                             | No       |
 | --configPath      | -c    | (Only versions 1.X) The path to the JSON configuration file that defines the structure of the documents to docGenerator. | N/A                                 | No       |
 | --group           | -o    | (Only versions 1.X) Define whether the generated files should be grouped by the @group tag on the top level classes.     | `true`                              | No       |
 

package/ROADMAP.md

@@ -1,18 +1,16 @@
-[] Respect access modifiers where the properties/methods are different from the class declaration. For example,
+[ ] Respect access modifiers where the properties/methods are different from the class declaration. For example,
 AuraEnabled properties do not live in an AuraEnabled class, so there's no way to just generate docs to showcase the
 AuraEnabled properties of a class without some sort of combination of also exposing other public/globals
 
-[] Versioning capabilities. When creating the doc you specify a version number, and a new directory is created for the
+[ ] Versioning capabilities. When creating the doc you specify a version number, and a new directory is created for the
 files, instead of just overriding
 
-[] New generatortype: To JsDocs from AuraEnabled
+[ ] New generatortype: To JsDocs from AuraEnabled
 
-[] More unit tests
+[ ] More unit tests
 
-[] config.js support to allow for injections, home header, etc.
+[ ] config.js support to allow for injections, home header, etc.
 
-[] Add configuration setting that allows someone to set the "namespace"
+[ ] Add configuration setting that allows someone to set the "namespace"
 
-[] Homepage support similar to what docsify does
-
-[] TW template
+[ ] Homepage support similar to what docsify does

package/docs/Sample-Classes/SampleClass.md

@@ -2,6 +2,10 @@
 
 `NAMESPACEACCESSIBLE`
 
+`APIVERSION: 54`
+
+`STATUS: ACTIVE`
+
 This is a class description. This class relates to [SampleInterface](/Sample-Interfaces/SampleInterface.md)              But this ClassThatDoesNotExist does not exist.              You can also link using this syntax [SampleInterface](/Sample-Interfaces/SampleInterface.md)
 
 

package/examples/force-app/main/default/classes/SampleClass.cls-meta.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
+    <apiVersion>54.0</apiVersion>
+    <status>Active</status>
+</ApexClass>

package/examples/force-app/main/default/classes/SampleClassWithoutModifier.cls

@@ -1,9 +1,9 @@
-@IsTest
-class SampleClassWithoutModifier {
-    /**
-     * @description This is a test method
-     */
-    @IsTest
-    private static void thisIsAClassWithoutAModifier() {
-    }
-}
+@IsTest
+class SampleClassWithoutModifier {
+    /**
+     * @description This is a test method
+     */
+    @IsTest
+    private static void thisIsAClassWithoutAModifier() {
+    }
+}

package/lib/cli/generate.js

@@ -37,6 +37,11 @@ const argv = yargs.options({
         choices: ['jekyll', 'docsify'],
         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_1.Settings.build({
     sourceDirectory: argv.sourceDir,
@@ -44,6 +49,7 @@ settings_1.Settings.build({
     scope: argv.scope,
     outputDir: argv.targetDir,
     targetGenerator: argv.targetGenerator,
+    indexOnly: argv.indexOnly,
 });
 Apexdocs_1.Apexdocs.generate();
 //# sourceMappingURL=generate.js.map

package/lib/cli/generate.js.map

@@ -1 +1 @@
-{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../src/cli/generate.ts"],"names":[],"mappings":";;;AACA,+BAA+B;AAE/B,0CAAyD;AACzD,sDAAmD;AAEnD,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC;IACzB,SAAS,EAAE;QACT,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;QACV,YAAY,EAAE,IAAI;QAClB,QAAQ,EAAE,+DAA+D;KAC1E;IACD,SAAS,EAAE;QACT,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,SAAS;QAClB,QAAQ,EAAE,kEAAkE;KAC7E;IACD,SAAS,EAAE;QACT,IAAI,EAAE,SAAS;QACf,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,IAAI;QACb,QAAQ,EAAE,kFAAkF;KAC7F;IACD,KAAK,EAAE;QACL,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,CAAC,QAAQ,CAAC;QACnB,QAAQ,EACN,sHAAsH;YACtH,0HAA0H;KAC7H;IACD,eAAe,EAAE;QACf,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,QAAQ;QACjB,OAAO,EAAE,CAAC,QAAQ,EAAE,SAAS,CAAC;QAC9B,QAAQ,EACN,mHAAmH;KACtH;CACF,CAAC,CAAC,IAAI,CAAC;AAER,mBAAQ,CAAC,KAAK,CAAC;IACb,eAAe,EAAE,IAAI,CAAC,SAAS;IAC/B,SAAS,EAAE,IAAI,CAAC,SAAS;IACzB,KAAK,EAAE,IAAI,CAAC,KAAK;IACjB,SAAS,EAAE,IAAI,CAAC,SAAS;IACzB,eAAe,EAAE,IAAI,CAAC,eAAmC;CAC1D,CAAC,CAAC;AAEH,mBAAQ,CAAC,QAAQ,EAAE,CAAC"}
+{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../src/cli/generate.ts"],"names":[],"mappings":";;;AACA,+BAA+B;AAE/B,0CAAyD;AACzD,sDAAmD;AAEnD,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC;IACzB,SAAS,EAAE;QACT,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;QACV,YAAY,EAAE,IAAI;QAClB,QAAQ,EAAE,+DAA+D;KAC1E;IACD,SAAS,EAAE;QACT,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,SAAS;QAClB,QAAQ,EAAE,kEAAkE;KAC7E;IACD,SAAS,EAAE;QACT,IAAI,EAAE,SAAS;QACf,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,IAAI;QACb,QAAQ,EAAE,kFAAkF;KAC7F;IACD,KAAK,EAAE;QACL,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,CAAC,QAAQ,CAAC;QACnB,QAAQ,EACN,sHAAsH;YACtH,0HAA0H;KAC7H;IACD,eAAe,EAAE;QACf,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,QAAQ;QACjB,OAAO,EAAE,CAAC,QAAQ,EAAE,SAAS,CAAC;QAC9B,QAAQ,EACN,mHAAmH;KACtH;IACD,SAAS,EAAE;QACT,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,KAAK;QACd,QAAQ,EAAE,2DAA2D;KACtE;CACF,CAAC,CAAC,IAAI,CAAC;AAER,mBAAQ,CAAC,KAAK,CAAC;IACb,eAAe,EAAE,IAAI,CAAC,SAAS;IAC/B,SAAS,EAAE,IAAI,CAAC,SAAS;IACzB,KAAK,EAAE,IAAI,CAAC,KAAK;IACjB,SAAS,EAAE,IAAI,CAAC,SAAS;IACzB,eAAe,EAAE,IAAI,CAAC,eAAmC;IACzD,SAAS,EAAE,IAAI,CAAC,SAAS;CAC1B,CAAC,CAAC;AAEH,mBAAQ,CAAC,QAAQ,EAAE,CAAC"}

package/lib/model/apex-bundle.d.ts

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

package/lib/model/apex-bundle.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class ApexBundle {
+    constructor(rawTypeContent, rawMetadataContent) {
+        this.rawTypeContent = rawTypeContent;
+        this.rawMetadataContent = rawMetadataContent;
+    }
+}
+exports.default = ApexBundle;
+//# sourceMappingURL=apex-bundle.js.map

package/lib/model/apex-bundle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apex-bundle.js","sourceRoot":"","sources":["../../src/model/apex-bundle.ts"],"names":[],"mappings":";;AAAA,MAAqB,UAAU;IAC7B,YAAmB,cAAsB,EAAS,kBAAiC;QAAhE,mBAAc,GAAd,cAAc,CAAQ;QAAS,uBAAkB,GAAlB,kBAAkB,CAAe;IAAG,CAAC;CACxF;AAFD,6BAEC"}

package/lib/service/apex-file-reader.d.ts

@@ -1,4 +1,5 @@
 import { FileSystem } from './file-system';
+import ApexBundle from '../model/apex-bundle';
 /**
  * Reads from .cls files and returns their raw body.
  */
@@ -6,7 +7,7 @@ export declare class ApexFileReader {
     /**
      * Reads from .cls files and returns their raw body.
      */
-    static processFiles(fileSystem: FileSystem, rootPath?: string): string[];
+    static processFiles(fileSystem: FileSystem, rootPath?: string): ApexBundle[];
     private static isApexFile;
     private static get sourceDirectory();
     private static get readRecursively();

package/lib/service/apex-file-reader.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApexFileReader = void 0;
 const settings_1 = require("../settings");
+const apex_bundle_1 = require("../model/apex-bundle");
 const APEX_FILE_EXTENSION = '.cls';
 /**
  * Reads from .cls files and returns their raw body.
@@ -21,8 +22,10 @@ class ApexFileReader {
             if (!this.isApexFile(currentFilePath)) {
                 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 apex_bundle_1.default(rawApexFile, rawMetadataFile));
         });
         return bodies;
     }

package/lib/service/apex-file-reader.js.map

@@ -1 +1 @@
-{"version":3,"file":"apex-file-reader.js","sourceRoot":"","sources":["../../src/service/apex-file-reader.ts"],"names":[],"mappings":";;;AAAA,0CAAuC;AAGvC,MAAM,mBAAmB,GAAG,MAAM,CAAC;AAEnC;;GAEG;AACH,MAAa,cAAc;IACzB;;OAEG;IACH,MAAM,CAAC,YAAY,CAAC,UAAsB,EAAE,WAAmB,IAAI,CAAC,eAAe;QACjF,IAAI,MAAM,GAAa,EAAE,CAAC;QAE1B,MAAM,iBAAiB,GAAG,UAAU,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QAC7D,iBAAiB,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,EAAE;YAC5C,MAAM,WAAW,GAAG,UAAU,CAAC,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;YACnE,IAAI,IAAI,CAAC,eAAe,IAAI,UAAU,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE;gBAC/D,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC;aACpE;YAED,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE;gBACrC,OAAO;aACR;YAED,MAAM,OAAO,GAAG,UAAU,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;YACjD,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,MAAM,CAAC,UAAU,CAAC,WAAmB;QAC3C,OAAO,WAAW,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IACnD,CAAC;IAEO,MAAM,KAAK,eAAe;QAChC,OAAO,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,CAAC;IAChD,CAAC;IAEO,MAAM,KAAK,eAAe;QAChC,OAAO,mBAAQ,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC;IAC1C,CAAC;CACF;AAnCD,wCAmCC"}
+{"version":3,"file":"apex-file-reader.js","sourceRoot":"","sources":["../../src/service/apex-file-reader.ts"],"names":[],"mappings":";;;AAAA,0CAAuC;AAEvC,sDAA8C;AAE9C,MAAM,mBAAmB,GAAG,MAAM,CAAC;AAEnC;;GAEG;AACH,MAAa,cAAc;IACzB;;OAEG;IACH,MAAM,CAAC,YAAY,CAAC,UAAsB,EAAE,WAAmB,IAAI,CAAC,eAAe;QACjF,IAAI,MAAM,GAAiB,EAAE,CAAC;QAE9B,MAAM,iBAAiB,GAAG,UAAU,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QAC7D,iBAAiB,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,EAAE;YAC5C,MAAM,WAAW,GAAG,UAAU,CAAC,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;YACnE,IAAI,IAAI,CAAC,eAAe,IAAI,UAAU,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE;gBAC/D,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC;aACpE;YAED,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE;gBACrC,OAAO;aACR;YAED,MAAM,WAAW,GAAG,UAAU,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;YACrD,MAAM,YAAY,GAAG,UAAU,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,eAAe,WAAW,CAAC,CAAC;YAClF,MAAM,eAAe,GAAG,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YACnG,MAAM,CAAC,IAAI,CAAC,IAAI,qBAAU,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC,CAAC;QAC5D,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,MAAM,CAAC,UAAU,CAAC,WAAmB;QAC3C,OAAO,WAAW,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IACnD,CAAC;IAEO,MAAM,KAAK,eAAe;QAChC,OAAO,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,CAAC;IAChD,CAAC;IAEO,MAAM,KAAK,eAAe;QAChC,OAAO,mBAAQ,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC;IAC1C,CAAC;CACF;AArCD,wCAqCC"}

package/lib/service/file-system.d.ts

@@ -3,10 +3,12 @@ export interface FileSystem {
     isDirectory: (path: string) => boolean;
     readFile: (path: string) => string;
     joinPath: (...paths: string[]) => string;
+    exists: (path: string) => boolean;
 }
 export declare class DefaultFileSystem implements FileSystem {
     isDirectory(pathToRead: string): boolean;
     readDirectory(sourceDirectory: string): string[];
     readFile(pathToRead: string): string;
     joinPath(...paths: string[]): string;
+    exists(path: string): boolean;
 }

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cparra/apexdocs",
-  "version": "2.1.2",
+  "version": "2.2.0",
   "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.2",
+    "@cparra/apex-reflection": "^1.1.3",
+    "fast-xml-parser": "^4.0.1",
     "chalk": "^4.1.2",
     "html-entities": "^2.3.2",
     "yargs": "^16.0.3"

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);
     });