@cparra/apexdocs 2.22.0 → 2.23.0-beta.0

package/lib/settings.js.map

@@ -1 +1 @@
-{"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":";;;AAkCA,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,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,YAAY;QACd,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;IAClC,CAAC;IAEM,mBAAmB;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC;IACtC,CAAC;IAEM,eAAe;;QACpB,OAAO,MAAA,IAAI,CAAC,MAAM,CAAC,YAAY,mCAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IACvD,CAAC;IAEM,QAAQ;QACb,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC3B,CAAC;IAEM,YAAY;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAEM,kBAAkB;QACvB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE;YAC1B,OAAO,EAAE,CAAC;SACX;QACD,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC;IACrC,CAAC;IAEM,eAAe;QACpB,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;IACrC,CAAC;IAEM,eAAe;QACpB,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;IACrC,CAAC;IAEM,UAAU;QACf,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;IAC7B,CAAC;IAEM,cAAc,CAAC,KAAmB;QACvC,IAAI,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE;YAC9B,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;SACnC;IACH,CAAC;IAEM,iBAAiB,CAAC,IAAgB;QACvC,IAAI,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE;YACjC,OAAO,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;SAC5C;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA3FD,4BA2FC"}
+{"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":";;;AA4CA,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,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,YAAY;QACd,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;IAClC,CAAC;IAEM,mBAAmB;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC;IACtC,CAAC;IAEM,eAAe;;QACpB,OAAO,MAAA,IAAI,CAAC,MAAM,CAAC,YAAY,mCAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IACvD,CAAC;IAEM,QAAQ;QACb,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC3B,CAAC;IAEM,YAAY;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAEM,kBAAkB;QACvB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE;YAC1B,OAAO,EAAE,CAAC;SACX;QACD,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC;IACrC,CAAC;IAEM,eAAe;QACpB,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;IACrC,CAAC;IAEM,eAAe;QACpB,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;IACrC,CAAC;IAEM,yBAAyB;;QAC9B,OAAO,MAAA,IAAI,CAAC,MAAM,CAAC,yBAAyB,mCAAI,KAAK,CAAC;IACxD,CAAC;IAEM,UAAU;QACf,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;IAC7B,CAAC;IAEM,cAAc,CAAC,KAAmB;QACvC,IAAI,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE;YAC9B,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;SACnC;IACH,CAAC;IAEM,iBAAiB,CAAC,IAAgB;QACvC,IAAI,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE;YACjC,OAAO,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;SAC5C;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,iBAAiB,CAAC,IAAgB;QACvC,IAAI,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE;YACjC,OAAO,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;SAC5C;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;CACF;AAtGD,4BAsGC"}

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

@@ -37,12 +37,12 @@ class ClassFileGeneratorHelper {
                 return './';
             }
             else {
-                // If the types have different groups then we have to go up a directory
+                // If the types have different groups, then we have to go up a directory
                 return `../${this.getSanitizedGroup(classModel)}/`;
             }
         }
         else {
-            // If nothing is being processed then we assume we are at the root and links should include the groups
+            // If nothing is being processed, then we assume we are at the root and links should include the groups
             return `./${this.getSanitizedGroup(classModel)}/`;
         }
     }

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;AAC/D,6CAA0C;AAC1C,+CAAwC;AACxC,wCAAmD;AAEnD,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,MAAM,iBAAiB,GAAG,MAAA,mBAAQ,CAAC,WAAW,EAAE,CAAC,UAAU,EAAE,mCAAI,EAAE,CAAC;QACpE,MAAM,aAAa,GAAG,GAAG,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,CAAC;QACjF,MAAM,aAAa,GAAG,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,kBAAkB,EAAE,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC;QACzF,OAAO,IAAI,aAAa,KAAK,aAAa,GAAG,aAAa,MAAM,CAAC;IACnE,CAAC;IAEM,MAAM,CAAC,qBAAqB,CAAC,QAAgB;QAClD,MAAM,IAAI,GAAG,kCAAe,CAAC,WAAW,EAAE,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;QACzE,IAAI,CAAC,IAAI,EAAE;YACT,sFAAsF;YACtF,OAAO,IAAI,QAAQ,KAAK,QAAQ,GAAG,CAAC;SACrC;QAED,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,UAAgB;QAC9C,iEAAiE;QACjE,MAAM,SAAS,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,CAAC;QACzD,IAAI,+BAAqB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,kBAAkB,EAAE,KAAK,eAAe,EAAE;YACjF,OAAO,IAAI,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;SAClD;QAED,uDAAuD;QACvD,MAAM,kBAAkB,GAAG,eAAK,CAAC,WAAW,EAAE,CAAC,qBAAqB,EAAE,CAAC;QACvE,IAAI,kBAAkB,EAAE;YACtB,IAAI,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,KAAK,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE;gBAC7E,yEAAyE;gBACzE,OAAO,IAAI,CAAC;aACb;iBAAM;gBACL,uEAAuE;gBACvE,OAAO,MAAM,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;aACpD;SACF;aAAM;YACL,sGAAsG;YACtG,OAAO,KAAK,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;SACnD;IACH,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,UAAgB;;QAC3C,MAAM,eAAe,GAAG,MAAA,UAAU,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAC7D,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,OAAO,CAC1D,CAAC;QACF,OAAO,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,IAAI,mCAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,mBAAmB,EAAE,CAAC;IAC/E,CAAC;CACF;AAnDD,2CAmDC"}
+{"version":3,"file":"class-file-generatorHelper.js","sourceRoot":"","sources":["../../../src/transpiler/markdown/class-file-generatorHelper.ts"],"names":[],"mappings":";;AACA,mEAA+D;AAC/D,6CAA0C;AAC1C,+CAAwC;AACxC,wCAAmD;AAEnD,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,MAAM,iBAAiB,GAAG,MAAA,mBAAQ,CAAC,WAAW,EAAE,CAAC,UAAU,EAAE,mCAAI,EAAE,CAAC;QACpE,MAAM,aAAa,GAAG,GAAG,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,CAAC;QACjF,MAAM,aAAa,GAAG,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,kBAAkB,EAAE,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC;QACzF,OAAO,IAAI,aAAa,KAAK,aAAa,GAAG,aAAa,MAAM,CAAC;IACnE,CAAC;IAEM,MAAM,CAAC,qBAAqB,CAAC,QAAgB;QAClD,MAAM,IAAI,GAAG,kCAAe,CAAC,WAAW,EAAE,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;QACzE,IAAI,CAAC,IAAI,EAAE;YACT,sFAAsF;YACtF,OAAO,IAAI,QAAQ,KAAK,QAAQ,GAAG,CAAC;SACrC;QAED,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,UAAgB;QAC9C,iEAAiE;QACjE,MAAM,SAAS,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,CAAC;QACzD,IAAI,+BAAqB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,kBAAkB,EAAE,KAAK,eAAe,EAAE;YACjF,OAAO,IAAI,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;SAClD;QAED,uDAAuD;QACvD,MAAM,kBAAkB,GAAG,eAAK,CAAC,WAAW,EAAE,CAAC,qBAAqB,EAAE,CAAC;QACvE,IAAI,kBAAkB,EAAE;YACtB,IAAI,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,KAAK,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE;gBAC7E,yEAAyE;gBACzE,OAAO,IAAI,CAAC;aACb;iBAAM;gBACL,wEAAwE;gBACxE,OAAO,MAAM,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;aACpD;SACF;aAAM;YACL,uGAAuG;YACvG,OAAO,KAAK,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;SACnD;IACH,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,UAAgB;;QAC3C,MAAM,eAAe,GAAG,MAAA,UAAU,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAC7D,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,OAAO,CAC1D,CAAC;QACF,OAAO,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,IAAI,mCAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,mBAAmB,EAAE,CAAC;IAC/E,CAAC;CACF;AAnDD,2CAmDC"}

package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.d.ts

@@ -5,6 +5,7 @@ export declare class JekyllDocsProcessor extends MarkdownTranspilerBase {
     homeFileName(): string;
     onBeforeProcess: (types: Type[]) => void;
     onProcess(type: Type): void;
-    get frontMatterHeader(): string;
+    get frontMatterForHomeFile(): string;
+    getFrontMatterHeader(type: Type): string;
     getLinkingStrategy(): LinkingStrategy;
 }

package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js

@@ -4,22 +4,45 @@ exports.JekyllDocsProcessor = void 0;
 const markdown_transpiler_base_1 = require("../markdown-transpiler-base");
 const markdown_home_file_1 = require("../../../model/markdown-home-file");
 const markdown_type_file_1 = require("../../../model/markdown-type-file");
+const settings_1 = require("../../../settings");
 class JekyllDocsProcessor extends markdown_transpiler_base_1.MarkdownTranspilerBase {
     constructor() {
         super(...arguments);
         this.onBeforeProcess = (types) => {
-            this._fileContainer.pushFile(new markdown_home_file_1.MarkdownHomeFile(this.homeFileName(), types, this.frontMatterHeader));
+            this._fileContainer.pushFile(new markdown_home_file_1.MarkdownHomeFile(this.homeFileName(), types, this.frontMatterForHomeFile));
         };
     }
     homeFileName() {
         return 'index';
     }
     onProcess(type) {
-        this._fileContainer.pushFile(new markdown_type_file_1.MarkdownTypeFile(type, 1, this.frontMatterHeader));
+        this._fileContainer.pushFile(new markdown_type_file_1.MarkdownTypeFile(type, 1, this.getFrontMatterHeader(type)));
     }
-    get frontMatterHeader() {
+    get frontMatterForHomeFile() {
         return '---\nlayout: default\n---';
     }
+    getFrontMatterHeader(type) {
+        var _a;
+        const headerLines = ['---'];
+        // "layout: default" is a required front matter header for Jekyll
+        headerLines.push('layout: default');
+        // Add any additional front matter headers that might have been configured in the settings
+        const targetType = {
+            name: type.name,
+            typeName: type.type_name,
+            accessModifier: type.access_modifier,
+            group: type.group,
+            description: (_a = type.docComment) === null || _a === void 0 ? void 0 : _a.description,
+        };
+        const configuredHeaders = settings_1.Settings.getInstance().frontMatterHeader(targetType);
+        if (configuredHeaders) {
+            configuredHeaders.forEach((header) => {
+                headerLines.push(header);
+            });
+        }
+        headerLines.push('---');
+        return headerLines.join('\n');
+    }
     getLinkingStrategy() {
         return 'path-relative';
     }

package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js.map

@@ -1 +1 @@
-{"version":3,"file":"jekyll-docsProcessor.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/jekyll/jekyll-docsProcessor.ts"],"names":[],"mappings":";;;AAAA,0EAAqE;AAErE,0EAAqE;AACrE,0EAAqE;AAGrE,MAAa,mBAAoB,SAAQ,iDAAsB;IAA/D;;QAKE,oBAAe,GAAG,CAAC,KAAa,EAAE,EAAE;YAClC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;QACzG,CAAC,CAAC;IAaJ,CAAC;IAnBC,YAAY;QACV,OAAO,OAAO,CAAC;IACjB,CAAC;IAMD,SAAS,CAAC,IAAU;QAClB,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACtF,CAAC;IAED,IAAI,iBAAiB;QACnB,OAAO,2BAA2B,CAAC;IACrC,CAAC;IAED,kBAAkB;QAChB,OAAO,eAAe,CAAC;IACzB,CAAC;CACF;AApBD,kDAoBC"}
+{"version":3,"file":"jekyll-docsProcessor.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/jekyll/jekyll-docsProcessor.ts"],"names":[],"mappings":";;;AAAA,0EAAqE;AAErE,0EAAqE;AACrE,0EAAqE;AAErE,gDAA6C;AAE7C,MAAa,mBAAoB,SAAQ,iDAAsB;IAA/D;;QAKE,oBAAe,GAAG,CAAC,KAAa,EAAE,EAAE;YAClC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC;QAC9G,CAAC,CAAC;IAmCJ,CAAC;IAzCC,YAAY;QACV,OAAO,OAAO,CAAC;IACjB,CAAC;IAMD,SAAS,CAAC,IAAU;QAClB,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC/F,CAAC;IAED,IAAI,sBAAsB;QACxB,OAAO,2BAA2B,CAAC;IACrC,CAAC;IAED,oBAAoB,CAAC,IAAU;;QAC7B,MAAM,WAAW,GAAG,CAAC,KAAK,CAAC,CAAC;QAC5B,iEAAiE;QACjE,WAAW,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QACpC,0FAA0F;QAC1F,MAAM,UAAU,GAAG;YACjB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,QAAQ,EAAE,IAAI,CAAC,SAAS;YACxB,cAAc,EAAE,IAAI,CAAC,eAAe;YACpC,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,WAAW,EAAE,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW;SAC1C,CAAC;QACF,MAAM,iBAAiB,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;QAC/E,IAAI,iBAAiB,EAAE;YACrB,iBAAiB,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;gBACnC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC3B,CAAC,CAAC,CAAC;SACJ;QACD,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAED,kBAAkB;QAChB,OAAO,eAAe,CAAC;IACzB,CAAC;CACF;AA1CD,kDA0CC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cparra/apexdocs",
-  "version": "2.22.0",
+  "version": "2.23.0-beta.0",
   "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
   "keywords": [
     "apex",

package/src/cli/generate.ts

@@ -85,6 +85,10 @@ result.then((config) => {
       describe: 'If using "openapi" as the target generator, this allows you to specify the name of the output file.',
       default: 'openapi',
     },
+    sortMembersAlphabetically: {
+      type: 'boolean',
+      describe: 'Whether to sort members alphabetically.',
+    },
     includeMetadata: {
       type: 'boolean',
       describe: "Whether to include the file's meta.xml information: Whether it is active and and the API version",
@@ -114,10 +118,12 @@ result.then((config) => {
     title: argv.title,
     namespace: argv.namespace,
     openApiFileName: argv.openApiFileName,
+    sortMembersAlphabetically: argv.sortMembersAlphabetically,
     includeMetadata: argv.includeMetadata,
     rootDir: argv.documentationRootDir,
     onAfterProcess: config?.config?.onAfterProcess,
     onBeforeFileWrite: config?.config?.onBeforeFileWrite,
+    frontMatterHeader: config?.config?.frontMatterHeader,
   });
 
   try {

package/src/model/markdown-generation-util/field-declaration-util.ts

@@ -8,15 +8,9 @@ export function declareField(
   grouped = false,
 ) {
   markdownFile.addBlankLine();
-  fields
-    .sort((propA, propB) => {
-      if (propA.name < propB.name) return -1;
-      if (propA.name > propB.name) return 1;
-      return 0;
-    })
-    .forEach((propertyModel) => {
-      addFieldSection(markdownFile, propertyModel, startingHeadingLevel, grouped);
-    });
+  fields.forEach((propertyModel) => {
+    addFieldSection(markdownFile, propertyModel, startingHeadingLevel, grouped);
+  });
 
   markdownFile.addHorizontalRule();
 }

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

@@ -91,16 +91,10 @@ export class MarkdownTypeFile extends MarkdownFile implements WalkerListener {
 
   private addInnerTypes(title: string, types: Type[], addSeparator = true) {
     this.addTitle(title, this.headingLevel + 1);
-    types
-      .sort((typeA, typeB) => {
-        if (typeA.name < typeB.name) return -1;
-        if (typeA.name > typeB.name) return 1;
-        return 0;
-      })
-      .forEach((currentType) => {
-        const innerFile = new MarkdownTypeFile(currentType, this.headingLevel + 2, undefined, true);
-        this.addText(innerFile._contents);
-      });
+    types.forEach((currentType) => {
+      const innerFile = new MarkdownTypeFile(currentType, this.headingLevel + 2, undefined, true);
+      this.addText(innerFile._contents);
+    });
     if (addSeparator) {
       this.addHorizontalRule();
     }

package/src/service/walkers/class-walker.ts

@@ -5,27 +5,26 @@ export class ClassWalker extends Walker {
   walk(listener: WalkerListener): void {
     listener.onTypeDeclaration(this.type);
     const classMirror = this.type as ClassMirror;
-
     if (classMirror.constructors.length) {
       listener.onConstructorDeclaration(this.type.name, classMirror.constructors);
     }
     if (classMirror.fields.length) {
-      listener.onFieldsDeclaration(classMirror.fields);
+      listener.onFieldsDeclaration(this.sortType(classMirror.fields));
     }
     if (classMirror.properties.length) {
-      listener.onPropertiesDeclaration(classMirror.properties);
+      listener.onPropertiesDeclaration(this.sortType(classMirror.properties));
     }
     if (classMirror.methods.length) {
-      listener.onMethodsDeclaration(classMirror.methods);
+      listener.onMethodsDeclaration(this.sortType(classMirror.methods));
     }
     if (classMirror.enums.length) {
-      listener.onInnerEnumsDeclaration(classMirror.enums);
+      listener.onInnerEnumsDeclaration(this.sortType(classMirror.enums));
     }
     if (classMirror.classes.length) {
-      listener.onInnerClassesDeclaration(classMirror.classes);
+      listener.onInnerClassesDeclaration(this.sortType(classMirror.classes));
     }
     if (classMirror.interfaces.length) {
-      listener.onInnerInterfacesDeclaration(classMirror.interfaces);
+      listener.onInnerInterfacesDeclaration(this.sortType(classMirror.interfaces));
     }
   }
 }

package/src/service/walkers/enum-walker.ts

@@ -1,5 +1,4 @@
 import { Walker, WalkerListener } from './walker';
-import { EnumMirror } from '@cparra/apex-reflection';
 
 export class EnumWalker extends Walker {
   walk(listener: WalkerListener): void {

package/src/service/walkers/interface-walker.ts

@@ -6,7 +6,7 @@ export class InterfaceWalker extends Walker {
     listener.onTypeDeclaration(this.type);
     const interfaceMirror = this.type as InterfaceMirror;
     if (interfaceMirror.methods.length) {
-      listener.onMethodsDeclaration(interfaceMirror.methods);
+      listener.onMethodsDeclaration(this.sortType(interfaceMirror.methods));
     }
   }
 }

package/src/service/walkers/walker.ts

@@ -8,7 +8,7 @@ import {
   PropertyMirror,
   Type,
 } from '@cparra/apex-reflection';
-import { Annotation } from '@cparra/apex-reflection/index';
+import { Settings } from '../../settings';
 
 export interface WalkerListener {
   onTypeDeclaration(typeMirror: Type): void;
@@ -32,4 +32,11 @@ export abstract class Walker {
   constructor(public type: Type) {}
 
   abstract walk(listener: WalkerListener): void;
+
+  protected sortType<T extends { name: string }>(types: T[]): T[] {
+    if (Settings.getInstance().sortMembersAlphabetically()) {
+      return types.sort((a, b) => a.name.localeCompare(b.name));
+    }
+    return types;
+  }
 }

package/src/settings.ts

@@ -13,6 +13,14 @@ export type OutputDir = {
   fileDir: string;
 };
 
+export type TargetType = {
+  name: string;
+  typeName: 'class' | 'interface' | 'enum';
+  accessModifier: string;
+  description?: string;
+  group?: string;
+};
+
 export interface SettingsConfig {
   sourceDirectory: string;
   recursive: boolean;
@@ -28,8 +36,10 @@ export interface SettingsConfig {
   openApiFileName: string;
   includeMetadata: boolean;
   rootDir?: string;
+  sortMembersAlphabetically?: boolean;
   onAfterProcess?: (files: TargetFile[]) => void;
   onBeforeFileWrite?: (file: TargetFile) => TargetFile;
+  frontMatterHeader?: (file: TargetType) => string[];
 }
 
 export class Settings {
@@ -107,6 +117,10 @@ export class Settings {
     return this.config.includeMetadata;
   }
 
+  public sortMembersAlphabetically(): boolean {
+    return this.config.sortMembersAlphabetically ?? false;
+  }
+
   public getRootDir(): string | undefined {
     return this.config.rootDir;
   }
@@ -123,4 +137,11 @@ export class Settings {
     }
     return file;
   }
+
+  public frontMatterHeader(file: TargetType): string[] {
+    if (this.config.frontMatterHeader) {
+      return this.config.frontMatterHeader(file);
+    }
+    return [];
+  }
 }

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

@@ -40,11 +40,11 @@ export default class ClassFileGeneratorHelper {
         // If the types the same groups then we simply link directly to that file
         return './';
       } else {
-        // If the types have different groups then we have to go up a directory
+        // If the types have different groups, then we have to go up a directory
         return `../${this.getSanitizedGroup(classModel)}/`;
       }
     } else {
-      // If nothing is being processed then we assume we are at the root and links should include the groups
+      // If nothing is being processed, then we assume we are at the root and links should include the groups
       return `./${this.getSanitizedGroup(classModel)}/`;
     }
   }

package/src/transpiler/markdown/jekyll/jekyll-docsProcessor.ts

@@ -3,6 +3,7 @@ import { Type } from '@cparra/apex-reflection';
 import { MarkdownHomeFile } from '../../../model/markdown-home-file';
 import { MarkdownTypeFile } from '../../../model/markdown-type-file';
 import { LinkingStrategy } from '../../processor-type-transpiler';
+import { Settings } from '../../../settings';
 
 export class JekyllDocsProcessor extends MarkdownTranspilerBase {
   homeFileName(): string {
@@ -10,17 +11,39 @@ export class JekyllDocsProcessor extends MarkdownTranspilerBase {
   }
 
   onBeforeProcess = (types: Type[]) => {
-    this._fileContainer.pushFile(new MarkdownHomeFile(this.homeFileName(), types, this.frontMatterHeader));
+    this._fileContainer.pushFile(new MarkdownHomeFile(this.homeFileName(), types, this.frontMatterForHomeFile));
   };
 
   onProcess(type: Type): void {
-    this._fileContainer.pushFile(new MarkdownTypeFile(type, 1, this.frontMatterHeader));
+    this._fileContainer.pushFile(new MarkdownTypeFile(type, 1, this.getFrontMatterHeader(type)));
   }
 
-  get frontMatterHeader(): string {
+  get frontMatterForHomeFile(): string {
     return '---\nlayout: default\n---';
   }
 
+  getFrontMatterHeader(type: Type): string {
+    const headerLines = ['---'];
+    // "layout: default" is a required front matter header for Jekyll
+    headerLines.push('layout: default');
+    // Add any additional front matter headers that might have been configured in the settings
+    const targetType = {
+      name: type.name,
+      typeName: type.type_name,
+      accessModifier: type.access_modifier,
+      group: type.group,
+      description: type.docComment?.description,
+    };
+    const configuredHeaders = Settings.getInstance().frontMatterHeader(targetType);
+    if (configuredHeaders) {
+      configuredHeaders.forEach((header) => {
+        headerLines.push(header);
+      });
+    }
+    headerLines.push('---');
+    return headerLines.join('\n');
+  }
+
   getLinkingStrategy(): LinkingStrategy {
     return 'path-relative';
   }

package/ROADMAP.md

@@ -1,16 +0,0 @@
-[ ] 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
-files, instead of just overriding
-
-[ ] New generatortype: To JsDocs from AuraEnabled
-
-[ ] More unit tests
-
-[ ] config.js support to allow for injections, home header, etc.
-
-[ ] Add configuration setting that allows someone to set the "namespace"
-
-[ ] Homepage support similar to what docsify does