@cparra/apexdocs 2.3.0 → 2.5.0

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

@@ -1,12 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const types_repository_1 = require("../../model/types-repository");
+const settings_1 = require("../../settings");
+const state_1 = require("../../service/state");
 class ClassFileGeneratorHelper {
     static getSanitizedGroup(classModel) {
         return this.getClassGroup(classModel).replace(/ /g, '-').replace('.', '');
     }
     static getFileLink(classModel) {
-        return `[${classModel.name}](/${this.getSanitizedGroup(classModel)}/${classModel.name}.md)`;
+        const directoryRoot = this.getDirectoryRoot(classModel);
+        return `[${classModel.name}](${directoryRoot}${classModel.name}.md)`;
     }
     static getFileLinkByTypeName(typeName) {
         const type = types_repository_1.TypesRepository.getInstance().getByName(typeName);
@@ -16,10 +19,32 @@ class ClassFileGeneratorHelper {
         }
         return this.getFileLink(type);
     }
+    static getDirectoryRoot(classModel) {
+        // root-relative links start from the root by using a leading '/'
+        if (settings_1.Settings.getInstance().typeTranspiler.getLinkingStrategy() === 'root-relative') {
+            return `/${this.getSanitizedGroup(classModel)}/`;
+        }
+        // path-relative links traverse the directory structure
+        const typeBeingProcessed = state_1.default.getInstance().getTypeBeingProcessed();
+        if (typeBeingProcessed) {
+            if (this.getClassGroup(typeBeingProcessed) === this.getClassGroup(classModel)) {
+                // 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
+                return `../${this.getSanitizedGroup(classModel)}/`;
+            }
+        }
+        else {
+            // If nothing is being processed then we assume we are at the root and links should include the groups
+            return `./${this.getSanitizedGroup(classModel)}/`;
+        }
+    }
     static getClassGroup(classModel) {
         var _a, _b;
-        const groupAnnotation = (_a = classModel.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((annotation) => annotation.name === 'group');
-        return (_b = groupAnnotation === null || groupAnnotation === void 0 ? void 0 : groupAnnotation.body) !== null && _b !== void 0 ? _b : 'Misc';
+        const groupAnnotation = (_a = classModel.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((annotation) => annotation.name.toLowerCase() === 'group');
+        return (_b = groupAnnotation === null || groupAnnotation === void 0 ? void 0 : groupAnnotation.body) !== null && _b !== void 0 ? _b : settings_1.Settings.getInstance().getDefaultGroupName();
     }
 }
 exports.default = ClassFileGeneratorHelper;

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,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"}
+{"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;AAExC,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,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;QACxD,OAAO,IAAI,UAAU,CAAC,IAAI,KAAK,aAAa,GAAG,UAAU,CAAC,IAAI,MAAM,CAAC;IACvE,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,gBAAgB,CAAC,UAAgB;QAC9C,iEAAiE;QACjE,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,kBAAkB,EAAE,KAAK,eAAe,EAAE;YAClF,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,SAAG,UAAU,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAC7D,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,OAAO,CAC1D,CAAC;QACF,aAAO,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,IAAI,mCAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,mBAAmB,EAAE,CAAC;IAC/E,CAAC;CACF;AAhDD,2CAgDC"}

package/lib/transpiler/markdown/docsify/docsify-docs-processor.d.ts

@@ -1,4 +1,6 @@
 import { MarkdownTranspilerBase } from '../markdown-transpiler-base';
+import { LinkingStrategy } from '../../processor-type-transpiler';
 export default class DocsifyDocsProcessor extends MarkdownTranspilerBase {
     homeFileName(): string;
+    getLinkingStrategy(): LinkingStrategy;
 }

package/lib/transpiler/markdown/docsify/docsify-docs-processor.js

@@ -5,6 +5,9 @@ class DocsifyDocsProcessor extends markdown_transpiler_base_1.MarkdownTranspiler
     homeFileName() {
         return 'README';
     }
+    getLinkingStrategy() {
+        return 'root-relative';
+    }
 }
 exports.default = DocsifyDocsProcessor;
 //# sourceMappingURL=docsify-docs-processor.js.map

package/lib/transpiler/markdown/docsify/docsify-docs-processor.js.map

@@ -1 +1 @@
-{"version":3,"file":"docsify-docs-processor.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/docsify/docsify-docs-processor.ts"],"names":[],"mappings":";;AAAA,0EAAqE;AAErE,MAAqB,oBAAqB,SAAQ,iDAAsB;IACtE,YAAY;QACV,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF;AAJD,uCAIC"}
+{"version":3,"file":"docsify-docs-processor.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/docsify/docsify-docs-processor.ts"],"names":[],"mappings":";;AAAA,0EAAqE;AAGrE,MAAqB,oBAAqB,SAAQ,iDAAsB;IACtE,YAAY;QACV,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,kBAAkB;QAChB,OAAO,eAAe,CAAC;IACzB,CAAC;CACF;AARD,uCAQC"}

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

@@ -1,8 +1,10 @@
 import { MarkdownTranspilerBase } from '../markdown-transpiler-base';
 import { Type } from '@cparra/apex-reflection';
+import { LinkingStrategy } from '../../processor-type-transpiler';
 export declare class JekyllDocsProcessor extends MarkdownTranspilerBase {
     homeFileName(): string;
     onBeforeProcess: (types: Type[]) => void;
     onProcess(type: Type): void;
     get frontMatterHeader(): string;
+    getLinkingStrategy(): LinkingStrategy;
 }

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

@@ -20,6 +20,9 @@ class JekyllDocsProcessor extends markdown_transpiler_base_1.MarkdownTranspilerB
     get frontMatterHeader() {
         return '---\nlayout: default\n---';
     }
+    getLinkingStrategy() {
+        return 'path-relative';
+    }
 }
 exports.JekyllDocsProcessor = JekyllDocsProcessor;
 //# sourceMappingURL=jekyll-docsProcessor.js.map

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;AAErE,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;IASJ,CAAC;IAfC,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;CACF;AAhBD,kDAgBC"}
+{"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"}

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

@@ -0,0 +1,6 @@
+import { MarkdownTranspilerBase } from '../markdown-transpiler-base';
+import { LinkingStrategy } from '../../processor-type-transpiler';
+export declare class PlainMarkdownDocsProcessor extends MarkdownTranspilerBase {
+    homeFileName(): string;
+    getLinkingStrategy(): LinkingStrategy;
+}

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

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlainMarkdownDocsProcessor = void 0;
+const markdown_transpiler_base_1 = require("../markdown-transpiler-base");
+class PlainMarkdownDocsProcessor extends markdown_transpiler_base_1.MarkdownTranspilerBase {
+    homeFileName() {
+        return 'index';
+    }
+    getLinkingStrategy() {
+        return 'path-relative';
+    }
+}
+exports.PlainMarkdownDocsProcessor = PlainMarkdownDocsProcessor;
+//# sourceMappingURL=plain-docsProcessor.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"plain-docsProcessor.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/plain-docsProcessor.ts"],"names":[],"mappings":";;;AAAA,0EAAqE;AAGrE,MAAa,0BAA2B,SAAQ,iDAAsB;IACpE,YAAY;QACV,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,kBAAkB;QAChB,OAAO,eAAe,CAAC;IACzB,CAAC;CACF;AARD,gEAQC"}

package/lib/transpiler/processor-type-transpiler.d.ts

@@ -1,8 +1,10 @@
 import { Type } from '@cparra/apex-reflection';
 import { FileContainer } from './file-container';
+export declare type LinkingStrategy = 'root-relative' | 'path-relative';
 export default abstract class ProcessorTypeTranspiler {
     onBeforeProcess: ((types: Type[]) => void) | undefined;
     abstract onProcess(type: Type): void;
     onAfterProcess: ((types: Type[]) => void) | undefined;
     abstract fileBuilder(): FileContainer;
+    abstract getLinkingStrategy(): LinkingStrategy;
 }

package/lib/transpiler/processor-type-transpiler.js.map

@@ -1 +1 @@
-{"version":3,"file":"processor-type-transpiler.js","sourceRoot":"","sources":["../../src/transpiler/processor-type-transpiler.ts"],"names":[],"mappings":";;AAGA,MAA8B,uBAAuB;CAQpD;AARD,0CAQC"}
+{"version":3,"file":"processor-type-transpiler.js","sourceRoot":"","sources":["../../src/transpiler/processor-type-transpiler.ts"],"names":[],"mappings":";;AAKA,MAA8B,uBAAuB;CAUpD;AAVD,0CAUC"}

package/lib/transpiler/transpiler.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const settings_1 = require("../settings");
+const state_1 = require("../service/state");
 class Transpiler {
     static generate(types, processor) {
         var _a, _b;
@@ -16,6 +17,7 @@ class Transpiler {
             return;
         }
         sortedTypes.forEach((currentType) => {
+            state_1.default.getInstance().setTypeBeingProcessed(currentType);
             processor.onProcess(currentType);
         });
         (_b = processor.onAfterProcess) === null || _b === void 0 ? void 0 : _b.call(processor, sortedTypes);

package/lib/transpiler/transpiler.js.map

@@ -1 +1 @@
-{"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"}
+{"version":3,"file":"transpiler.js","sourceRoot":"","sources":["../../src/transpiler/transpiler.ts"],"names":[],"mappings":";;AAEA,0CAAuC;AACvC,4CAAqC;AAErC,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,eAAK,CAAC,WAAW,EAAE,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC;YACvD,SAAS,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;QACH,MAAA,SAAS,CAAC,cAAc,+CAAxB,SAAS,EAAkB,WAAW,EAAE;IAC1C,CAAC;CACF;AApBD,6BAoBC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cparra/apexdocs",
-  "version": "2.3.0",
+  "version": "2.5.0",
   "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
   "keywords": [
     "apex",
@@ -24,7 +24,7 @@
     "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 --defaultGroupName API",
     "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",

package/src/application/Apexdocs.ts

@@ -27,7 +27,15 @@ export class Apexdocs {
     TypesRepository.getInstance().populate(filteredTypes);
     Logger.clear();
 
-    Logger.logSingle(`Parsed ${filteredTypes.length} files`, false, 'green', false);
+    Logger.logSingle(
+      `Filtered ${manifest.types.length - filteredTypes.length} file(s) based on scope: ${
+        Settings.getInstance().scope
+      }`,
+      false,
+      'green',
+      false,
+    );
+    Logger.logSingle(`Creating documentation for ${filteredTypes.length} file(s)`, false, 'green', false);
     const processor = Settings.getInstance().typeTranspiler;
     Transpiler.generate(filteredTypes, processor);
     const generatedFiles = processor.fileBuilder().files();

package/src/cli/generate.ts

@@ -35,14 +35,19 @@ const argv = yargs.options({
     type: 'string',
     alias: 'g',
     default: 'jekyll',
-    choices: ['jekyll', 'docsify'],
+    choices: ['jekyll', 'docsify', 'plain-markdown'],
     describe:
-      'Define the static file generator for which the documents will be created. Currently supports jekyll, and docsify.',
+      'Define the static file generator for which the documents will be created. Currently supports jekyll, docsify, and plain markdown.',
   },
   indexOnly: {
     type: 'boolean',
     default: false,
-    describe: 'Defines whether only the index file should be  generated.',
+    describe: 'Defines whether only the index file should be generated.',
+  },
+  defaultGroupName: {
+    type: 'string',
+    default: 'Miscellaneous',
+    describe: 'Defines the @group name to be used when a file does not specify it.',
   },
 }).argv;
 
@@ -53,6 +58,7 @@ Settings.build({
   outputDir: argv.targetDir,
   targetGenerator: argv.targetGenerator as GeneratorChoices,
   indexOnly: argv.indexOnly,
+  defaultGroupName: argv.defaultGroupName,
 });
 
 Apexdocs.generate();

package/src/model/markdown-file.ts

@@ -42,6 +42,7 @@ export class MarkdownFile extends File {
   }
 
   initializeTable(...headers: string[]) {
+    this.addBlankLine();
     this._contents += '|';
     headers.forEach((header) => {
       this._contents += header + '|';

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

@@ -58,7 +58,7 @@ function buildSignature(name: string, parameterAware: ParameterAware): string {
   }
   const signatureParameters = parameterAware.parameters.map((param) => `${param.type} ${param.name}`);
   signature += signatureParameters.join(', ');
-  return (signature += ')');
+  return `${signature})`;
 }
 
 function addParameters(
@@ -66,6 +66,11 @@ function addParameters(
   methodModel: MethodMirror | ConstructorMirror,
   startingHeadingLevel: number,
 ) {
+  if (!methodModel.docComment?.paramAnnotations.length) {
+    // If there are no parameters defined in the docs then we don't want to display this section
+    return;
+  }
+
   markdownFile.addTitle('Parameters', startingHeadingLevel + 3);
   markdownFile.initializeTable('Param', 'Description');
 

package/src/service/state.ts

@@ -0,0 +1,24 @@
+import { Type } from '@cparra/apex-reflection';
+
+export default class State {
+  private static instance: State;
+  private typeBeingProcessed?: Type;
+
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
+  private constructor() {}
+
+  public static getInstance(): State {
+    if (!State.instance) {
+      State.instance = new State();
+    }
+    return State.instance;
+  }
+
+  public setTypeBeingProcessed(typeToSet: Type): void {
+    this.typeBeingProcessed = typeToSet;
+  }
+
+  public getTypeBeingProcessed(): Type | undefined {
+    return this.typeBeingProcessed;
+  }
+}

package/src/settings.ts

@@ -1,8 +1,9 @@
 import ProcessorTypeTranspiler from './transpiler/processor-type-transpiler';
 import { JekyllDocsProcessor } from './transpiler/markdown/jekyll/jekyll-docsProcessor';
 import DocsifyDocsProcessor from './transpiler/markdown/docsify/docsify-docs-processor';
+import { PlainMarkdownDocsProcessor } from './transpiler/markdown/plain-markdown/plain-docsProcessor';
 
-export type GeneratorChoices = 'jekyll' | 'docsify';
+export type GeneratorChoices = 'jekyll' | 'docsify' | 'plain-markdown';
 
 export interface SettingsConfig {
   sourceDirectory: string;
@@ -11,6 +12,7 @@ export interface SettingsConfig {
   outputDir: string;
   targetGenerator: GeneratorChoices;
   indexOnly: boolean;
+  defaultGroupName: string;
 }
 
 export class Settings {
@@ -45,12 +47,21 @@ export class Settings {
     return this.config.outputDir;
   }
 
+  private static typeTranspilerCache?: ProcessorTypeTranspiler;
   get typeTranspiler(): ProcessorTypeTranspiler {
+    if (Settings.typeTranspilerCache) {
+      return Settings.typeTranspilerCache;
+    }
     switch (this.config.targetGenerator) {
       case 'jekyll':
-        return new JekyllDocsProcessor();
+        Settings.typeTranspilerCache = new JekyllDocsProcessor();
+        return Settings.typeTranspilerCache;
       case 'docsify':
-        return new DocsifyDocsProcessor();
+        Settings.typeTranspilerCache = new DocsifyDocsProcessor();
+        return Settings.typeTranspilerCache;
+      case 'plain-markdown':
+        Settings.typeTranspilerCache = new PlainMarkdownDocsProcessor();
+        return Settings.typeTranspilerCache;
       default:
         throw Error('Invalid target generator');
     }
@@ -59,4 +70,8 @@ export class Settings {
   get indexOnly(): boolean {
     return this.config.indexOnly;
   }
+
+  public getDefaultGroupName(): string {
+    return this.config.defaultGroupName;
+  }
 }

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

@@ -1,5 +1,7 @@
 import { Type } from '@cparra/apex-reflection';
 import { TypesRepository } from '../../model/types-repository';
+import { Settings } from '../../settings';
+import State from '../../service/state';
 
 export default class ClassFileGeneratorHelper {
   public static getSanitizedGroup(classModel: Type) {
@@ -7,7 +9,8 @@ export default class ClassFileGeneratorHelper {
   }
 
   public static getFileLink(classModel: Type) {
-    return `[${classModel.name}](/${this.getSanitizedGroup(classModel)}/${classModel.name}.md)`;
+    const directoryRoot = this.getDirectoryRoot(classModel);
+    return `[${classModel.name}](${directoryRoot}${classModel.name}.md)`;
   }
 
   public static getFileLinkByTypeName(typeName: string) {
@@ -20,8 +23,32 @@ export default class ClassFileGeneratorHelper {
     return this.getFileLink(type);
   }
 
+  private static getDirectoryRoot(classModel: Type) {
+    // root-relative links start from the root by using a leading '/'
+    if (Settings.getInstance().typeTranspiler.getLinkingStrategy() === 'root-relative') {
+      return `/${this.getSanitizedGroup(classModel)}/`;
+    }
+
+    // path-relative links traverse the directory structure
+    const typeBeingProcessed = State.getInstance().getTypeBeingProcessed();
+    if (typeBeingProcessed) {
+      if (this.getClassGroup(typeBeingProcessed) === this.getClassGroup(classModel)) {
+        // 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
+        return `../${this.getSanitizedGroup(classModel)}/`;
+      }
+    } else {
+      // If nothing is being processed then we assume we are at the root and links should include the groups
+      return `./${this.getSanitizedGroup(classModel)}/`;
+    }
+  }
+
   private static getClassGroup(classModel: Type): string {
-    const groupAnnotation = classModel.docComment?.annotations.find((annotation) => annotation.name === 'group');
-    return groupAnnotation?.body ?? 'Misc';
+    const groupAnnotation = classModel.docComment?.annotations.find(
+      (annotation) => annotation.name.toLowerCase() === 'group',
+    );
+    return groupAnnotation?.body ?? Settings.getInstance().getDefaultGroupName();
   }
 }

package/src/transpiler/markdown/docsify/docsify-docs-processor.ts

@@ -1,7 +1,12 @@
 import { MarkdownTranspilerBase } from '../markdown-transpiler-base';
+import { LinkingStrategy } from '../../processor-type-transpiler';
 
 export default class DocsifyDocsProcessor extends MarkdownTranspilerBase {
   homeFileName(): string {
     return 'README';
   }
+
+  getLinkingStrategy(): LinkingStrategy {
+    return 'root-relative';
+  }
 }

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

@@ -2,6 +2,7 @@ import { MarkdownTranspilerBase } from '../markdown-transpiler-base';
 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';
 
 export class JekyllDocsProcessor extends MarkdownTranspilerBase {
   homeFileName(): string {
@@ -19,4 +20,8 @@ export class JekyllDocsProcessor extends MarkdownTranspilerBase {
   get frontMatterHeader(): string {
     return '---\nlayout: default\n---';
   }
+
+  getLinkingStrategy(): LinkingStrategy {
+    return 'path-relative';
+  }
 }

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

@@ -0,0 +1,12 @@
+import { MarkdownTranspilerBase } from '../markdown-transpiler-base';
+import { LinkingStrategy } from '../../processor-type-transpiler';
+
+export class PlainMarkdownDocsProcessor extends MarkdownTranspilerBase {
+  homeFileName(): string {
+    return 'index';
+  }
+
+  getLinkingStrategy(): LinkingStrategy {
+    return 'path-relative';
+  }
+}

package/src/transpiler/processor-type-transpiler.ts

@@ -1,6 +1,8 @@
 import { Type } from '@cparra/apex-reflection';
 import { FileContainer } from './file-container';
 
+export type LinkingStrategy = 'root-relative' | 'path-relative';
+
 export default abstract class ProcessorTypeTranspiler {
   onBeforeProcess: ((types: Type[]) => void) | undefined;
 
@@ -9,4 +11,6 @@ export default abstract class ProcessorTypeTranspiler {
   onAfterProcess: ((types: Type[]) => void) | undefined;
 
   abstract fileBuilder(): FileContainer;
+
+  abstract getLinkingStrategy(): LinkingStrategy;
 }

package/src/transpiler/transpiler.ts

@@ -1,6 +1,7 @@
 import { Type } from '@cparra/apex-reflection';
 import ProcessorTypeTranspiler from './processor-type-transpiler';
 import { Settings } from '../settings';
+import State from '../service/state';
 
 export default class Transpiler {
   static generate(types: Type[], processor: ProcessorTypeTranspiler): void {
@@ -17,6 +18,7 @@ export default class Transpiler {
     }
 
     sortedTypes.forEach((currentType) => {
+      State.getInstance().setTypeBeingProcessed(currentType);
       processor.onProcess(currentType);
     });
     processor.onAfterProcess?.(sortedTypes);

package/docs/Misc/SampleClass.md

@@ -1,168 +0,0 @@
-# SampleClass
-
-`NAMESPACEACCESSIBLE`
-
-`APIVERSION: 54`
-
-`STATUS: ACTIVE`
-
-Something
-
-## Constructors
-### My Super Group
-##### `SampleClass()`
-
-`NAMESPACEACCESSIBLE`
-
-Constructs a SampleClass without any arguments. This relates to [SampleInterface](/Sample-Interfaces/SampleInterface.md)
-
-###### Throws
-|Exception|Description|
-|---|---|
-|`ExcName`|some exception|
-
-
-**CustomAnnotation** A Custom method annotation
-
-
-**See** [SampleInterface](/Sample-Interfaces/SampleInterface.md)
-
-###### Example
-```apex
-// Example
-SampleClass sampleInstance = new SampleClass();
-```
-
----
-### Other
-##### `SampleClass(String argument1, String argument2)`
-
-Constructs a SampleClass with an argument.
-
-###### Parameters
-|Param|Description|
-|---|---|
-|`argument1`|Argument1 definition|
-|`argument2`|Argument2 definition|
-
----
-## Fields
-### Common Constants
-
-* `ANOTHER_CONSTANT` → `String` 
-* `A_CONSTANT` → `String` [`NAMESPACEACCESSIBLE` ]  - This is a constant.
----
-### Other variables
-
-* `someVariable` → `String` 
----
-## Properties
-
-### `AnotherProp` → `Decimal`
-
-`AURAENABLED` 
-
-This is a Decimal property.
-
-### `MyProp` → `String`
-
-`AURAENABLED` 
-`DEPRECATED` 
-
-This is a String property.
-
----
-## Methods
-### `static sampleMethod(String argument1, String argument2)`
-
-`NAMESPACEACCESSIBLE`
-
-Executes commands based on the passed in argument.
-
-#### Parameters
-|Param|Description|
-|---|---|
-|`argument1`|Argument1 to debug|
-|`argument2`|Argument2 to debug|
-
-#### Return
-
-**Type**
-
-String
-
-**Description**
-
-Empty string
-
-#### Example
-```apex
-String result = SampleClass.testMethod();
-System.debug(result);
-```
-
-### `static anotherSampleMethod(String arg1)`
-
-Something here
-
-#### Parameters
-|Param|Description|
-|---|---|
-
-
-**Arg1** The arg1 description
-
-### `static call()`
-
-Calls the method. This methods allows you to call it.
-
----
-## Enums
-### InnerEnum
-
-`NAMESPACEACCESSIBLE`
-
-This is a namespace accessible enum
-
-
----
-## Classes
-### AnotherInnerClass
-
-Inner class belonging to SampleClass.
-
-#### Properties
-
-##### `InnerProp` → `String`
-
-
-Description of the inner property.
-
----
-#### Methods
-##### `innerMethod()`
-
-Executes from the inner class.
-
----
-
-### InnerClass
-
-Inner class belonging to SampleClass.
-
-#### Properties
-
-##### `InnerProp` → `String`
-
-
-Description of the inner property.
-
----
-#### Methods
-##### `innerMethod()`
-
-Executes from the inner class.
-
----
-
----