@terafina/tffa-sfdx-plugin 0.1.2 → 1.0.1

package/lib/apexdoc/engine/generators/see-link-generator.js

@@ -0,0 +1,183 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+/**
+ * Copyright (c) NCR Terafina
+ **/
+const Models = tslib_1.__importStar(require("../../common/models"));
+const apex_docs_error_1 = tslib_1.__importDefault(require("../../common/apex-docs-error"));
+const utils_1 = tslib_1.__importDefault(require("../../common/utils"));
+class SeeLinkGenerator {
+    static isMarkdownURL(str) {
+        return /^\[.*\]\(.*\)$/.test(str.trim());
+    }
+    static markdownUrlToLink(str) {
+        str = str.trim();
+        const linkName = str.substring(1, str.indexOf(']'));
+        const url = str.substring(str.indexOf('](') + 2, str.length - 1);
+        return utils_1.default.isURL(url)
+            ? `<a target="_blank" rel="noopener noreferrer" href="${url}">${linkName}</a>`
+            : `<span title="URL is invalid!">${linkName}</span>`;
+    }
+    static makeLinks(models, qualifiers) {
+        // initialize list to store created links
+        const links = new Array();
+        // iterate over each qualifier and process
+        // we could just take the users qualifiers and assume its a valid path
+        // but this could easily result in dead links. This algorithm doesn't
+        // exactly scream efficiency, but its still fast on moderate codebases
+        // and its better than the alternative of dead links all over the place.
+        for (let qualifier of qualifiers) {
+            qualifier = qualifier.trim();
+            // 1) continue if empty
+            if (!qualifier) {
+                continue;
+            }
+            // 2) check if URL, add to links and continue with loop if so
+            if (utils_1.default.isURL(qualifier)) {
+                links.push(`<a target="_blank" rel="noopener noreferrer" href="${qualifier}">${qualifier}</a>`);
+                continue;
+            }
+            // 3) check if markdown-formatted URL. add to links and continue.
+            // markdown parsing function will detect if URL is valid and return
+            // a span with tooltip indicating invalid link if not
+            if (this.isMarkdownURL(qualifier)) {
+                links.push(this.markdownUrlToLink(qualifier));
+                continue;
+            }
+            // 4) if not URL or empty, must be a qualified class or method name.
+            // First prepare the qualifier by stripping away and saving any method
+            // overload selector for later. E.g. SomeClass.SomeMethod[4] means: link
+            // to the 4th overload (zero-based) of that method. This syntax is only required
+            // to specify a method other than the 1st. Otherwise SomeClass.SomeMethod is fine
+            let overloadSelector = 0;
+            if (/.*\[\d+\]$/.test(qualifier)) {
+                const i = qualifier.lastIndexOf('[');
+                // isolate the number inside the brackets
+                const selector = qualifier.substring(i + 1, qualifier.length - 1);
+                overloadSelector = Number(selector);
+                // strip away the suffix from the qualifier
+                qualifier = qualifier.substring(0, i);
+            }
+            const parts = qualifier.split('.').map(p => p.toLowerCase());
+            if (!parts.length || parts.length > 3) {
+                throw new apex_docs_error_1.default(`Qualifier '${qualifier}' is invalid. ${apex_docs_error_1.default.INVALID_SEE_QUALIFIER}`);
+            }
+            let href = '';
+            let foundMatch = false;
+            // 4.A) if first qualifier matches class name, begin search: We've
+            // made the model map in all lowercase to avoid case mis-matching
+            const model = models.get(parts[0]);
+            if (model) {
+                // if only a single qualifier, stop here
+                if (parts.length === 1) {
+                    href = model.name + '.html';
+                    qualifier = model.name;
+                    foundMatch = true;
+                }
+                // 4.B) otherwise keep searching for a match for the second qualifier as long as
+                // model is not an enum model, in which case there is no searching left to do
+                else if (parts.length >= 2 && model.modelType !== Models.ModelType.ENUM) {
+                    const Class = model;
+                    const methods = Class.methods;
+                    const childClasses = Class.childClassMap;
+                    // attempt to match method, and select correct overload if required
+                    const matchResults = this.methodMatcher(methods, parts[1], overloadSelector);
+                    if (matchResults.foundMatch) {
+                        qualifier = `${Class.name}.${matchResults.methodName}`;
+                        href = `${Class.name}.html#${Class.name}.${matchResults.methodName}`;
+                        href += matchResults.selector; // append overload selector
+                        foundMatch = true;
+                    }
+                    // 4.C) if after searching methods a match hasn't been found
+                    // yet see if child class name matches the second qualifier.
+                    if (!foundMatch) {
+                        // ApexDox stores child class name as 'OuterClass.InnerClass'
+                        // recreate that format below to try to make the match with
+                        const maybeChildClassName = parts[0] + '.' + parts[1];
+                        const childClass = childClasses.get(maybeChildClassName);
+                        if (childClass) {
+                            const [parentClassName, childClassName] = childClass.name.split('.');
+                            // 4.D) If match, and only 2 parts, stop here.
+                            if (parts.length === 2) {
+                                // to ensure the link works, use model names rather than user provided
+                                // qualifiers in case casing doesn't match. Label will match user's
+                                // qualifier, but by using model names, we ensure proper casing.
+                                href = `${parentClassName}.html#${parentClassName}.${childClassName}`;
+                                qualifier = `${parentClassName}.${childClassName}`;
+                                foundMatch = true;
+                            }
+                            // 4.E) Otherwise, there must be 3 parts
+                            // attempt to match on child class method.
+                            else {
+                                const matchResults = this.methodMatcher(childClass.methods, parts[2], overloadSelector);
+                                if (matchResults.foundMatch) {
+                                    qualifier = `${childClass.name}.${matchResults.methodName}`;
+                                    href = `${parentClassName}.html#${childClass.name}.${matchResults.methodName}`;
+                                    href += matchResults.selector; // append overload selector
+                                    foundMatch = true;
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+            // 5) if match made, create link with goToLocation function onclick
+            // Otherwise, add span with Tooltip indicating no link could be made
+            let link;
+            if (foundMatch) {
+                link = `<a href="javascript:void(0)" onclick="goToLocation('${href}')">${qualifier}</a>`;
+            }
+            else {
+                link = `<span title="A valid link could not be created with this identifier.">${qualifier}</span>`;
+            }
+            links.push(link);
+        }
+        // 6) collect links / spans and return
+        return links;
+    }
+    /**
+     * Search through methods for a match to the provided qualifier. If a match is made
+     * and an overload selector is provided, continue iterating to see if that overload
+     * exists, and match on it if it does. If it does not, report that no match is made.
+     *
+     * @param methods The methods to search for a match through
+     * @param matcher The user provided qualifier to match against a method name
+     * @param overloadSelector The user provided indicator of the method overload number
+     */
+    static methodMatcher(methods, matcher, overloadSelector) {
+        let methodNum = 0;
+        let foundMatch = false;
+        let selector = '', methodName = '';
+        for (const method of methods) {
+            if (method.name.toLowerCase() === matcher) {
+                methodName = method.name;
+                // no overload selector, we've made a match!
+                if (overloadSelector === 0) {
+                    foundMatch = true;
+                    break;
+                }
+                // If there's an overload suffix to take into account
+                // ensure that many overloads of the method actually
+                // exist before committing to the method link.
+                else if (overloadSelector > 0 && methodNum !== overloadSelector) {
+                    methodNum++;
+                    continue;
+                }
+                // confirmed overload exists. Match!!
+                else if (methodNum === overloadSelector) {
+                    selector = '_' + overloadSelector;
+                    foundMatch = true;
+                    break;
+                }
+            }
+        }
+        return {
+            foundMatch,
+            methodName,
+            selector
+        };
+    }
+}
+exports.default = SeeLinkGenerator;
+//# sourceMappingURL=see-link-generator.js.map

package/lib/apexdoc/engine/generators/see-link-generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"see-link-generator.js","sourceRoot":"","sources":["../../../../src/apexdoc/engine/generators/see-link-generator.ts"],"names":[],"mappings":";;;AAAA;;IAEI;AACJ,oEAA8C;AAC9C,2FAAwD;AACxD,uEAAuC;AAGvC,MAAM,gBAAgB;IACZ,MAAM,CAAC,aAAa,CAAC,GAAW;QACtC,OAAO,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;IAC3C,CAAC;IAEO,MAAM,CAAC,iBAAiB,CAAC,GAAW;QAC1C,GAAG,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC;QAEjB,MAAM,QAAQ,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;QACpD,MAAM,GAAG,GAAG,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAEjE,OAAO,eAAK,CAAC,KAAK,CAAC,GAAG,CAAC;YACrB,CAAC,CAAC,sDAAsD,GAAG,KAAK,QAAQ,MAAM;YAC9E,CAAC,CAAC,iCAAiC,QAAQ,SAAS,CAAC;IACzD,CAAC;IAEM,MAAM,CAAC,SAAS,CAAC,MAAyC,EAAE,UAAoB;QACrF,yCAAyC;QACzC,MAAM,KAAK,GAAG,IAAI,KAAK,EAAU,CAAC;QAElC,0CAA0C;QAC1C,sEAAsE;QACtE,qEAAqE;QACrE,sEAAsE;QACtE,wEAAwE;QACxE,KAAK,IAAI,SAAS,IAAI,UAAU,EAAE;YAChC,SAAS,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;YAE7B,uBAAuB;YACvB,IAAI,CAAC,SAAS,EAAE;gBACd,SAAS;aACV;YAED,6DAA6D;YAC7D,IAAI,eAAK,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE;gBAC1B,KAAK,CAAC,IAAI,CAAC,sDAAsD,SAAS,KAAK,SAAS,MAAM,CAAC,CAAC;gBAChG,SAAS;aACV;YAED,iEAAiE;YACjE,mEAAmE;YACnE,qDAAqD;YACrD,IAAI,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,EAAE;gBACjC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC;gBAC9C,SAAS;aACV;YAED,oEAAoE;YACpE,sEAAsE;YACtE,wEAAwE;YACxE,gFAAgF;YAChF,iFAAiF;YACjF,IAAI,gBAAgB,GAAG,CAAC,CAAC;YACzB,IAAI,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;gBAChC,MAAM,CAAC,GAAG,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;gBACrC,yCAAyC;gBACzC,MAAM,QAAQ,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,EAAE,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;gBAClE,gBAAgB,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;gBACpC,2CAA2C;gBAC3C,SAAS,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;aACvC;YAED,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;YAE7D,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;gBACrC,MAAM,IAAI,yBAAY,CAAC,cAAc,SAAS,iBAAiB,yBAAY,CAAC,qBAAqB,EAAE,CAAC,CAAC;aACtG;YAED,IAAI,IAAI,GAAG,EAAE,CAAC;YACd,IAAI,UAAU,GAAG,KAAK,CAAC;YAEvB,kEAAkE;YAClE,iEAAiE;YACjE,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YAEnC,IAAI,KAAK,EAAE;gBACT,wCAAwC;gBACxC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;oBACtB,IAAI,GAAG,KAAK,CAAC,IAAI,GAAG,OAAO,CAAC;oBAC5B,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC;oBACvB,UAAU,GAAG,IAAI,CAAC;iBACnB;gBAED,gFAAgF;gBAChF,6EAA6E;qBACxE,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC,IAAI,KAAK,CAAC,SAAS,KAAK,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE;oBACvE,MAAM,KAAK,GAAsB,KAAK,CAAC;oBACvC,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;oBAC9B,MAAM,YAAY,GAAG,KAAK,CAAC,aAAa,CAAC;oBAEzC,mEAAmE;oBACnE,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC;oBAC7E,IAAI,YAAY,CAAC,UAAU,EAAE;wBAC3B,SAAS,GAAG,GAAG,KAAK,CAAC,IAAI,IAAI,YAAY,CAAC,UAAU,EAAE,CAAC;wBACvD,IAAI,GAAG,GAAG,KAAK,CAAC,IAAI,SAAS,KAAK,CAAC,IAAI,IAAI,YAAY,CAAC,UAAU,EAAE,CAAC;wBACrE,IAAI,IAAI,YAAY,CAAC,QAAQ,CAAC,CAAC,2BAA2B;wBAC1D,UAAU,GAAG,IAAI,CAAC;qBACnB;oBAED,4DAA4D;oBAC5D,4DAA4D;oBAC5D,IAAI,CAAC,UAAU,EAAE;wBACf,6DAA6D;wBAC7D,2DAA2D;wBAC3D,MAAM,mBAAmB,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;wBACtD,MAAM,UAAU,GAAG,YAAY,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;wBAEzD,IAAI,UAAU,EAAE;4BACd,MAAM,CAAC,eAAe,EAAE,cAAc,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;4BACrE,8CAA8C;4BAC9C,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;gCACtB,sEAAsE;gCACtE,mEAAmE;gCACnE,gEAAgE;gCAChE,IAAI,GAAG,GAAG,eAAe,SAAS,eAAe,IAAI,cAAc,EAAE,CAAC;gCACtE,SAAS,GAAG,GAAG,eAAe,IAAI,cAAc,EAAE,CAAC;gCACnD,UAAU,GAAG,IAAI,CAAC;6BACnB;4BACD,wCAAwC;4BACxC,0CAA0C;iCACrC;gCACH,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC;gCACxF,IAAI,YAAY,CAAC,UAAU,EAAE;oCAC3B,SAAS,GAAG,GAAG,UAAU,CAAC,IAAI,IAAI,YAAY,CAAC,UAAU,EAAE,CAAC;oCAC5D,IAAI,GAAG,GAAG,eAAe,SAAS,UAAU,CAAC,IAAI,IAAI,YAAY,CAAC,UAAU,EAAE,CAAC;oCAC/E,IAAI,IAAI,YAAY,CAAC,QAAQ,CAAC,CAAC,2BAA2B;oCAC1D,UAAU,GAAG,IAAI,CAAC;iCACnB;6BACF;yBACF;qBACF;iBACF;aACF;YAED,mEAAmE;YACnE,oEAAoE;YACpE,IAAI,IAAY,CAAC;YACjB,IAAI,UAAU,EAAE;gBACd,IAAI,GAAG,uDAAuD,IAAI,OAAO,SAAS,MAAM,CAAC;aAC1F;iBAAM;gBACL,IAAI,GAAG,yEAAyE,SAAS,SAAS,CAAC;aACpG;YAED,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAClB;QAED,sCAAsC;QACtC,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;OAQG;IACK,MAAM,CAAC,aAAa,CAAC,OAA6B,EAAE,OAAe,EAAE,gBAAwB;QACnG,IAAI,SAAS,GAAG,CAAC,CAAC;QAClB,IAAI,UAAU,GAAG,KAAK,CAAC;QACvB,IAAI,QAAQ,GAAG,EAAE,EACf,UAAU,GAAG,EAAE,CAAC;QAElB,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;YAC5B,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,OAAO,EAAE;gBACzC,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC;gBACzB,4CAA4C;gBAC5C,IAAI,gBAAgB,KAAK,CAAC,EAAE;oBAC1B,UAAU,GAAG,IAAI,CAAC;oBAClB,MAAM;iBACP;gBACD,qDAAqD;gBACrD,oDAAoD;gBACpD,8CAA8C;qBACzC,IAAI,gBAAgB,GAAG,CAAC,IAAI,SAAS,KAAK,gBAAgB,EAAE;oBAC/D,SAAS,EAAE,CAAC;oBACZ,SAAS;iBACV;gBACD,qCAAqC;qBAChC,IAAI,SAAS,KAAK,gBAAgB,EAAE;oBACvC,QAAQ,GAAG,GAAG,GAAG,gBAAgB,CAAC;oBAClC,UAAU,GAAG,IAAI,CAAC;oBAClB,MAAM;iBACP;aACF;SACF;QAED,OAAO;YACL,UAAU;YACV,UAAU;YACV,QAAQ;SACT,CAAC;IACJ,CAAC;CACF;AAED,kBAAe,gBAAgB,CAAC"}

package/lib/commands/tffa/apexdoc.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Copyright (c) NCR Terafina
+ **/
+import { flags, SfdxCommand } from '@salesforce/command';
+export default class ApexDoc extends SfdxCommand {
+    static description: string;
+    static examples: string[];
+    private currentFile;
+    protected static flagsConfig: {
+        sourcefolder: flags.Discriminated<flags.Option<string>>;
+    };
+    run(): Promise<unknown>;
+    /**
+     * Entry point for the program. Called by SFDX on extension activation.
+     *
+     * @param config The configuration collected from the users config,
+     * supplemented with any defaults if user did not include them.
+     */
+    private generateDocs;
+    private createClassGroupMap;
+    /**
+     * The main routine for parsing our Apex files. Here we collect ApexDox comments, and create
+     * models of our top-level types (Classes and Enums) and their members (Enum values, Methods,
+     * Properties, Inner Classes, etc.).
+     *
+     * @param filePath The path of the file being parsed
+     */
+    private parseFileContents;
+}

package/lib/commands/tffa/apexdoc.js

@@ -0,0 +1,272 @@
+"use strict";
+/**
+ * Copyright (c) NCR Terafina
+ **/
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const command_1 = require("@salesforce/command");
+const Models = tslib_1.__importStar(require("../../apexdoc/common/models"));
+const core_1 = require("@salesforce/core");
+const settings_1 = tslib_1.__importStar(require("../../apexdoc/common/settings"));
+const file_manager_1 = tslib_1.__importDefault(require("../../apexdoc/engine/file-manager"));
+const path_1 = require("path");
+const perf_hooks_1 = require("perf_hooks");
+const line_reader_1 = tslib_1.__importDefault(require("../../apexdoc/common/line-reader"));
+const utils_1 = tslib_1.__importDefault(require("../../apexdoc/common/utils"));
+const array_utils_1 = require("../../apexdoc/common/array-utils");
+class ApexDoc extends command_1.SfdxCommand {
+    async run() {
+        const project = await core_1.SfdxProject.resolve(this.flags.sourcefolder);
+        try {
+            settings_1.default.config = settings_1.default.getConfig(settings_1.Feature.ENGINE);
+            this.generateDocs(settings_1.default.config);
+        }
+        catch (e) {
+            console.log(e);
+            throw new core_1.SfdxError(e.message, 'XMLNotFoundError');
+        }
+        return '';
+    }
+    /**
+     * Entry point for the program. Called by SFDX on extension activation.
+     *
+     * @param config The configuration collected from the users config,
+     * supplemented with any defaults if user did not include them.
+     */
+    generateDocs(config) {
+        const beginElapsed = perf_hooks_1.performance.now();
+        const fileManager = new file_manager_1.default(config.targetDirectory, config.title, config.assets);
+        const files = fileManager.getFiles(config.source, config.includes, config.excludes);
+        const models = new Map();
+        // track the number of files we've processed
+        let numProcessed = 0;
+        // parse our top-level class files
+        files.forEach(entry => {
+            this.currentFile = path_1.basename(entry.path);
+            const model = this.parseFileContents(entry.path, entry.sourceUrl);
+            if (model) {
+                models.set(model.name.toLowerCase(), model);
+                numProcessed++;
+            }
+        });
+        // load up optional templates and create class groups for menu
+        const supplementaryPages = [config.homePagePath, ...config.pages];
+        const classGroupMap = this.createClassGroupMap(models);
+        // run our documentation engine and create set of HTML files
+        fileManager.createDocs(classGroupMap, models, supplementaryPages);
+        // we are done!
+        const endElapsed = perf_hooks_1.performance.now();
+        const elapsed = ((endElapsed - beginElapsed) / 1000).toFixed(2);
+        console.info(`Apex API Docs Generation Complete! ${numProcessed} files documented in ${elapsed}s.`);
+    }
+    createClassGroupMap(models) {
+        const classGroupMap = new Map();
+        models.forEach(model => {
+            // if group name is falsy, default to this misc bucket
+            // un-grouped classes will be placed under this menu
+            const group = model.groupName || 'Miscellaneous', contentPath = model.groupContentPath;
+            let classGroup = classGroupMap.get(group);
+            if (!classGroup) {
+                classGroup = new Models.ClassGroup(group, contentPath);
+            }
+            else if (!classGroup.contentSource) {
+                classGroup.contentSource = contentPath;
+            }
+            classGroupMap.set(group, classGroup);
+        });
+        return classGroupMap;
+    }
+    /**
+     * The main routine for parsing our Apex files. Here we collect ApexDox comments, and create
+     * models of our top-level types (Classes and Enums) and their members (Enum values, Methods,
+     * Properties, Inner Classes, etc.).
+     *
+     * @param filePath The path of the file being parsed
+     */
+    parseFileContents(filePath, sourceUrl) {
+        const reader = new line_reader_1.default(filePath);
+        const cModels = new Array();
+        let line;
+        let comments = new Array();
+        let lineNum = 0, nestedCurlyBraceDepth = 0;
+        let commentsStarted = false, docBlockStarted = false;
+        let cModel, cModelParent;
+        if (filePath.endsWith('.cls')) {
+            // if (filePath.includes('ReferralRESTService')) {
+            //     console.log(filePath);
+            // }
+            while ((line = reader.readLine()) !== null) {
+                line = line.trim();
+                lineNum++;
+                // skip empty lines
+                if (!line.trim()) {
+                    continue;
+                }
+                // ignore anything after // style comments. this allows hiding
+                // of tags from ApexDox. However, don't ignore when line
+                // doesn't start with //, we want to preserve comments within
+                // @example code examples
+                let offset = line.indexOf('//');
+                if (offset === 0) {
+                    line = line.substring(0, offset);
+                    if (!line.trim()) {
+                        continue;
+                    }
+                }
+                // gather up our comments
+                if (line.startsWith('/*')) {
+                    commentsStarted = true;
+                    let commentEnded = false;
+                    if (line.startsWith(settings_1.default.COMMENT_OPEN)) {
+                        if (line.endsWith(settings_1.default.COMMENT_CLOSE)) {
+                            line = line.replace(settings_1.default.COMMENT_CLOSE, settings_1.default.DOC_BLOCK_BREAK);
+                            commentEnded = true;
+                        }
+                        comments.push(line);
+                        docBlockStarted = true;
+                    }
+                    if (line.endsWith(settings_1.default.COMMENT_CLOSE) || commentEnded) {
+                        commentsStarted = false;
+                        docBlockStarted = false;
+                    }
+                    continue;
+                }
+                if (commentsStarted && line.endsWith(settings_1.default.COMMENT_CLOSE)) {
+                    line = line.replace(settings_1.default.COMMENT_CLOSE, settings_1.default.DOC_BLOCK_BREAK);
+                    if (docBlockStarted) {
+                        comments.push(line);
+                        docBlockStarted = false;
+                    }
+                    commentsStarted = false;
+                    continue;
+                }
+                if (commentsStarted) {
+                    if (docBlockStarted) {
+                        comments.push(line);
+                    }
+                    continue;
+                }
+                // keep track of our nesting so we know which class we are in
+                const openCurlies = utils_1.default.countChars(line, '{');
+                const closeCurlies = utils_1.default.countChars(line, '}');
+                nestedCurlyBraceDepth += openCurlies;
+                nestedCurlyBraceDepth -= closeCurlies;
+                // if we are in a nested class, and we just got back to nesting level 1,
+                // then we are done with the nested class, and should set its props and methods.
+                if (nestedCurlyBraceDepth === 1 && openCurlies !== closeCurlies && cModels.length > 1 && cModel) {
+                    cModels.pop();
+                    cModel = array_utils_1.last(cModels);
+                    continue;
+                }
+                // ignore anything after an =. this avoids confusing properties with methods.
+                offset = line.indexOf('=');
+                if (offset > -1) {
+                    line = line.substring(0, offset);
+                }
+                // ignore anything after an '{' (if we're not dealing with an enum)
+                // this avoids confusing properties with methods.
+                offset = !utils_1.default.isEnum(line) ? line.indexOf('{') : -1;
+                if (offset > -1) {
+                    line = line.substring(0, offset);
+                }
+                // skip lines not dealing with scope that are not inner
+                // classes, interface methods, or (assumed to be) @isTest
+                if (utils_1.default.shouldSkipLine(line, cModel)) {
+                    continue;
+                }
+                // look for a class.
+                if (utils_1.default.isClassOrInterface(line)) {
+                    // create the new class
+                    const cModelNew = new Models.ClassModel(cModelParent, comments, line, lineNum, sourceUrl);
+                    cModelNew.setSource(reader.toContent());
+                    cModelNew.parseAnnotations(line, reader.peekPrevLine());
+                    comments = [];
+                    // keep track of the new class, as long as it wasn't a single liner {}
+                    // but handle not having any curlies on the class line!
+                    if (openCurlies === 0 || openCurlies !== closeCurlies) {
+                        cModels.push(cModelNew);
+                        cModel = cModelNew;
+                    }
+                    // add it to its parent (or track the parent)
+                    if (cModelParent) {
+                        cModelParent.addChildClass(cModelNew);
+                    }
+                    else {
+                        cModelParent = cModelNew;
+                    }
+                    continue;
+                }
+                // look for an enum
+                if (utils_1.default.isEnum(line)) {
+                    const startingLine = lineNum;
+                    // handle enums over multiple lines
+                    while (!line.includes('}')) {
+                        line += reader.readLine();
+                        lineNum++;
+                    }
+                    const eModel = new Models.EnumModel(comments, line, startingLine, sourceUrl);
+                    eModel.parseAnnotations(line, reader.peekPrevLine());
+                    // if no class models have been created, and we see an
+                    // enum, we must be dealing with a class level enum and
+                    // should return early, otherwise we're dealing with
+                    // an inner enum and should add to our class model.
+                    if (!cModel && cModels.length === 0) {
+                        return eModel;
+                    }
+                    else {
+                        cModel && cModel.enums.push(eModel);
+                        comments = [];
+                        continue;
+                    }
+                }
+                // look for a method
+                if (line.includes('(')) {
+                    const startingLine = lineNum;
+                    // handle methods over multiple lines.
+                    while (!line.includes(')')) {
+                        line += reader.readLine();
+                        lineNum++;
+                    }
+                    const className = cModel ? cModel.name : '';
+                    const mModel = new Models.MethodModel(comments, line, startingLine, className, sourceUrl);
+                    mModel.parseAnnotations(line, reader.peekPrevLine());
+                    cModel && cModel.methods.push(mModel);
+                    comments = [];
+                    continue;
+                }
+                // must be a property
+                const pModel = new Models.PropertyModel(comments, line, lineNum, sourceUrl);
+                pModel.parseAnnotations(line, reader.peekPrevLine());
+                cModel && cModel.properties.push(pModel);
+                comments = [];
+                continue;
+            }
+        }
+        else if (filePath.endsWith('.page') || filePath.endsWith('.component')) {
+            let name = filePath.split(/.*[/|\\]/)[1];
+            name = name.split('.')[0];
+            comments.push('/**');
+            comments.push('*');
+            comments.push('* @group Pages');
+            comments.push('@@BREAK@@');
+            lineNum = 1;
+            line = 'global class ' + name;
+            const cModelNew = new Models.ClassModel(cModelParent, comments, line, lineNum, sourceUrl);
+            cModelNew.setSource(reader.toContent());
+            cModelNew.parseAnnotations(line, reader.peekPrevLine());
+            cModelParent = cModelNew;
+        }
+        return cModelParent;
+    }
+}
+exports.default = ApexDoc;
+ApexDoc.description = 'Generate Apex API Documentation';
+ApexDoc.examples = [`Generate Apex API Documentation :\t$sfdx tffa:apexdoc `];
+ApexDoc.flagsConfig = {
+    sourcefolder: command_1.flags.directory({
+        char: 'd',
+        description: 'directory containing package metadata',
+        default: '.'
+    })
+};
+//# sourceMappingURL=apexdoc.js.map

package/lib/commands/tffa/apexdoc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apexdoc.js","sourceRoot":"","sources":["../../../src/commands/tffa/apexdoc.ts"],"names":[],"mappings":";AAAA;;IAEI;;;AAEJ,iDAAyD;AACzD,4EAAsD;AACtD,2CAA0D;AAE1D,kFAAkE;AAClE,6FAA4D;AAC5D,+BAAgC;AAChC,2CAAyC;AACzC,2FAA0D;AAC1D,+EAA+C;AAC/C,kEAAwD;AAExD,MAAqB,OAAQ,SAAQ,qBAAW;IAcvC,KAAK,CAAC,GAAG;QACd,MAAM,OAAO,GAAG,MAAM,kBAAW,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QACnE,IAAI;YACF,kBAAQ,CAAC,MAAM,GAAG,kBAAQ,CAAC,SAAS,CAAgB,kBAAO,CAAC,MAAM,CAAC,CAAC;YACpE,IAAI,CAAC,YAAY,CAAC,kBAAQ,CAAC,MAAM,CAAC,CAAC;SACpC;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YACf,MAAM,IAAI,gBAAS,CAAC,CAAC,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAC;SACpD;QAED,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;OAKG;IACK,YAAY,CAAC,MAAqB;QACxC,MAAM,YAAY,GAAG,wBAAW,CAAC,GAAG,EAAE,CAAC;QACvC,MAAM,WAAW,GAAG,IAAI,sBAAW,CAAC,MAAM,CAAC,eAAe,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;QACzF,MAAM,KAAK,GAAG,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;QACpF,MAAM,MAAM,GAAG,IAAI,GAAG,EAAgC,CAAC;QAEvD,4CAA4C;QAC5C,IAAI,YAAY,GAAG,CAAC,CAAC;QAErB,kCAAkC;QAClC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACpB,IAAI,CAAC,WAAW,GAAG,eAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAExC,MAAM,KAAK,GAAG,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;YAElE,IAAI,KAAK,EAAE;gBACT,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,KAAK,CAAC,CAAC;gBAC5C,YAAY,EAAE,CAAC;aAChB;QACH,CAAC,CAAC,CAAC;QAEH,8DAA8D;QAC9D,MAAM,kBAAkB,GAAG,CAAC,MAAM,CAAC,YAAY,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;QAClE,MAAM,aAAa,GAAG,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;QAEvD,4DAA4D;QAC5D,WAAW,CAAC,UAAU,CAAC,aAAa,EAAE,MAAM,EAAE,kBAAkB,CAAC,CAAC;QAElE,eAAe;QACf,MAAM,UAAU,GAAG,wBAAW,CAAC,GAAG,EAAE,CAAC;QACrC,MAAM,OAAO,GAAG,CAAC,CAAC,UAAU,GAAG,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAChE,OAAO,CAAC,IAAI,CAAC,sCAAsC,YAAY,wBAAwB,OAAO,IAAI,CAAC,CAAC;IACtG,CAAC;IAEO,mBAAmB,CAAC,MAAyC;QACnE,MAAM,aAAa,GAAmC,IAAI,GAAG,EAA6B,CAAC;QAE3F,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACrB,sDAAsD;YACtD,oDAAoD;YACpD,MAAM,KAAK,GAAG,KAAK,CAAC,SAAS,IAAI,eAAe,EAC9C,WAAW,GAAG,KAAK,CAAC,gBAAgB,CAAC;YAEvC,IAAI,UAAU,GAAG,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YAE1C,IAAI,CAAC,UAAU,EAAE;gBACf,UAAU,GAAG,IAAI,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;aACxD;iBAAM,IAAI,CAAC,UAAU,CAAC,aAAa,EAAE;gBACpC,UAAU,CAAC,aAAa,GAAG,WAAW,CAAC;aACxC;YAED,aAAa,CAAC,GAAG,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;QAEH,OAAO,aAAa,CAAC;IACvB,CAAC;IAED;;;;;;OAMG;IACK,iBAAiB,CAAC,QAAgB,EAAE,SAAyB;QACnE,MAAM,MAAM,GAAG,IAAI,qBAAU,CAAC,QAAQ,CAAC,CAAC;QACxC,MAAM,OAAO,GAAG,IAAI,KAAK,EAAqB,CAAC;QAE/C,IAAI,IAA0B,CAAC;QAC/B,IAAI,QAAQ,GAAG,IAAI,KAAK,EAAU,CAAC;QACnC,IAAI,OAAO,GAAG,CAAC,EACb,qBAAqB,GAAG,CAAC,CAAC;QAC5B,IAAI,eAAe,GAAG,KAAK,EACzB,eAAe,GAAG,KAAK,CAAC;QAC1B,IAAI,MAAiC,EAAE,YAAuC,CAAC;QAC/E,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;YAC7B,kDAAkD;YAClD,6BAA6B;YAC7B,IAAI;YACJ,OAAO,CAAC,IAAI,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,KAAK,IAAI,EAAE;gBAC1C,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;gBACnB,OAAO,EAAE,CAAC;gBAEV,mBAAmB;gBACnB,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE;oBAChB,SAAS;iBACV;gBAED,8DAA8D;gBAC9D,wDAAwD;gBACxD,6DAA6D;gBAC7D,yBAAyB;gBACzB,IAAI,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBAChC,IAAI,MAAM,KAAK,CAAC,EAAE;oBAChB,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;oBACjC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE;wBAChB,SAAS;qBACV;iBACF;gBAED,yBAAyB;gBACzB,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;oBACzB,eAAe,GAAG,IAAI,CAAC;oBACvB,IAAI,YAAY,GAAG,KAAK,CAAC;oBACzB,IAAI,IAAI,CAAC,UAAU,CAAC,kBAAQ,CAAC,YAAY,CAAC,EAAE;wBAC1C,IAAI,IAAI,CAAC,QAAQ,CAAC,kBAAQ,CAAC,aAAa,CAAC,EAAE;4BACzC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,kBAAQ,CAAC,aAAa,EAAE,kBAAQ,CAAC,eAAe,CAAC,CAAC;4BACtE,YAAY,GAAG,IAAI,CAAC;yBACrB;wBACD,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;wBACpB,eAAe,GAAG,IAAI,CAAC;qBACxB;oBACD,IAAI,IAAI,CAAC,QAAQ,CAAC,kBAAQ,CAAC,aAAa,CAAC,IAAI,YAAY,EAAE;wBACzD,eAAe,GAAG,KAAK,CAAC;wBACxB,eAAe,GAAG,KAAK,CAAC;qBACzB;oBACD,SAAS;iBACV;gBAED,IAAI,eAAe,IAAI,IAAI,CAAC,QAAQ,CAAC,kBAAQ,CAAC,aAAa,CAAC,EAAE;oBAC5D,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,kBAAQ,CAAC,aAAa,EAAE,kBAAQ,CAAC,eAAe,CAAC,CAAC;oBACtE,IAAI,eAAe,EAAE;wBACnB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;wBACpB,eAAe,GAAG,KAAK,CAAC;qBACzB;oBACD,eAAe,GAAG,KAAK,CAAC;oBACxB,SAAS;iBACV;gBAED,IAAI,eAAe,EAAE;oBACnB,IAAI,eAAe,EAAE;wBACnB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;qBACrB;oBACD,SAAS;iBACV;gBAED,6DAA6D;gBAC7D,MAAM,WAAW,GAAG,eAAK,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;gBAChD,MAAM,YAAY,GAAG,eAAK,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;gBACjD,qBAAqB,IAAI,WAAW,CAAC;gBACrC,qBAAqB,IAAI,YAAY,CAAC;gBAEtC,wEAAwE;gBACxE,gFAAgF;gBAChF,IAAI,qBAAqB,KAAK,CAAC,IAAI,WAAW,KAAK,YAAY,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,EAAE;oBAC/F,OAAO,CAAC,GAAG,EAAE,CAAC;oBACd,MAAM,GAAG,kBAAI,CAAC,OAAO,CAAC,CAAC;oBACvB,SAAS;iBACV;gBAED,6EAA6E;gBAC7E,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;gBAC3B,IAAI,MAAM,GAAG,CAAC,CAAC,EAAE;oBACf,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;iBAClC;gBAED,mEAAmE;gBACnE,iDAAiD;gBACjD,MAAM,GAAG,CAAC,eAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACtD,IAAI,MAAM,GAAG,CAAC,CAAC,EAAE;oBACf,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;iBAClC;gBAED,uDAAuD;gBACvD,yDAAyD;gBACzD,IAAI,eAAK,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE;oBACtC,SAAS;iBACV;gBAED,oBAAoB;gBACpB,IAAI,eAAK,CAAC,kBAAkB,CAAC,IAAI,CAAC,EAAE;oBAClC,uBAAuB;oBACvB,MAAM,SAAS,GAAsB,IAAI,MAAM,CAAC,UAAU,CAAC,YAAY,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;oBAC7G,SAAS,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;oBACxC,SAAS,CAAC,gBAAgB,CAAC,IAAI,EAAE,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC;oBACxD,QAAQ,GAAG,EAAE,CAAC;oBAEd,sEAAsE;oBACtE,uDAAuD;oBACvD,IAAI,WAAW,KAAK,CAAC,IAAI,WAAW,KAAK,YAAY,EAAE;wBACrD,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;wBACxB,MAAM,GAAG,SAAS,CAAC;qBACpB;oBAED,6CAA6C;oBAC7C,IAAI,YAAY,EAAE;wBAChB,YAAY,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;qBACvC;yBAAM;wBACL,YAAY,GAAG,SAAS,CAAC;qBAC1B;oBAED,SAAS;iBACV;gBAED,mBAAmB;gBACnB,IAAI,eAAK,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;oBACtB,MAAM,YAAY,GAAG,OAAO,CAAC;oBAE7B,mCAAmC;oBACnC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;wBAC1B,IAAI,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;wBAC1B,OAAO,EAAE,CAAC;qBACX;oBAED,MAAM,MAAM,GAAqB,IAAI,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC;oBAC/F,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC;oBAErD,sDAAsD;oBACtD,uDAAuD;oBACvD,oDAAoD;oBACpD,mDAAmD;oBACnD,IAAI,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE;wBACnC,OAAO,MAAM,CAAC;qBACf;yBAAM;wBACL,MAAM,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;wBACpC,QAAQ,GAAG,EAAE,CAAC;wBACd,SAAS;qBACV;iBACF;gBAED,oBAAoB;gBACpB,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;oBACtB,MAAM,YAAY,GAAG,OAAO,CAAC;oBAE7B,sCAAsC;oBACtC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;wBAC1B,IAAI,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;wBAC1B,OAAO,EAAE,CAAC;qBACX;oBAED,MAAM,SAAS,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;oBAC5C,MAAM,MAAM,GAAuB,IAAI,MAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,IAAI,EAAE,YAAY,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;oBAC9G,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC;oBACrD,MAAM,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;oBACtC,QAAQ,GAAG,EAAE,CAAC;oBACd,SAAS;iBACV;gBAED,qBAAqB;gBACrB,MAAM,MAAM,GAAyB,IAAI,MAAM,CAAC,aAAa,CAAC,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;gBAClG,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC;gBACrD,MAAM,IAAI,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBACzC,QAAQ,GAAG,EAAE,CAAC;gBACd,SAAS;aACV;SACF;aAAM,IAAI,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE;YACxE,IAAI,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;YACzC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;YAC1B,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACrB,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACnB,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;YAChC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAC3B,OAAO,GAAG,CAAC,CAAC;YACZ,IAAI,GAAG,eAAe,GAAG,IAAI,CAAC;YAE9B,MAAM,SAAS,GAAsB,IAAI,MAAM,CAAC,UAAU,CAAC,YAAY,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;YAC7G,SAAS,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;YACxC,SAAS,CAAC,gBAAgB,CAAC,IAAI,EAAE,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC;YACxD,YAAY,GAAG,SAAS,CAAC;SAC1B;QAED,OAA6B,YAAY,CAAC;IAC5C,CAAC;;AAvSH,0BAwSC;AAvSe,mBAAW,GAAG,iCAAiC,CAAC;AAEhD,gBAAQ,GAAG,CAAC,wDAAwD,CAAC,CAAC;AAGnE,mBAAW,GAAG;IAC7B,YAAY,EAAE,eAAK,CAAC,SAAS,CAAC;QAC5B,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,uCAAuC;QACpD,OAAO,EAAE,GAAG;KACb,CAAC;CACH,CAAC"}

package/lib/commands/tffa/ping.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Copyright (c) NCR Terafina
+ **/
 import { SfdxCommand } from '@salesforce/command';
 import { AnyJson } from '@salesforce/ts-types';
 export default class Ping extends SfdxCommand {

package/lib/commands/tffa/ping.js

@@ -1,5 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Copyright (c) NCR Terafina
+ **/
 const command_1 = require("@salesforce/command");
 const core_1 = require("@salesforce/core");
 // Initialize Messages with the current plugin directory

package/lib/commands/tffa/ping.js.map

@@ -1 +1 @@
-{"version":3,"file":"ping.js","sourceRoot":"","sources":["../../../src/commands/tffa/ping.ts"],"names":[],"mappings":";;AAAA,iDAAkD;AAClD,2CAA4C;AAG5C,wDAAwD;AACxD,eAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAE5C,iGAAiG;AACjG,mFAAmF;AACnF,MAAM,QAAQ,GAAG,eAAQ,CAAC,YAAY,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;AAE7E,MAAqB,IAAK,SAAQ,qBAAW;IASpC,KAAK,CAAC,GAAG;QACd,MAAM,YAAY,GAAG,MAAM,CAAC;QAE5B,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QAE1B,+CAA+C;QAC/C,OAAO,EAAE,YAAY,EAAE,CAAC;IAC1B,CAAC;;AAhBH,uBAiBC;AAhBe,gBAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC;AAExD,aAAQ,GAAG,CAAC,mBAAmB,CAAC,CAAC;AAEjC,SAAI,GAAG,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;AAEvB,gBAAW,GAAG,EAAE,CAAC"}
+{"version":3,"file":"ping.js","sourceRoot":"","sources":["../../../src/commands/tffa/ping.ts"],"names":[],"mappings":";;AAAA;;IAEI;AACJ,iDAAkD;AAClD,2CAA4C;AAG5C,wDAAwD;AACxD,eAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAE5C,iGAAiG;AACjG,mFAAmF;AACnF,MAAM,QAAQ,GAAG,eAAQ,CAAC,YAAY,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;AAE7E,MAAqB,IAAK,SAAQ,qBAAW;IASpC,KAAK,CAAC,GAAG;QACd,MAAM,YAAY,GAAG,MAAM,CAAC;QAE5B,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QAE1B,+CAA+C;QAC/C,OAAO,EAAE,YAAY,EAAE,CAAC;IAC1B,CAAC;;AAhBH,uBAiBC;AAhBe,gBAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC;AAExD,aAAQ,GAAG,CAAC,mBAAmB,CAAC,CAAC;AAEjC,SAAI,GAAG,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;AAEvB,gBAAW,GAAG,EAAE,CAAC"}

package/lib/commands/tffa/scan.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Copyright (c) NCR Terafina
+ **/
+import { flags, SfdxCommand } from '@salesforce/command';
+export default class Scan extends SfdxCommand {
+    static description: string;
+    static examples: string[];
+    minapi: number;
+    dir: string;
+    allowedListEnd: string[];
+    allowedISVTEViolations: string[];
+    classFiles: any[];
+    violations: any[];
+    allowedListStart: string[];
+    ignoreFiles: string[];
+    ignoreCZFiles: any[];
+    protected static flagsConfig: {
+        sourcefolder: flags.Discriminated<flags.Option<string>>;
+        mdoutfolder: flags.Discriminated<flags.Option<string>>;
+        format: flags.Discriminated<flags.Option<string>>;
+    };
+    run(): Promise<any>;
+    /**
+     * test file names as per conventions
+     */
+    private checkFileNameConvention;
+    /**
+     * test class files for filter
+     * @param {*} keywords
+     * @param {*} hint
+     */
+    private checkClassesForKeywords;
+    /**
+     * Using recursion, we find every file with the desired extention, even if its deeply nested in subfolders.
+     * @param {*} dir
+     * @param {*} ext
+     */
+    private getFilesInDirectory;
+    /**
+     * scan json files
+     */
+    private scanJSONFiles;
+    /**
+     * scan ISVTE plugin for quality rules
+     * @param {} convertedPath
+     */
+    private scanISVTEQuality;
+    /**
+     * print output
+     */
+    private printViolations;
+}