@cparra/apexdocs 1.13.4 → 1.13.8

package/lib/service/walkers/walker.d.ts

@@ -0,0 +1,16 @@
+import { ClassMirror, ConstructorMirror, EnumMirror, FieldMirror, InterfaceMirror, MethodMirror, PropertyMirror, Type } from '@cparra/apex-reflection';
+export interface WalkerListener {
+    onTypeDeclaration(typeMirror: Type): void;
+    onConstructorDeclaration(className: string, constructors: ConstructorMirror[]): void;
+    onFieldsDeclaration(fields: FieldMirror[]): void;
+    onPropertiesDeclaration(properties: PropertyMirror[]): void;
+    onMethodsDeclaration(methods: MethodMirror[]): void;
+    onInnerEnumsDeclaration(enums: EnumMirror[]): void;
+    onInnerClassesDeclaration(classes: ClassMirror[]): void;
+    onInnerInterfacesDeclaration(interfaces: InterfaceMirror[]): void;
+}
+export declare abstract class Walker {
+    type: Type;
+    constructor(type: Type);
+    abstract walk(listener: WalkerListener): void;
+}

package/lib/service/walkers/walker.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Walker {
+    constructor(type) {
+        this.type = type;
+    }
+}
+exports.Walker = Walker;
+//# sourceMappingURL=walker.js.map

package/lib/service/walkers/walker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"walker.js","sourceRoot":"","sources":["../../../src/service/walkers/walker.ts"],"names":[],"mappings":";;AA8BA,MAAsB,MAAM;IAC1B,YAAmB,IAAU;QAAV,SAAI,GAAJ,IAAI,CAAM;IAAG,CAAC;CAGlC;AAJD,wBAIC"}

package/lib/settings.js.map

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

package/lib/transpiler/file-container.d.ts

@@ -0,0 +1,6 @@
+import { File } from '../model/file';
+export declare class FileContainer {
+    _files: File[];
+    files(): File[];
+    pushFile(file: File): void;
+}

package/lib/transpiler/file-container.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class FileContainer {
+    constructor() {
+        this._files = [];
+    }
+    files() {
+        return this._files;
+    }
+    pushFile(file) {
+        this._files.push(file);
+    }
+}
+exports.FileContainer = FileContainer;
+//# sourceMappingURL=file-container.js.map

package/lib/transpiler/file-container.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-container.js","sourceRoot":"","sources":["../../src/transpiler/file-container.ts"],"names":[],"mappings":";;AAEA,MAAa,aAAa;IAA1B;QACE,WAAM,GAAW,EAAE,CAAC;IAStB,CAAC;IAPC,KAAK;QACH,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,QAAQ,CAAC,IAAU;QACjB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;CACF;AAVD,sCAUC"}

package/lib/transpiler/markdown/class-file-generatorHelper.d.ts

@@ -0,0 +1,6 @@
+import { Type } from '@cparra/apex-reflection';
+export default class ClassFileGeneratorHelper {
+    static getSanitizedGroup(classModel: Type): string;
+    static getFileLink(classModel: Type): string;
+    private static getClassGroup;
+}

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

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class ClassFileGeneratorHelper {
+    static getSanitizedGroup(classModel) {
+        return this.getClassGroup(classModel).replace(/ /g, '-').replace('.', '');
+    }
+    static getFileLink(classModel) {
+        return `[${classModel.name}](/${this.getSanitizedGroup(classModel)}/${classModel.name}.md)`;
+    }
+    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';
+    }
+}
+exports.default = ClassFileGeneratorHelper;
+//# sourceMappingURL=class-file-generatorHelper.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"class-file-generatorHelper.js","sourceRoot":"","sources":["../../../src/transpiler/markdown/class-file-generatorHelper.ts"],"names":[],"mappings":";;AAEA,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;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;AAbD,2CAaC"}

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

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

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

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const markdown_transpiler_base_1 = require("../markdown-transpiler-base");
+class DocsifyDocsProcessor extends markdown_transpiler_base_1.MarkdownTranspilerBase {
+    homeFileName() {
+        return 'README';
+    }
+}
+exports.default = DocsifyDocsProcessor;
+//# sourceMappingURL=docsify-docs-processor.js.map

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

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

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

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

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

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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");
+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));
+        };
+    }
+    homeFileName() {
+        return 'index';
+    }
+    onProcess(type) {
+        this._fileContainer.pushFile(new markdown_type_file_1.MarkdownTypeFile(type, 1, this.frontMatterHeader));
+    }
+    get frontMatterHeader() {
+        return '---\nlayout: default\n---';
+    }
+}
+exports.JekyllDocsProcessor = JekyllDocsProcessor;
+//# sourceMappingURL=jekyll-docsProcessor.js.map

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

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

package/lib/transpiler/markdown/markdown-transpiler-base.d.ts

@@ -0,0 +1,11 @@
+import ProcessorTypeTranspiler from '../processor-type-transpiler';
+import { Type } from '@cparra/apex-reflection';
+import { FileContainer } from '../file-container';
+export declare abstract class MarkdownTranspilerBase extends ProcessorTypeTranspiler {
+    protected readonly _fileContainer: FileContainer;
+    constructor();
+    abstract homeFileName(): string;
+    fileBuilder(): FileContainer;
+    onBeforeProcess: (types: Type[]) => void;
+    onProcess(type: Type): void;
+}

package/lib/transpiler/markdown/markdown-transpiler-base.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const processor_type_transpiler_1 = require("../processor-type-transpiler");
+const file_container_1 = require("../file-container");
+const markdown_home_file_1 = require("../../model/markdown-home-file");
+const markdown_type_file_1 = require("../../model/markdown-type-file");
+class MarkdownTranspilerBase extends processor_type_transpiler_1.default {
+    constructor() {
+        super();
+        this.onBeforeProcess = (types) => {
+            this._fileContainer.pushFile(new markdown_home_file_1.MarkdownHomeFile(this.homeFileName(), types));
+        };
+        this._fileContainer = new file_container_1.FileContainer();
+    }
+    fileBuilder() {
+        return this._fileContainer;
+    }
+    onProcess(type) {
+        this._fileContainer.pushFile(new markdown_type_file_1.MarkdownTypeFile(type));
+    }
+}
+exports.MarkdownTranspilerBase = MarkdownTranspilerBase;
+//# sourceMappingURL=markdown-transpiler-base.js.map

package/lib/transpiler/markdown/markdown-transpiler-base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown-transpiler-base.js","sourceRoot":"","sources":["../../../src/transpiler/markdown/markdown-transpiler-base.ts"],"names":[],"mappings":";;AAAA,4EAAmE;AAEnE,sDAAkD;AAClD,uEAAkE;AAClE,uEAAkE;AAElE,MAAsB,sBAAuB,SAAQ,mCAAuB;IAG1E;QACE,KAAK,EAAE,CAAC;QAUV,oBAAe,GAAG,CAAC,KAAa,EAAE,EAAE;YAClC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;QACjF,CAAC,CAAC;QAXA,IAAI,CAAC,cAAc,GAAG,IAAI,8BAAa,EAAE,CAAC;IAC5C,CAAC;IAID,WAAW;QACT,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAMD,SAAS,CAAC,IAAU;QAClB,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3D,CAAC;CACF;AArBD,wDAqBC"}

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

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

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

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class ProcessorTypeTranspiler {
+}
+exports.default = ProcessorTypeTranspiler;
+//# sourceMappingURL=processor-type-transpiler.js.map

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

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

package/lib/transpiler/transpiler.d.ts

@@ -0,0 +1,5 @@
+import { Type } from '@cparra/apex-reflection';
+import ProcessorTypeTranspiler from './processor-type-transpiler';
+export default class Transpiler {
+    static generate(types: Type[], processor: ProcessorTypeTranspiler): void;
+}

package/lib/transpiler/transpiler.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Transpiler {
+    static generate(types, processor) {
+        var _a, _b;
+        const sortedTypes = types.sort((apexTypeA, apexTypeB) => {
+            if (apexTypeA.name < apexTypeB.name)
+                return -1;
+            if (apexTypeA.name > apexTypeB.name)
+                return 1;
+            return 0;
+        });
+        (_a = processor.onBeforeProcess) === null || _a === void 0 ? void 0 : _a.call(processor, sortedTypes);
+        sortedTypes.forEach((currentType) => {
+            processor.onProcess(currentType);
+        });
+        (_b = processor.onAfterProcess) === null || _b === void 0 ? void 0 : _b.call(processor, sortedTypes);
+    }
+}
+exports.default = Transpiler;
+//# sourceMappingURL=transpiler.js.map

package/lib/transpiler/transpiler.js.map

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

package/lib/util/logger.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Logs messages to the console.
+ */
+export declare class Logger {
+    /**
+     * Logs a message with optional arguments.
+     * @param message The message to log.
+     * @param args Optional arguments.
+     */
+    static log(message: string, ...args: string[]): void;
+    /**
+     * Logs an error message with optional arguments.
+     * @param message The error message to log.
+     * @param args Optional arguments.
+     */
+    static error(message: string, ...args: string[]): void;
+    private static logSingle;
+}

package/lib/util/logger.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const chalk = require("chalk");
+/**
+ * Logs messages to the console.
+ */
+class Logger {
+    /**
+     * Logs a message with optional arguments.
+     * @param message The message to log.
+     * @param args Optional arguments.
+     */
+    static log(message, ...args) {
+        this.logSingle(message);
+        args.forEach((arg) => {
+            this.logSingle(arg);
+        });
+    }
+    /**
+     * Logs an error message with optional arguments.
+     * @param message The error message to log.
+     * @param args Optional arguments.
+     */
+    static error(message, ...args) {
+        this.log(`${chalk.red(message)}`, ...args);
+    }
+    static logSingle(message) {
+        process.stdout.write(`${chalk.green(new Date().toLocaleString() + ': ')}${message}\n`);
+    }
+}
+exports.Logger = Logger;
+//# sourceMappingURL=logger.js.map

package/lib/util/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/util/logger.ts"],"names":[],"mappings":";;AAAA,+BAA+B;AAE/B;;GAEG;AACH,MAAa,MAAM;IACjB;;;;OAIG;IACI,MAAM,CAAC,GAAG,CAAC,OAAe,EAAE,GAAG,IAAc;QAClD,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACnB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,OAAe,EAAE,GAAG,IAAc;QACpD,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;IAC7C,CAAC;IAEO,MAAM,CAAC,SAAS,CAAC,OAAe;QACtC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC,cAAc,EAAE,GAAG,IAAI,CAAC,GAAG,OAAO,IAAI,CAAC,CAAC;IACzF,CAAC;CACF;AAzBD,wBAyBC"}

package/package.json

@@ -1,68 +1,70 @@
-{
-  "name": "@cparra/apexdocs",
-  "version": "1.13.4",
-  "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
-  "keywords": [
-    "apex",
-    "salesforce",
-    "documentation",
-    "cli",
-    "apex-docs",
-    "docs"
-  ],
-  "main": "lib/index.js",
-  "bin": {
-    "apexdocs-generate": "lib/cli/generate.js"
-  },
-  "types": "lib/index.d.ts",
-  "scripts": {
-    "test": "jest --coverage",
-    "build": "tsc --declaration",
-    "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
-    "lint": "tslint -p tsconfig.json",
-    "prepare": "npm run build",
-    "version": "npm run format && git add -A src",
-    "postversion": "git push && git push --tags"
-  },
-  "author": "Cesar Parra",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/cesarParra/apexdocs"
-  },
-  "devDependencies": {
-    "@types/html-entities": "^1.3.4",
-    "@types/jest": "^25.1.3",
-    "@types/node": "^13.7.4",
-    "@types/shelljs": "^0.8.6",
-    "@types/yargs": "^15.0.3",
-    "husky": "^4.2.3",
-    "jest": "^27.0.4",
-    "prettier": "^1.19.1",
-    "ts-jest": "^27.0.3",
-    "tslint": "^6.0.0",
-    "tslint-config-prettier": "^1.18.0",
-    "typescript": "^3.8.2"
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "npm run format"
-    }
-  },
-  "jest": {
-    "transform": {
-      ".(ts|tsx)": "<rootDir>/node_modules/ts-jest/preprocessor.js"
-    },
-    "testResultsProcessor": "<rootDir>/node_modules/ts-jest/coverageprocessor.js",
-    "testRegex": "(/__tests__/.*|\\.(test|spec))\\.(ts|tsx|js)$",
-    "moduleFileExtensions": [
-      "ts",
-      "tsx",
-      "js"
-    ]
-  },
-  "dependencies": {
-    "yargs": "^16.0.3",
-    "html-entities": "^2.3.2"
-  }
-}
+{
+  "name": "@cparra/apexdocs",
+  "version": "1.13.8",
+  "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
+  "keywords": [
+    "apex",
+    "salesforce",
+    "documentation",
+    "cli",
+    "apex-docs",
+    "docs"
+  ],
+  "main": "lib/index.js",
+  "bin": {
+    "apexdocs-generate": "lib/cli/generate.js"
+  },
+  "types": "lib/index.d.ts",
+  "scripts": {
+    "test": "jest --coverage",
+    "build": "tsc --declaration",
+    "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
+    "lint": "tslint -p tsconfig.json",
+    "prepare": "npm run build",
+    "version": "npm run format && git add -A src",
+    "postversion": "git push && git push --tags",
+    "generage:sample": "node lib/cli/generate.js -s examples -t docs"
+  },
+  "author": "Cesar Parra",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/cesarParra/apexdocs"
+  },
+  "devDependencies": {
+    "@types/html-entities": "^1.3.4",
+    "@types/jest": "^25.1.3",
+    "@types/node": "^13.7.4",
+    "@types/shelljs": "^0.8.6",
+    "@types/yargs": "^15.0.3",
+    "husky": "^4.2.3",
+    "jest": "^27.0.4",
+    "prettier": "^1.19.1",
+    "ts-jest": "^27.0.3",
+    "tslint": "^6.0.0",
+    "tslint-config-prettier": "^1.18.0",
+    "typescript": "^3.8.2"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "npm run format"
+    }
+  },
+  "jest": {
+    "transform": {
+      ".(ts|tsx)": "<rootDir>/node_modules/ts-jest/preprocessor.js"
+    },
+    "testResultsProcessor": "<rootDir>/node_modules/ts-jest/coverageprocessor.js",
+    "testRegex": "(/__tests__/.*|\\.(test|spec))\\.(ts|tsx|js)$",
+    "moduleFileExtensions": [
+      "ts",
+      "tsx",
+      "js"
+    ]
+  },
+  "dependencies": {
+    "html-entities": "^2.3.2",
+    "sanitize-filename-ts": "1.0.2",
+    "yargs": "^16.0.3"
+  }
+}

package/src/AsJsDocsProcessor.ts

@@ -3,7 +3,7 @@ import * as path from 'path';
 
 import DocsProcessor from './DocsProcessor';
 import JsHelper from './JsHelper';
-import ClassModel from './model/ClassModel';
+import ClassModel from './Model/ClassModel';
 
 export default class AsJsDocsProcessor extends DocsProcessor {
   process(classModel: ClassModel, outputDir: string) {

package/src/ClassFileGeneratorHelper.test.ts

@@ -1,5 +1,5 @@
 import ClassFileGeneratorHelper from './ClassFileGeneratorHelper';
-import ClassModel from './model/ClassModel';
+import ClassModel from './Model/ClassModel';
 import Settings from './Settings';
 
 test('that getSanitizedGroup returns the same string when there is nothing to sanitize', () => {

package/src/ClassFileGeneratorHelper.ts

@@ -1,6 +1,7 @@
-import ClassModel from './model/ClassModel';
+import ClassModel from './Model/ClassModel';
 import Settings from './Settings';
 import Configuration from './Configuration';
+import DocsProcessor from './DocsProcessor';
 
 export default class ClassFileGeneratorHelper {
   public static getSanitizedGroup(classModel: ClassModel) {
@@ -10,8 +11,16 @@ export default class ClassFileGeneratorHelper {
       .replace('.', '');
   }
 
-  public static getFileLink(classModel: ClassModel) {
-    const root = Configuration.getConfig()?.root ? Configuration.getConfig()?.root : '';
+  public static getFileLink(classModel: ClassModel, forRelatedReference: boolean = false) {
+    let defaultRoot = '';
+    if (forRelatedReference && Settings.getInstance().getShouldGroup()) {
+      defaultRoot =
+        Settings.getInstance()
+          .getDocsProcessor()
+          ?.defaultRoot() ?? '';
+    }
+
+    const root = Configuration.getConfig()?.root ? Configuration.getConfig()?.root : defaultRoot;
     let fileLink;
     if (Settings.getInstance().getShouldGroup()) {
       fileLink = `[${classModel.getClassName()}](${root}/${this.getSanitizedGroup(

package/src/{command → Command}/Generate.ts

@@ -2,8 +2,8 @@ import * as fs from 'fs';
 import * as path from 'path';
 
 import Settings from '../Settings';
-import ClassModel from '../model/ClassModel';
-import FileParser from '../parser/FileParser';
+import ClassModel from '../Model/ClassModel';
+import FileParser from '../Parser/FileParser';
 
 import DocsifyDocsProcessor from '../DocsifyDocsProcessor';
 import JekyllDocsProcessor from '../JekyllDocsProcessor';

package/src/{command → Command}/__test__/Generte.test.ts

@@ -1,9 +1,9 @@
 import * as fs from 'fs';
 import { generate } from '../Generate';
-import FileParser from '../../parser/FileParser';
+import FileParser from '../../Parser/FileParser';
 
 jest.mock('fs');
-jest.mock('../../parser/FileParser');
+jest.mock('../../Parser/FileParser');
 
 beforeEach(() => {
   (FileParser as jest.Mock).mockClear();

package/src/DocsProcessor.ts

@@ -1,9 +1,15 @@
-import ClassModel from './model/ClassModel';
+import ClassModel from './Model/ClassModel';
 
 export default abstract class DocsProcessor {
   // tslint:disable-next-line:no-empty
   public onBeforeProcess(classes: ClassModel[], outputDir: string) {}
+
   abstract process(cModel: ClassModel, outputDir: string): void;
+
   // tslint:disable-next-line:no-empty
   public onAfterProcess(classes: ClassModel[], outputDir: string) {}
+
+  public defaultRoot(): string {
+    return '';
+  }
 }

package/src/DocsifyDocsProcessor.ts

@@ -1,7 +1,7 @@
-import MarkdownDocsProcessor from './MarkdownDocsProcessor';
-
-export default class DocsifyDocsProcessor extends MarkdownDocsProcessor {
-  getHomeFileName(): string {
-    return 'README.md';
-  }
-}
+import MarkdownDocsProcessor from './MarkdownDocsProcessor';
+
+export default class DocsifyDocsProcessor extends MarkdownDocsProcessor {
+  getHomeFileName(): string {
+    return 'README.md';
+  }
+}

package/src/FileManager.ts

@@ -1,5 +1,5 @@
 import Settings from './Settings';
-import ClassModel from './model/ClassModel';
+import ClassModel from './Model/ClassModel';
 
 export default class FileManager {
   classModels: ClassModel[];

package/src/JekyllDocsProcessor.ts

@@ -14,6 +14,10 @@ export default class JekyllDocsProcessor extends MarkdownDocsProcessor {
     this.addFrontMatterHeader(generator);
   }
 
+  defaultRoot(): string {
+    return '..';
+  }
+
   private addFrontMatterHeader(generator: MarkdownHelper) {
     generator.addText('---');
     generator.addText('layout: default');

package/src/MarkdownDocsProcessor.ts

@@ -3,10 +3,10 @@ import * as path from 'path';
 
 import DocsProcessor from './DocsProcessor';
 import MarkdownHelper from './MarkdownHelper';
-import ClassModel from './model/ClassModel';
+import ClassModel from './Model/ClassModel';
 import Settings from './Settings';
 import Configuration from './Configuration';
-import MethodModel from './model/MethodModel';
+import MethodModel from './Model/MethodModel';
 import ClassFileGeneratorHelper from './ClassFileGeneratorHelper';
 
 export default abstract class MarkdownDocsProcessor extends DocsProcessor {
@@ -142,7 +142,7 @@ export default abstract class MarkdownDocsProcessor extends DocsProcessor {
 
         generator.addBlankLine();
         if (relatedClass) {
-          generator.addText(ClassFileGeneratorHelper.getFileLink(relatedClass));
+          generator.addText(ClassFileGeneratorHelper.getFileLink(relatedClass, true));
         } else {
           generator.addText(relatedClassName);
         }
@@ -367,9 +367,10 @@ export default abstract class MarkdownDocsProcessor extends DocsProcessor {
 
   private addParameters(generator: MarkdownHelper, level: number, methodModel: MethodModel) {
     generator.addTitle('Parameters', level + 3);
+    generator.addBlankLine();
     // Building a table to display the parameters
-    generator.addText('|Param|Description|');
-    generator.addText('|-----|-----------|');
+    generator.addText('| Param | Description |');
+    generator.addText('| ----- | ----------- |');
 
     methodModel.getParams().forEach(param => {
       const paramName = param.substr(0, param.indexOf(' '));
@@ -396,9 +397,10 @@ export default abstract class MarkdownDocsProcessor extends DocsProcessor {
 
   private addThrowsBlock(generator: MarkdownHelper, level: number, methodModel: MethodModel) {
     generator.addTitle('Throws', level + 3);
+    generator.addBlankLine();
     // Building a table to display the exceptions
-    generator.addText('|Exception|Description|');
-    generator.addText('|---------|-----------|');
+    generator.addText('| Exception | Description |');
+    generator.addText('| --------- | ----------- |');
 
     methodModel.getThrownExceptions().forEach(param => {
       const exceptionName = param.substr(0, param.indexOf(' '));