@terafina/tffa-sfdx-plugin 0.1.1 → 1.0.2

package/lib/apexdoc/common/settings.js

@@ -0,0 +1,124 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Feature = void 0;
+const tslib_1 = require("tslib");
+/**
+ * Copyright (c) NCR Terafina
+ **/
+const apex_docs_error_1 = tslib_1.__importDefault(require("./apex-docs-error"));
+const engine_config_1 = tslib_1.__importDefault(require("./models/engine-config"));
+const validator_engine_1 = tslib_1.__importDefault(require("./validator-engine"));
+const line_reader_1 = tslib_1.__importDefault(require("./line-reader"));
+const fs_1 = require("fs");
+const path_1 = require("path");
+var Feature;
+(function (Feature) {
+    Feature[Feature["ENGINE"] = 0] = "ENGINE";
+    Feature[Feature["DOC_BLOCK"] = 1] = "DOC_BLOCK";
+})(Feature = exports.Feature || (exports.Feature = {}));
+class Settings {
+    /**
+     * Note that casting user provided configs as ApexDox configs
+     * can potentially result in run-time errors. The onus is on
+     * the user to ensure the correct shape of their config files,
+     * however, the app should fail loudly and gracefully if the
+     * user provides an invalid config.
+     */
+    static getRcFile() {
+        const rcJsonPath = path_1.resolve(this.projectRoot, '.apexdoxrc');
+        let fileName = '';
+        try {
+            // .apexdoxrc (json)
+            if (fs_1.existsSync(rcJsonPath)) {
+                fileName = '.apexdoxrc';
+                const rcString = new line_reader_1.default(rcJsonPath).toString();
+                return JSON.parse(rcString);
+            }
+        }
+        catch (e) {
+            throw new apex_docs_error_1.default(apex_docs_error_1.default.CONFIG_PARSE_ERROR(fileName));
+        }
+    }
+    /**
+     * Get user's ApexDox config and set defaults where needed.
+     * Order of preference for config files is listed below. If more than one
+     * config file is present, this is the order that will be honored by ApexDox.
+     *
+     *  3. .apexdoxrc
+     *
+     */
+    static getConfig(type) {
+        const rcConfig = this.getRcFile();
+        // getting engine config
+        if (type === Feature.ENGINE) {
+            let config;
+            if (rcConfig) {
+                config = Object.assign(Object.assign({}, new engine_config_1.default()), (rcConfig.engine || {}));
+            }
+            // pass result of either to directory defaulter and validate
+            return new validator_engine_1.default(this.setEngineDirectoryDefaults(config)).validate();
+        }
+        throw new apex_docs_error_1.default('Feature type not supported!');
+    }
+    /**
+     * Source and Target Dir default settings are dynamic and determined at runtime. If user
+     * omits these settings or provides invalid values, overwrite with default settings.
+     * @param config The `IEngineConfig` instance fetched from the user's settings.json or .apexdoxrc file.
+     */
+    static setEngineDirectoryDefaults(config) {
+        const defaultSource = [{ path: this.getDefaultDir(this.projectRoot) }];
+        const defaultTarget = path_1.resolve(this.projectRoot, 'apex-documentation');
+        if (!config.source ||
+            (Array.isArray(config.source) && !config.source.length) ||
+            (config.source.length === 1 && !config.source[0].path)) {
+            config.source = defaultSource;
+        }
+        if (!config.targetDirectory) {
+            config.targetDirectory = defaultTarget;
+        }
+        return config;
+    }
+    /**
+     * Get the default source directory based on the type of project.
+     *
+     * @param projectRoot The workspace's root folder.
+     */
+    static getDefaultDir(projectRoot) {
+        return !this.isDX(projectRoot)
+            ? path_1.resolve(projectRoot, 'src', 'classes')
+            : path_1.resolve(projectRoot, 'force-app', 'main', 'default', 'classes');
+    }
+    /**
+     * Determine with reasonable certainty whether this is a DX project or not.
+     * This will help us determine what the default source directory should be.
+     *
+     * @param projectRoot The workspace's root folder.
+     */
+    static isDX(projectRoot) {
+        if (fs_1.existsSync(path_1.resolve(projectRoot, 'force-app')) && !fs_1.existsSync(path_1.resolve(projectRoot, 'src'))) {
+            return true;
+        }
+        return false;
+    }
+}
+// this should be a safe cast. If running this tool, workspace folders should always exist.
+//   private static projectRoot = (<WorkspaceFolder[]>workspace.workspaceFolders)[0].uri.fsPath;
+Settings.projectRoot = '.';
+// constants
+Settings.SCOPES = ['global', 'public', 'private', 'protected', 'webservice', 'testmethod'];
+Settings.ORDER_ALPHA = 'alpha';
+Settings.ORDER_LOGICAL = 'logical';
+Settings.CLASS = 'class';
+Settings.ENUM = 'enum';
+Settings.INTERFACE = 'interface';
+// use special token for marking the end of a doc block
+// comment. Now that we're supporting multi-line for all
+// tags and using a common comment parser, the parser
+// must know when a block ends in order to prevent weird
+// behavior when lesser scopes than available are indicated
+// e.g. private;public when there are protected methods
+Settings.DOC_BLOCK_BREAK = '@@BREAK@@';
+Settings.COMMENT_CLOSE = '*/';
+Settings.COMMENT_OPEN = '/**';
+exports.default = Settings;
+//# sourceMappingURL=settings.js.map

package/lib/apexdoc/common/settings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"settings.js","sourceRoot":"","sources":["../../../src/apexdoc/common/settings.ts"],"names":[],"mappings":";;;;AAAA;;IAEI;AACJ,gFAA6C;AAC7C,mFAAkD;AAClD,kFAAiD;AACjD,wEAAuC;AACvC,2BAAgC;AAGhC,+BAA+B;AAE/B,IAAY,OAGX;AAHD,WAAY,OAAO;IACjB,yCAAM,CAAA;IACN,+CAAS,CAAA;AACX,CAAC,EAHW,OAAO,GAAP,eAAO,KAAP,eAAO,QAGlB;AAED,MAAM,QAAQ;IAyBZ;;;;;;OAMG;IACK,MAAM,CAAC,SAAS;QACtB,MAAM,UAAU,GAAG,cAAO,CAAC,IAAI,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;QAE3D,IAAI,QAAQ,GAAG,EAAE,CAAC;QAElB,IAAI;YACF,oBAAoB;YACpB,IAAI,eAAU,CAAC,UAAU,CAAC,EAAE;gBAC1B,QAAQ,GAAG,YAAY,CAAC;gBACxB,MAAM,QAAQ,GAAG,IAAI,qBAAU,CAAC,UAAU,CAAC,CAAC,QAAQ,EAAE,CAAC;gBACvD,OAAmB,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;aACzC;SACF;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,yBAAY,CAAC,yBAAY,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC,CAAC;SACnE;IACH,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,SAAS,CAA4C,IAAa;QAC9E,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;QAElC,wBAAwB;QACxB,IAAI,IAAI,KAAK,OAAO,CAAC,MAAM,EAAE;YAC3B,IAAI,MAAqB,CAAC;YAC1B,IAAI,QAAQ,EAAE;gBACZ,MAAM,mCACD,IAAI,uBAAY,EAAE,GAClB,CAAC,QAAQ,CAAC,MAAM,IAAI,EAAE,CAAC,CAC3B,CAAC;aACH;YACD,4DAA4D;YAC5D,OAAU,IAAI,0BAAe,CAAC,IAAI,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;SACnF;QAED,MAAM,IAAI,yBAAY,CAAC,6BAA6B,CAAC,CAAC;IACxD,CAAC;IAED;;;;OAIG;IACK,MAAM,CAAC,0BAA0B,CAAC,MAAqB;QAC7D,MAAM,aAAa,GAAG,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACvE,MAAM,aAAa,GAAG,cAAO,CAAC,IAAI,CAAC,WAAW,EAAE,oBAAoB,CAAC,CAAC;QAEtE,IACE,CAAC,MAAM,CAAC,MAAM;YACd,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;YACvD,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EACtD;YACA,MAAM,CAAC,MAAM,GAAG,aAAa,CAAC;SAC/B;QAED,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE;YAC3B,MAAM,CAAC,eAAe,GAAG,aAAa,CAAC;SACxC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACK,MAAM,CAAC,aAAa,CAAC,WAAmB;QAC9C,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC;YAC5B,CAAC,CAAC,cAAO,CAAC,WAAW,EAAE,KAAK,EAAE,SAAS,CAAC;YACxC,CAAC,CAAC,cAAO,CAAC,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;IACtE,CAAC;IAED;;;;;OAKG;IACK,MAAM,CAAC,IAAI,CAAC,WAAmB;QACrC,IAAI,eAAU,CAAC,cAAO,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,IAAI,CAAC,eAAU,CAAC,cAAO,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC,EAAE;YAC7F,OAAO,IAAI,CAAC;SACb;QAED,OAAO,KAAK,CAAC;IACf,CAAC;;AA1HD,2FAA2F;AAC3F,gGAAgG;AACjF,oBAAW,GAAG,GAAG,CAAC;AAGjC,YAAY;AACW,eAAM,GAAa,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,WAAW,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;AAE5F,oBAAW,GAAW,OAAO,CAAC;AAC9B,sBAAa,GAAW,SAAS,CAAC;AAClC,cAAK,GAAW,OAAO,CAAC;AACxB,aAAI,GAAW,MAAM,CAAC;AACtB,kBAAS,GAAW,WAAW,CAAC;AAEvD,uDAAuD;AACvD,wDAAwD;AACxD,qDAAqD;AACrD,wDAAwD;AACxD,2DAA2D;AAC3D,uDAAuD;AAChC,wBAAe,GAAW,WAAW,CAAC;AACtC,sBAAa,GAAW,IAAI,CAAC;AAC7B,qBAAY,GAAW,KAAK,CAAC;AAuGtD,kBAAe,QAAQ,CAAC"}

package/lib/apexdoc/common/tags.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Copyright (c) NCR Terafina
+ **/
+import { IApexDoxTag } from '..';
+export declare const AUTHOR: IApexDoxTag;
+export declare const SINCE: IApexDoxTag;
+export declare const DEPRECATED: IApexDoxTag;
+export declare const DESCRIPTION: IApexDoxTag;
+export declare const EXAMPLE: IApexDoxTag;
+export declare const EXCEPTION: IApexDoxTag;
+export declare const GROUP: IApexDoxTag;
+export declare const TAGS: IApexDoxTag;
+export declare const GROUP_CONTENT: IApexDoxTag;
+export declare const PARAM: IApexDoxTag;
+export declare const QUERYPARAM: IApexDoxTag;
+export declare const RETURN: IApexDoxTag;
+export declare const RETURNS: IApexDoxTag;
+export declare const SEE: IApexDoxTag;
+export declare const APIPATH: IApexDoxTag;
+export declare const APIMETHOD: IApexDoxTag;
+export declare const REQUESTHEADER: IApexDoxTag;
+export declare const RESPONSEHEADER: IApexDoxTag;

package/lib/apexdoc/common/tags.js

@@ -0,0 +1,168 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RESPONSEHEADER = exports.REQUESTHEADER = exports.APIMETHOD = exports.APIPATH = exports.SEE = exports.RETURNS = exports.RETURN = exports.QUERYPARAM = exports.PARAM = exports.GROUP_CONTENT = exports.TAGS = exports.GROUP = exports.EXCEPTION = exports.EXAMPLE = exports.DESCRIPTION = exports.DEPRECATED = exports.SINCE = exports.AUTHOR = void 0;
+exports.AUTHOR = {
+    label: '@author',
+    snippet: `author \${1:}`,
+    documentation: `For: **Class**, **Interface**, **Enum** (top level), & **Method**
+
+\`\`\`
+@author [The type or method author]
+\`\`\``
+};
+exports.SINCE = {
+    label: '@since',
+    snippet: `since \${1:}`,
+    documentation: `For: **Class**, **Interface**, **Enum** (top level), & **Method**
+
+\`\`\`
+@since [The date the type or method was implemented]
+\`\`\``
+};
+exports.DEPRECATED = {
+    label: '@deprecated',
+    snippet: `deprecated \${1:}`,
+    documentation: `For: **Class**, **Interface**, **Enum** (top level), & **Method**
+
+\`\`\`
+@deprecated [The reason the type or method is deprecated & migration path]
+\`\`\``
+};
+exports.DESCRIPTION = {
+    label: '@description',
+    snippet: `description \${1:}`,
+    documentation: `For: **Class**, **Interface**, **Enum**, **Method**, & **Property**
+
+\`\`\`
+@description [Description]
+\`\`\``
+};
+exports.EXAMPLE = {
+    label: '@example',
+    snippet: `example \${1:}`,
+    documentation: `For: **Class**, **Interface**, **Enum** (top level), & **Method**
+
+\`\`\`
+@example
+[An optionally multi-line code example.
+Starts on the line below the tag]
+\`\`\``
+};
+exports.EXCEPTION = {
+    label: '@exception',
+    snippet: `exception \${1:}`,
+    documentation: `For: **Method**
+
+\`\`\`
+@exception [A list or description of exceptions a method throws]
+\`\`\``
+};
+exports.GROUP = {
+    label: '@group ',
+    snippet: `group \${1:}`,
+    documentation: `For: Top-level **Class**, **Interface**, & **Enum**
+
+\`\`\`
+@group [The group the type belongs to. Used to create the docs menu, un-grouped types will go under 'Miscellaneous'.]
+\`\`\``
+};
+exports.TAGS = {
+    label: '@tags ',
+    snippet: `tags \${1:}`,
+    documentation: `For: Top-level **Class**, **Interface**, & **Enum**
+
+\`\`\`
+@tags [The tags the type belongs to. Used to create the docs menu, un-grouped types will go under 'Miscellaneous'.]
+\`\`\``
+};
+exports.GROUP_CONTENT = {
+    label: '@group-content',
+    snippet: `group-content \${1:}`,
+    documentation: `For: Top-level **Class**, **Interface**, & **Enum**
+
+\`\`\`
+@group-content [A file-path relative to the target directory. Should point to an HTML file that describes a class group.]
+\`\`\``
+};
+exports.PARAM = {
+    label: '@param',
+    snippet: `param \${1:paramName} \${2:description}`,
+    documentation: `For: **Method**
+
+\`\`\`
+@param paramName [param description]
+\`\`\``
+};
+exports.QUERYPARAM = {
+    label: '@queryparam',
+    snippet: `queryparam \${1:paramType} \${2:paramName} \${3:description}`,
+    documentation: `For: **Method**
+
+\`\`\`
+@queryparam  paramName paramType [param description]
+\`\`\``
+};
+exports.RETURN = {
+    label: '@return ',
+    snippet: `return \${1:}`,
+    documentation: `For: **Method**
+
+\`\`\`
+@return {return type} [description]
+\`\`\``
+};
+exports.RETURNS = {
+    label: '@returns',
+    snippet: `returns \${1:}`,
+    documentation: `For: **Method**
+
+\`\`\`
+@returns {return type} [description]
+\`\`\``
+};
+exports.SEE = {
+    label: '@see',
+    snippet: `see \${1:}`,
+    documentation: `For: **Class**, **Interface**, **Enum** (top level), & **Method**
+
+\`\`\`
+@see [URL, Markdown URL, or Name Path]
+\`\`\``
+};
+exports.APIPATH = {
+    label: '@apipath',
+    snippet: `apipath \${1:}`,
+    documentation: `For: **Class**, **Interface**, **Enum** (top level), & **Method**
+
+\`\`\`
+@apipath [/]
+\`\`\``
+};
+exports.APIMETHOD = {
+    label: '@apimethod',
+    snippet: `apimethod \${1:}`,
+    documentation: `For: **Class**, **Interface**, **Enum** (top level), & **Method**
+
+\`\`\`
+@apimethod [GET]
+\`\`\``
+};
+exports.REQUESTHEADER = {
+    label: '@requestheader',
+    snippet: `requestheader \${1:paramType} \${2:paramName} \${3:description}`,
+    documentation: `For: **Method**
+
+\`\`\`
+@requestheader paramType paramName [param description]
+\`\`\``
+};
+exports.RESPONSEHEADER = {
+    label: '@responseheader',
+    snippet: `responseheader \${1:paramType} \${2:paramName} \${3:description}`,
+    documentation: `For: **Method**
+
+\`\`\`
+@responseheader paramType paramName [param description]
+\`\`\``
+};
+//# sourceMappingURL=tags.js.map

package/lib/apexdoc/common/tags.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tags.js","sourceRoot":"","sources":["../../../src/apexdoc/common/tags.ts"],"names":[],"mappings":";;;AAKa,QAAA,MAAM,GAAgB;IAC/B,KAAK,EAAE,SAAS;IAChB,OAAO,EAAE,eAAe;IACxB,aAAa,EAAE;;;;OAIZ;CACN,CAAC;AAEW,QAAA,KAAK,GAAgB;IAC9B,KAAK,EAAE,QAAQ;IACf,OAAO,EAAE,cAAc;IACvB,aAAa,EAAE;;;;OAIZ;CACN,CAAC;AAEW,QAAA,UAAU,GAAgB;IACnC,KAAK,EAAE,aAAa;IACpB,OAAO,EAAE,mBAAmB;IAC5B,aAAa,EAAE;;;;OAIZ;CACN,CAAC;AAEW,QAAA,WAAW,GAAgB;IACpC,KAAK,EAAE,cAAc;IACrB,OAAO,EAAE,oBAAoB;IAC7B,aAAa,EAAE;;;;OAIZ;CACN,CAAC;AAEW,QAAA,OAAO,GAAgB;IAChC,KAAK,EAAE,UAAU;IACjB,OAAO,EAAE,gBAAgB;IACzB,aAAa,EAAE;;;;;;OAMZ;CACN,CAAC;AAEW,QAAA,SAAS,GAAgB;IAClC,KAAK,EAAE,YAAY;IACnB,OAAO,EAAE,kBAAkB;IAC3B,aAAa,EAAE;;;;OAIZ;CACN,CAAC;AAEW,QAAA,KAAK,GAAgB;IAC9B,KAAK,EAAE,SAAS;IAChB,OAAO,EAAE,cAAc;IACvB,aAAa,EAAE;;;;OAIZ;CACN,CAAC;AAEW,QAAA,IAAI,GAAgB;IAC7B,KAAK,EAAE,QAAQ;IACf,OAAO,EAAE,aAAa;IACtB,aAAa,EAAE;;;;OAIZ;CACN,CAAC;AAEW,QAAA,aAAa,GAAgB;IACtC,KAAK,EAAE,gBAAgB;IACvB,OAAO,EAAE,sBAAsB;IAC/B,aAAa,EAAE;;;;OAIZ;CACN,CAAC;AAEW,QAAA,KAAK,GAAgB;IAC9B,KAAK,EAAE,QAAQ;IACf,OAAO,EAAE,yCAAyC;IAClD,aAAa,EAAE;;;;OAIZ;CACN,CAAC;AAEW,QAAA,UAAU,GAAgB;IACnC,KAAK,EAAE,aAAa;IACpB,OAAO,EAAE,8DAA8D;IACvE,aAAa,EAAE;;;;OAIZ;CACN,CAAC;AAEW,QAAA,MAAM,GAAgB;IAC/B,KAAK,EAAE,UAAU;IACjB,OAAO,EAAE,eAAe;IACxB,aAAa,EAAE;;;;OAIZ;CACN,CAAC;AAEW,QAAA,OAAO,GAAgB;IAChC,KAAK,EAAE,UAAU;IACjB,OAAO,EAAE,gBAAgB;IACzB,aAAa,EAAE;;;;OAIZ;CACN,CAAC;AAEW,QAAA,GAAG,GAAgB;IAC5B,KAAK,EAAE,MAAM;IACb,OAAO,EAAE,YAAY;IACrB,aAAa,EAAE;;;;OAIZ;CACN,CAAC;AAEW,QAAA,OAAO,GAAgB;IAChC,KAAK,EAAE,UAAU;IACjB,OAAO,EAAE,gBAAgB;IACzB,aAAa,EAAE;;;;OAIZ;CACN,CAAC;AAEW,QAAA,SAAS,GAAgB;IAClC,KAAK,EAAE,YAAY;IACnB,OAAO,EAAE,kBAAkB;IAC3B,aAAa,EAAE;;;;OAIZ;CACN,CAAC;AAEW,QAAA,aAAa,GAAgB;IACtC,KAAK,EAAE,gBAAgB;IACvB,OAAO,EAAE,iEAAiE;IAC1E,aAAa,EAAE;;;;OAIZ;CACN,CAAC;AAEW,QAAA,cAAc,GAAgB;IACvC,KAAK,EAAE,iBAAiB;IACxB,OAAO,EAAE,kEAAkE;IAC3E,aAAa,EAAE;;;;OAIZ;CACN,CAAC"}

package/lib/apexdoc/common/utils.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Copyright (c) NCR Terafina
+ **/
+import { ClassModel } from './models/class-model';
+import { Option } from '..';
+declare class Utils {
+    private static readonly PRIVATE;
+    private static readonly TEST_METHOD;
+    private static COLLECTIONS;
+    private static KEYWORDS;
+    static isClassOrInterface(line: string): boolean;
+    static isEnum(line: string): boolean;
+    static stripAnnotations(line: string): string;
+    /**
+     * Helper method to determine if a line being parsed should be skipped.
+     * Ignore lines not dealing with scope unless they start with the certain keywords:
+     * We do not want to skip @isTest classes, inner classes, inner interfaces, or inner
+     * enums defined without without explicit access modifiers. These are assumed to be
+     * private. Also, interface methods don't have scope, so don't skip those lines either.
+     */
+    static shouldSkipLine(line: string, cModel?: ClassModel): boolean;
+    /** Can match some implicitly private methods, but not all! */
+    static getScope(line: string): Option<string, void>;
+    static previousWord(str: string, searchIdx: number): string;
+    static countChars(str: string, char: string): number;
+    static isURL(str: string): boolean;
+    static resolveWorkspaceFolder(path: string): string;
+    static escapeRegExp(str: string): string;
+    static boolGuard(bool: boolean, defaultValue: boolean): boolean;
+    /**
+     * We use the plugin `pretty` to make the output HTML more readable. As a side effect
+     * there is whitespace between the pre and code tags which causes unwanted space in the HTML
+     * document. Here, we're removing that space so pre and code tags do not have space between them.
+     * @param html The html string to make replacements on.
+     */
+    static preCodeTrim(html: string): string;
+}
+export default Utils;

package/lib/apexdoc/common/utils.js

@@ -0,0 +1,198 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const array_utils_1 = require("./array-utils");
+const path_1 = require("path");
+const settings_1 = tslib_1.__importDefault(require("./settings"));
+class Utils {
+    static isClassOrInterface(line) {
+        // Account for inner classes or @isTest classes without an access modifier; implicitly private
+        if (/.*\bclass\b.*/.test(line.toLowerCase()) || /\s?\binterface\s/i.test(line.toLowerCase())) {
+            return true;
+        }
+        return false;
+    }
+    static isEnum(line) {
+        line = this.stripAnnotations(line);
+        if (/^(global\s+|public\s+|private\s+)?enum\b.*/.test(line)) {
+            return true;
+        }
+        return false;
+    }
+    static stripAnnotations(line) {
+        let i = 0;
+        while (line && line.trim().startsWith('@')) {
+            line = line.trim().replace(/@\w+\s*(\([\w=.*''/\s]+\))?/, '');
+            if (i >= 100) {
+                break; // infinite loop protect, just in case
+            }
+            i++;
+        }
+        return line;
+    }
+    /**
+     * Helper method to determine if a line being parsed should be skipped.
+     * Ignore lines not dealing with scope unless they start with the certain keywords:
+     * We do not want to skip @isTest classes, inner classes, inner interfaces, or inner
+     * enums defined without without explicit access modifiers. These are assumed to be
+     * private. Also, interface methods don't have scope, so don't skip those lines either.
+     */
+    static shouldSkipLine(line, cModel) {
+        const classNameParts = (cModel && cModel.name.split('.')) || [''];
+        const className = array_utils_1.last(classNameParts);
+        if (!this.getScope(line) &&
+            !line.toLowerCase().startsWith(settings_1.default.ENUM + ' ') &&
+            !line.toLowerCase().startsWith(settings_1.default.CLASS + ' ') &&
+            !line.toLowerCase().startsWith(settings_1.default.INTERFACE + ' ') &&
+            // don't skip default constructors without access modifiers
+            !(cModel && new RegExp('\\b' + className + '\\s*\\(').test(line)) &&
+            // don't skip interface methods - they don't have access modifiers
+            !(cModel && cModel.isInterface && line.includes('('))) {
+            return true;
+        }
+        return false;
+    }
+    /** Can match some implicitly private methods, but not all! */
+    static getScope(line) {
+        for (let scope of settings_1.default.config.scope) {
+            // if line starts with annotations, replace them, so
+            // we can accurately use startsWith to match scope.
+            line = this.stripAnnotations(line).toLowerCase().trim();
+            scope = scope.toLowerCase();
+            // line starts with registered scope
+            if (line.startsWith(scope + ' ')) {
+                return scope;
+            }
+            // current scope is testmethod and our line is a test method
+            if (scope === this.TEST_METHOD && line.startsWith(`static ${this.TEST_METHOD} `)) {
+                return scope;
+            }
+        }
+        // try to reasonably match implicitly private lines if
+        // 'private' included in user's documentable scopes list
+        if (settings_1.default.config.scope.includes(this.PRIVATE)) {
+            // match static props or methods
+            if (line.startsWith('static ') && !line.includes(` ${this.TEST_METHOD} `)) {
+                return this.PRIVATE;
+            }
+            // match methods that start with
+            // keywords or return primitive types
+            for (const keyword of this.KEYWORDS) {
+                if (line.startsWith(keyword + ' ') && line.includes('(')) {
+                    return this.PRIVATE;
+                }
+            }
+            // match methods that return collections
+            for (const collection of this.COLLECTIONS) {
+                if (new RegExp('^' + collection + '<.+>\\s.*').test(line) && line.includes('(')) {
+                    return this.PRIVATE;
+                }
+            }
+        }
+    }
+    static previousWord(str, searchIdx) {
+        if (!str) {
+            return '';
+        }
+        if (searchIdx >= str.length) {
+            return '';
+        }
+        let idxStart, idxEnd;
+        for (idxStart = searchIdx - 1, idxEnd = 0; idxStart > 0; idxStart--) {
+            if (idxEnd === 0) {
+                if (str.charAt(idxStart) === ' ') {
+                    continue;
+                }
+                idxEnd = idxStart + 1;
+            }
+            else if (str.charAt(idxStart) === ' ') {
+                idxStart++;
+                break;
+            }
+        }
+        return str.substring(idxStart, idxEnd);
+    }
+    static countChars(str, char) {
+        let count = 0;
+        for (let i = 0; i < str.length; ++i) {
+            if (str.charAt(i) === char) {
+                ++count;
+            }
+        }
+        return count;
+    }
+    static isURL(str) {
+        if (!str) {
+            return false;
+        }
+        return /^(https?):\/\/[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]/.test(str.trim());
+    }
+    static resolveWorkspaceFolder(path) {
+        // should be safe to cast this as not-undefined
+        // If running this tool, workspace folders should always exist.
+        const rootFolderRe = /\$\{workspaceFolder\}(.*)?/;
+        // const multiFolderRe = /\$\{workspaceFolder:(.*)\}(.*)/;
+        if (rootFolderRe.test(path)) {
+            const results = rootFolderRe.exec(path);
+            return path_1.resolve('./', ...results[1].split(/\\|\//));
+        }
+        // else if (multiFolderRe.test(path)) {
+        //     const results = <RegExpExecArray>multiFolderRe.exec(path);
+        //     for (let folder of folders) {
+        //         if (folder.name === results[1]) {
+        //             return resolve('./', ...results[2].split(/\\|\//));
+        //         }
+        //     }
+        //     throw new SfdxError(`Workspace variable in path '${path}' could not be resolved.`);
+        // }
+        return path;
+    }
+    static escapeRegExp(str) {
+        return str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+    }
+    // common guard utility for Validator classes
+    static boolGuard(bool, defaultValue) {
+        if (typeof bool !== 'boolean') {
+            return defaultValue;
+        }
+        return bool;
+    }
+    /**
+     * We use the plugin `pretty` to make the output HTML more readable. As a side effect
+     * there is whitespace between the pre and code tags which causes unwanted space in the HTML
+     * document. Here, we're removing that space so pre and code tags do not have space between them.
+     * @param html The html string to make replacements on.
+     */
+    static preCodeTrim(html) {
+        if (!/<pre/.test(html)) {
+            return html;
+        }
+        html = html.replace(/<pre class="([a-z-]+)">\s+<code>/g, '<pre class="$1"><code>');
+        html = html.replace(/<\/code>\s+<\/pre>/g, '</code></pre>');
+        return html;
+    }
+}
+Utils.PRIVATE = 'private';
+Utils.TEST_METHOD = 'testmethod';
+Utils.COLLECTIONS = ['list', 'set', 'map'];
+Utils.KEYWORDS = [
+    'abstract',
+    'final',
+    'virtual',
+    'override',
+    'void',
+    'blob',
+    'boolean',
+    'date',
+    'datetime',
+    'decimal',
+    'double',
+    'id',
+    'integer',
+    'long',
+    'object',
+    'string',
+    'time'
+];
+exports.default = Utils;
+//# sourceMappingURL=utils.js.map

package/lib/apexdoc/common/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/apexdoc/common/utils.ts"],"names":[],"mappings":";;;AAIA,+CAAqC;AAErC,+BAA+B;AAC/B,kEAAkC;AAElC,MAAM,KAAK;IAwBF,MAAM,CAAC,kBAAkB,CAAC,IAAY;QAC3C,8FAA8F;QAC9F,IAAI,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE;YAC5F,OAAO,IAAI,CAAC;SACb;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,MAAM,CAAC,MAAM,CAAC,IAAY;QAC/B,IAAI,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,4CAA4C,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YAC3D,OAAO,IAAI,CAAC;SACb;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,MAAM,CAAC,gBAAgB,CAAC,IAAY;QACzC,IAAI,CAAC,GAAG,CAAC,CAAC;QACV,OAAO,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YAC1C,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,6BAA6B,EAAE,EAAE,CAAC,CAAC;YAC9D,IAAI,CAAC,IAAI,GAAG,EAAE;gBACZ,MAAM,CAAC,sCAAsC;aAC9C;YACD,CAAC,EAAE,CAAC;SACL;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,cAAc,CAAC,IAAY,EAAE,MAAmB;QAC5D,MAAM,cAAc,GAAG,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAClE,MAAM,SAAS,GAAG,kBAAI,CAAC,cAAc,CAAC,CAAC;QAEvC,IACE,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;YACpB,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,kBAAQ,CAAC,IAAI,GAAG,GAAG,CAAC;YACnD,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,kBAAQ,CAAC,KAAK,GAAG,GAAG,CAAC;YACpD,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,kBAAQ,CAAC,SAAS,GAAG,GAAG,CAAC;YACxD,2DAA2D;YAC3D,CAAC,CAAC,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,GAAG,SAAS,GAAG,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACjE,kEAAkE;YAClE,CAAC,CAAC,MAAM,IAAI,MAAM,CAAC,WAAW,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EACrD;YACA,OAAO,IAAI,CAAC;SACb;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED,8DAA8D;IACvD,MAAM,CAAC,QAAQ,CAAC,IAAY;QACjC,KAAK,IAAI,KAAK,IAAI,kBAAQ,CAAC,MAAM,CAAC,KAAK,EAAE;YACvC,oDAAoD;YACpD,mDAAmD;YACnD,IAAI,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC;YACxD,KAAK,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;YAE5B,oCAAoC;YACpC,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,GAAG,GAAG,CAAC,EAAE;gBAChC,OAAO,KAAK,CAAC;aACd;YAED,4DAA4D;YAC5D,IAAI,KAAK,KAAK,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,UAAU,CAAC,UAAU,IAAI,CAAC,WAAW,GAAG,CAAC,EAAE;gBAChF,OAAO,KAAK,CAAC;aACd;SACF;QAED,sDAAsD;QACtD,wDAAwD;QACxD,IAAI,kBAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;YAChD,gCAAgC;YAChC,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,WAAW,GAAG,CAAC,EAAE;gBACzE,OAAO,IAAI,CAAC,OAAO,CAAC;aACrB;YAED,gCAAgC;YAChC,qCAAqC;YACrC,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE;gBACnC,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,GAAG,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;oBACxD,OAAO,IAAI,CAAC,OAAO,CAAC;iBACrB;aACF;YAED,wCAAwC;YACxC,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE;gBACzC,IAAI,IAAI,MAAM,CAAC,GAAG,GAAG,UAAU,GAAG,WAAW,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;oBAC/E,OAAO,IAAI,CAAC,OAAO,CAAC;iBACrB;aACF;SACF;IACH,CAAC;IAEM,MAAM,CAAC,YAAY,CAAC,GAAW,EAAE,SAAiB;QACvD,IAAI,CAAC,GAAG,EAAE;YACR,OAAO,EAAE,CAAC;SACX;QAED,IAAI,SAAS,IAAI,GAAG,CAAC,MAAM,EAAE;YAC3B,OAAO,EAAE,CAAC;SACX;QAED,IAAI,QAAgB,EAAE,MAAc,CAAC;QACrC,KAAK,QAAQ,GAAG,SAAS,GAAG,CAAC,EAAE,MAAM,GAAG,CAAC,EAAE,QAAQ,GAAG,CAAC,EAAE,QAAQ,EAAE,EAAE;YACnE,IAAI,MAAM,KAAK,CAAC,EAAE;gBAChB,IAAI,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,GAAG,EAAE;oBAChC,SAAS;iBACV;gBACD,MAAM,GAAG,QAAQ,GAAG,CAAC,CAAC;aACvB;iBAAM,IAAI,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,GAAG,EAAE;gBACvC,QAAQ,EAAE,CAAC;gBACX,MAAM;aACP;SACF;QAED,OAAO,GAAG,CAAC,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACzC,CAAC;IAEM,MAAM,CAAC,UAAU,CAAC,GAAW,EAAE,IAAY;QAChD,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;YACnC,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE;gBAC1B,EAAE,KAAK,CAAC;aACT;SACF;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,GAAW;QAC7B,IAAI,CAAC,GAAG,EAAE;YACR,OAAO,KAAK,CAAC;SACd;QAED,OAAO,mEAAmE,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;IAC9F,CAAC;IAEM,MAAM,CAAC,sBAAsB,CAAC,IAAY;QAC/C,+CAA+C;QAC/C,+DAA+D;QAE/D,MAAM,YAAY,GAAG,4BAA4B,CAAC;QAClD,0DAA0D;QAE1D,IAAI,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YAC3B,MAAM,OAAO,GAAoB,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACzD,OAAO,cAAO,CAAC,IAAI,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;SACpD;QACD,uCAAuC;QACvC,iEAAiE;QACjE,oCAAoC;QACpC,4CAA4C;QAC5C,kEAAkE;QAClE,YAAY;QACZ,QAAQ;QAER,0FAA0F;QAC1F,IAAI;QAEJ,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,MAAM,CAAC,YAAY,CAAC,GAAW;QACpC,OAAO,GAAG,CAAC,OAAO,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC;IAED,6CAA6C;IACtC,MAAM,CAAC,SAAS,CAAC,IAAa,EAAE,YAAqB;QAC1D,IAAI,OAAO,IAAI,KAAK,SAAS,EAAE;YAC7B,OAAO,YAAY,CAAC;SACrB;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,WAAW,CAAC,IAAY;QACpC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YACtB,OAAO,IAAI,CAAC;SACb;QAED,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,mCAAmC,EAAE,wBAAwB,CAAC,CAAC;QACnF,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,eAAe,CAAC,CAAC;QAC5D,OAAO,IAAI,CAAC;IACd,CAAC;;AA5NuB,aAAO,GAAW,SAAS,CAAC;AAC5B,iBAAW,GAAW,YAAY,CAAC;AAC5C,iBAAW,GAAa,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;AAC/C,cAAQ,GAAa;IAClC,UAAU;IACV,OAAO;IACP,SAAS;IACT,UAAU;IACV,MAAM;IACN,MAAM;IACN,SAAS;IACT,MAAM;IACN,UAAU;IACV,SAAS;IACT,QAAQ;IACR,IAAI;IACJ,SAAS;IACT,MAAM;IACN,QAAQ;IACR,QAAQ;IACR,MAAM;CACP,CAAC;AA0MJ,kBAAe,KAAK,CAAC"}

package/lib/apexdoc/common/validator-engine.d.ts

@@ -0,0 +1,24 @@
+import Validator from './validator';
+import { IEngineConfig } from '../index';
+declare class ValidatorEngine extends Validator<IEngineConfig> {
+    constructor(config: IEngineConfig);
+    private includes;
+    private excludes;
+    private cleanDir;
+    private showTOCSnippets;
+    private subtitle;
+    private pages;
+    private assets;
+    private targetDirectory;
+    private homePagePath;
+    private sortOrder;
+    private title;
+    private scope;
+    private source;
+    static port(port: number): number;
+    private static directory;
+    private static sourceUrl;
+    private static stringArray;
+    private static typeGuard;
+}
+export default ValidatorEngine;