@cparra/apexdocs 2.24.0 → 2.25.0-alpha.1

package/lib/application/Apexdocs.js

@@ -1,77 +1,80 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Apexdocs = void 0;
-const apex_file_reader_1 = require("../service/apex-file-reader");
-const file_system_1 = require("../service/file-system");
-const apex_reflection_1 = require("@cparra/apex-reflection");
-const logger_1 = require("../util/logger");
-const manifest_factory_1 = require("../service/manifest-factory");
-const parser_1 = require("../service/parser");
-const settings_1 = require("../settings");
-const transpiler_1 = require("../transpiler/transpiler");
-const file_writer_1 = require("../service/file-writer");
-const error_logger_1 = require("../util/error-logger");
-const types_repository_1 = require("../model/types-repository");
-const factory_1 = require("../transpiler/factory");
-/**
- * Application entry-point to generate documentation out of Apex source files.
- */
-class Apexdocs {
-    /**
-     * Generates documentation out of Apex source files.
-     */
-    static generate() {
-        logger_1.Logger.log('Initializing...');
-        const fileBodies = apex_file_reader_1.ApexFileReader.processFiles(new file_system_1.DefaultFileSystem());
-        const manifest = (0, manifest_factory_1.createManifest)(new parser_1.RawBodyParser(fileBodies), this._reflectionWithLogger);
-        types_repository_1.TypesRepository.getInstance().populateAll(manifest.types);
-        const filteredTypes = this.filterByScopes(manifest);
-        types_repository_1.TypesRepository.getInstance().populateScoped(filteredTypes);
-        const processor = factory_1.TypeTranspilerFactory.get(settings_1.Settings.getInstance().targetGenerator);
-        transpiler_1.default.generate(filteredTypes, processor);
-        const generatedFiles = processor.fileBuilder().files();
-        const files = [];
-        file_writer_1.FileWriter.write(generatedFiles, (file) => {
-            logger_1.Logger.logSingle(`${file.name} processed.`, false, 'green', false);
-            files.push(file);
-        });
-        settings_1.Settings.getInstance().onAfterProcess(files);
-        // Error logging
-        error_logger_1.default.logErrors(filteredTypes);
-    }
-    static filterByScopes(manifest) {
-        let filteredTypes;
-        let filteredLogMessage;
-        if (settings_1.Settings.getInstance().config.targetGenerator !== 'openapi') {
-            filteredTypes = manifest.filteredByAccessModifierAndAnnotations(settings_1.Settings.getInstance().scope);
-            filteredLogMessage = `Filtered ${manifest.types.length - filteredTypes.length} file(s) based on scope: ${settings_1.Settings.getInstance().scope}`;
-        }
-        else {
-            // If we are dealing with an OpenApi generator, we ignore the passed in access modifiers, and instead
-            // we only keep classes annotated as @RestResource
-            filteredTypes = manifest.filteredByAccessModifierAndAnnotations([
-                'restresource',
-                'httpdelete',
-                'httpget',
-                'httppatch',
-                'httppost',
-                'httpput',
-            ]);
-            filteredLogMessage = `Filtered ${manifest.types.length - filteredTypes.length} file(s), only keeping classes annotated as @RestResource.`;
-        }
-        logger_1.Logger.clear();
-        logger_1.Logger.logSingle(filteredLogMessage, false, 'green', false);
-        logger_1.Logger.logSingle(`Creating documentation for ${filteredTypes.length} file(s)`, false, 'green', false);
-        return filteredTypes;
-    }
-}
-exports.Apexdocs = Apexdocs;
-Apexdocs._reflectionWithLogger = (apexBundle) => {
-    var _a;
-    const result = (0, apex_reflection_1.reflect)(apexBundle.rawTypeContent);
-    if (result.error) {
-        logger_1.Logger.error(`${apexBundle.filePath} - Parsing error ${(_a = result.error) === null || _a === void 0 ? void 0 : _a.message}`);
-    }
-    return result;
-};
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Apexdocs = void 0;
+const apex_file_reader_1 = require("../service/apex-file-reader");
+const file_system_1 = require("../service/file-system");
+const apex_reflection_1 = require("@cparra/apex-reflection");
+const logger_1 = require("../util/logger");
+const manifest_factory_1 = require("../service/manifest-factory");
+const parser_1 = require("../service/parser");
+const settings_1 = require("../settings");
+const transpiler_1 = __importDefault(require("../transpiler/transpiler"));
+const file_writer_1 = require("../service/file-writer");
+const error_logger_1 = __importDefault(require("../util/error-logger"));
+const types_repository_1 = require("../model/types-repository");
+const factory_1 = require("../transpiler/factory");
+/**
+ * Application entry-point to generate documentation out of Apex source files.
+ */
+class Apexdocs {
+    /**
+     * Generates documentation out of Apex source files.
+     */
+    static generate() {
+        logger_1.Logger.log('Initializing...');
+        const fileBodies = apex_file_reader_1.ApexFileReader.processFiles(new file_system_1.DefaultFileSystem());
+        const manifest = (0, manifest_factory_1.createManifest)(new parser_1.RawBodyParser(fileBodies), this._reflectionWithLogger);
+        types_repository_1.TypesRepository.getInstance().populateAll(manifest.types);
+        const filteredTypes = this.filterByScopes(manifest);
+        types_repository_1.TypesRepository.getInstance().populateScoped(filteredTypes);
+        const processor = factory_1.TypeTranspilerFactory.get(settings_1.Settings.getInstance().targetGenerator);
+        transpiler_1.default.generate(filteredTypes, processor);
+        const generatedFiles = processor.fileBuilder().files();
+        const files = [];
+        file_writer_1.FileWriter.write(generatedFiles, (file) => {
+            logger_1.Logger.logSingle(`${file.name} processed.`, false, 'green', false);
+            files.push(file);
+        });
+        settings_1.Settings.getInstance().onAfterProcess(files);
+        // Error logging
+        error_logger_1.default.logErrors(filteredTypes);
+    }
+    static filterByScopes(manifest) {
+        let filteredTypes;
+        let filteredLogMessage;
+        if (settings_1.Settings.getInstance().config.targetGenerator !== 'openapi') {
+            filteredTypes = manifest.filteredByAccessModifierAndAnnotations(settings_1.Settings.getInstance().scope);
+            filteredLogMessage = `Filtered ${manifest.types.length - filteredTypes.length} file(s) based on scope: ${settings_1.Settings.getInstance().scope}`;
+        }
+        else {
+            // If we are dealing with an OpenApi generator, we ignore the passed in access modifiers, and instead
+            // we only keep classes annotated as @RestResource
+            filteredTypes = manifest.filteredByAccessModifierAndAnnotations([
+                'restresource',
+                'httpdelete',
+                'httpget',
+                'httppatch',
+                'httppost',
+                'httpput',
+            ]);
+            filteredLogMessage = `Filtered ${manifest.types.length - filteredTypes.length} file(s), only keeping classes annotated as @RestResource.`;
+        }
+        logger_1.Logger.clear();
+        logger_1.Logger.logSingle(filteredLogMessage, false, 'green', false);
+        logger_1.Logger.logSingle(`Creating documentation for ${filteredTypes.length} file(s)`, false, 'green', false);
+        return filteredTypes;
+    }
+}
+exports.Apexdocs = Apexdocs;
+Apexdocs._reflectionWithLogger = (apexBundle) => {
+    var _a;
+    const result = (0, apex_reflection_1.reflect)(apexBundle.rawTypeContent);
+    if (result.error) {
+        logger_1.Logger.error(`${apexBundle.filePath} - Parsing error ${(_a = result.error) === null || _a === void 0 ? void 0 : _a.message}`);
+    }
+    return result;
+};
 //# sourceMappingURL=Apexdocs.js.map

package/lib/application/Apexdocs.js.map

@@ -1 +1 @@
-{"version":3,"file":"Apexdocs.js","sourceRoot":"","sources":["../../src/application/Apexdocs.ts"],"names":[],"mappings":";;;AAAA,kEAA6D;AAC7D,wDAA2D;AAC3D,6DAA0E;AAC1E,2CAAwC;AACxC,kEAA6D;AAC7D,8CAAkD;AAClD,0CAAmD;AACnD,yDAAkD;AAClD,wDAAoD;AACpD,uDAA+C;AAG/C,gEAA4D;AAC5D,mDAA8D;AAE9D;;GAEG;AACH,MAAa,QAAQ;IACnB;;OAEG;IACH,MAAM,CAAC,QAAQ;QACb,eAAM,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAC9B,MAAM,UAAU,GAAG,iCAAc,CAAC,YAAY,CAAC,IAAI,+BAAiB,EAAE,CAAC,CAAC;QACxE,MAAM,QAAQ,GAAG,IAAA,iCAAc,EAAC,IAAI,sBAAa,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAC3F,kCAAe,CAAC,WAAW,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC1D,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QACpD,kCAAe,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QAC5D,MAAM,SAAS,GAAG,+BAAqB,CAAC,GAAG,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,CAAC,CAAC;QACpF,oBAAU,CAAC,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;QAC9C,MAAM,cAAc,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC;QAEvD,MAAM,KAAK,GAAiB,EAAE,CAAC;QAC/B,wBAAU,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC,IAAgB,EAAE,EAAE;YACpD,eAAM,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,IAAI,aAAa,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;YACnE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnB,CAAC,CAAC,CAAC;QAEH,mBAAQ,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAE7C,gBAAgB;QAChB,sBAAW,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IACvC,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,QAAkB;QAC9C,IAAI,aAAqB,CAAC;QAC1B,IAAI,kBAAkB,CAAC;QACvB,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,eAAe,KAAK,SAAS,EAAE;YAC/D,aAAa,GAAG,QAAQ,CAAC,sCAAsC,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC;YAC9F,kBAAkB,GAAG,YAAY,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,MAAM,4BAC3E,mBAAQ,CAAC,WAAW,EAAE,CAAC,KACzB,EAAE,CAAC;SACJ;aAAM;YACL,qGAAqG;YACrG,kDAAkD;YAClD,aAAa,GAAG,QAAQ,CAAC,sCAAsC,CAAC;gBAC9D,cAAc;gBACd,YAAY;gBACZ,SAAS;gBACT,WAAW;gBACX,UAAU;gBACV,SAAS;aACV,CAAC,CAAC;YACH,kBAAkB,GAAG,YACnB,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,MACxC,4DAA4D,CAAC;SAC9D;QACD,eAAM,CAAC,KAAK,EAAE,CAAC;QAEf,eAAM,CAAC,SAAS,CAAC,kBAAkB,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QAC5D,eAAM,CAAC,SAAS,CAAC,8BAA8B,aAAa,CAAC,MAAM,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QACtG,OAAO,aAAa,CAAC;IACvB,CAAC;;AAvDH,4BAgEC;AAPQ,8BAAqB,GAAG,CAAC,UAAsB,EAAoB,EAAE;;IAC1E,MAAM,MAAM,GAAG,IAAA,yBAAO,EAAC,UAAU,CAAC,cAAc,CAAC,CAAC;IAClD,IAAI,MAAM,CAAC,KAAK,EAAE;QAChB,eAAM,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,QAAQ,oBAAoB,MAAA,MAAM,CAAC,KAAK,0CAAE,OAAO,EAAE,CAAC,CAAC;KACjF;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}
+{"version":3,"file":"Apexdocs.js","sourceRoot":"","sources":["../../src/application/Apexdocs.ts"],"names":[],"mappings":";;;;;;AAAA,kEAA6D;AAC7D,wDAA2D;AAC3D,6DAA0E;AAC1E,2CAAwC;AACxC,kEAA6D;AAC7D,8CAAkD;AAClD,0CAAmD;AACnD,0EAAkD;AAClD,wDAAoD;AACpD,wEAA+C;AAG/C,gEAA4D;AAC5D,mDAA8D;AAE9D;;GAEG;AACH,MAAa,QAAQ;IACnB;;OAEG;IACH,MAAM,CAAC,QAAQ;QACb,eAAM,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAC9B,MAAM,UAAU,GAAG,iCAAc,CAAC,YAAY,CAAC,IAAI,+BAAiB,EAAE,CAAC,CAAC;QACxE,MAAM,QAAQ,GAAG,IAAA,iCAAc,EAAC,IAAI,sBAAa,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAC3F,kCAAe,CAAC,WAAW,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC1D,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QACpD,kCAAe,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QAC5D,MAAM,SAAS,GAAG,+BAAqB,CAAC,GAAG,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,CAAC,CAAC;QACpF,oBAAU,CAAC,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;QAC9C,MAAM,cAAc,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC;QAEvD,MAAM,KAAK,GAAiB,EAAE,CAAC;QAC/B,wBAAU,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC,IAAgB,EAAE,EAAE;YACpD,eAAM,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,IAAI,aAAa,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;YACnE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnB,CAAC,CAAC,CAAC;QAEH,mBAAQ,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAE7C,gBAAgB;QAChB,sBAAW,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IACvC,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,QAAkB;QAC9C,IAAI,aAAqB,CAAC;QAC1B,IAAI,kBAAkB,CAAC;QACvB,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YAChE,aAAa,GAAG,QAAQ,CAAC,sCAAsC,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC;YAC9F,kBAAkB,GAAG,YAAY,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,MAAM,4BAC3E,mBAAQ,CAAC,WAAW,EAAE,CAAC,KACzB,EAAE,CAAC;QACL,CAAC;aAAM,CAAC;YACN,qGAAqG;YACrG,kDAAkD;YAClD,aAAa,GAAG,QAAQ,CAAC,sCAAsC,CAAC;gBAC9D,cAAc;gBACd,YAAY;gBACZ,SAAS;gBACT,WAAW;gBACX,UAAU;gBACV,SAAS;aACV,CAAC,CAAC;YACH,kBAAkB,GAAG,YACnB,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,MACxC,4DAA4D,CAAC;QAC/D,CAAC;QACD,eAAM,CAAC,KAAK,EAAE,CAAC;QAEf,eAAM,CAAC,SAAS,CAAC,kBAAkB,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QAC5D,eAAM,CAAC,SAAS,CAAC,8BAA8B,aAAa,CAAC,MAAM,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QACtG,OAAO,aAAa,CAAC;IACvB,CAAC;;AAvDH,4BAgEC;AAPQ,8BAAqB,GAAG,CAAC,UAAsB,EAAoB,EAAE;;IAC1E,MAAM,MAAM,GAAG,IAAA,yBAAO,EAAC,UAAU,CAAC,cAAc,CAAC,CAAC;IAClD,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,eAAM,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,QAAQ,oBAAoB,MAAA,MAAM,CAAC,KAAK,0CAAE,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}

package/lib/cli/generate.d.ts

@@ -1,2 +1,2 @@
-#!/usr/bin/env node
-export {};
+#!/usr/bin/env node
+export {};

package/lib/cli/generate.js

@@ -1,131 +1,157 @@
-#!/usr/bin/env node
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const yargs = require("yargs");
-const settings_1 = require("../settings");
-const Apexdocs_1 = require("../application/Apexdocs");
-const cosmiconfig_1 = require("cosmiconfig");
-const result = (0, cosmiconfig_1.cosmiconfig)('apexdocs').search();
-result.then((config) => {
-    var _a, _b, _c;
-    yargs.config(config === null || config === void 0 ? void 0 : config.config);
-    let argv = yargs.options({
-        sourceDir: {
-            type: 'string',
-            alias: 's',
-            demandOption: true,
-            describe: 'The directory location which contains your apex .cls classes.',
-        },
-        targetDir: {
-            type: 'string',
-            alias: 't',
-            default: './docs/',
-            describe: 'The directory location where documentation will be generated to.',
-        },
-        recursive: {
-            type: 'boolean',
-            alias: 'r',
-            default: true,
-            describe: 'Whether .cls classes will be searched for recursively in the directory provided.',
-        },
-        scope: {
-            type: 'array',
-            alias: 'p',
-            default: ['global'],
-            describe: 'A list of scopes to document. Values should be separated by a space, e.g --scope global public namespaceaccessible. ' +
-                'Annotations are supported and should be passed lowercased and without the @ symbol, e.g. namespaceaccessible auraenabled. ' +
-                'Note that this setting is ignored if generating an OpenApi REST specification since that looks for classes annotated with @RestResource.',
-        },
-        targetGenerator: {
-            type: 'string',
-            alias: 'g',
-            default: 'jekyll',
-            choices: ['jekyll', 'docsify', 'plain-markdown', 'openapi'],
-            describe: 'Define the static file generator for which the documents will be created. ' +
-                'Currently supports jekyll, docsify, plain markdown, and OpenAPI v3.1.0.',
-        },
-        indexOnly: {
-            type: 'boolean',
-            default: false,
-            describe: 'Defines whether only the index file should be generated.',
-        },
-        defaultGroupName: {
-            type: 'string',
-            default: 'Miscellaneous',
-            describe: 'Defines the @group name to be used when a file does not specify it.',
-        },
-        sanitizeHtml: {
-            type: 'boolean',
-            default: true,
-            describe: 'When on, any special character within your ApexDocs is converted into its HTML code representation. ' +
-                'This is specially useful when generic objects are described within the docs, e.g. "List< Foo>", "Map<Foo, Bar>" ' +
-                'because otherwise the content within < and > would be treated as HTML tags and not shown in the output. ' +
-                'Content in @example blocks are never sanitized.',
-        },
-        openApiTitle: {
-            type: 'string',
-            default: 'Apex REST Api',
-            describe: 'If using "openapi" as the target generator, this allows you to specify the OpenApi title value.',
-        },
-        title: {
-            type: 'string',
-            describe: "If this allows you to specify the title of the generated documentation's home file.",
-            default: 'Classes',
-        },
-        namespace: {
-            type: 'string',
-            describe: 'The package namespace, if any. If this value is provided the namespace will be added as a prefix to all of the parsed files. ' +
-                "If generating an OpenApi definition, it will be added to the file's Server Url.",
-        },
-        openApiFileName: {
-            type: 'string',
-            describe: 'If using "openapi" as the target generator, this allows you to specify the name of the output file.',
-            default: 'openapi',
-        },
-        sortMembersAlphabetically: {
-            type: 'boolean',
-            describe: 'Whether to sort members alphabetically.',
-            default: false,
-        },
-        includeMetadata: {
-            type: 'boolean',
-            describe: "Whether to include the file's meta.xml information: Whether it is active and and the API version",
-            default: false,
-        },
-        documentationRootDir: {
-            type: 'string',
-            describe: 'Allows you to specify the root documentation directory where the files are being generated. This can be helpful when embedding the generated docs into an existing site so that the links are generated correctly.',
-        },
-    }).argv;
-    if (config) {
-        argv = Object.assign(Object.assign({}, config.config), argv);
-    }
-    settings_1.Settings.build({
-        sourceDirectory: argv.sourceDir,
-        recursive: argv.recursive,
-        scope: argv.scope,
-        outputDir: argv.targetDir,
-        targetGenerator: argv.targetGenerator,
-        indexOnly: argv.indexOnly,
-        defaultGroupName: argv.defaultGroupName,
-        sanitizeHtml: argv.sanitizeHtml,
-        openApiTitle: argv.openApiTitle,
-        title: argv.title,
-        namespace: argv.namespace,
-        openApiFileName: argv.openApiFileName,
-        sortMembersAlphabetically: argv.sortMembersAlphabetically,
-        includeMetadata: argv.includeMetadata,
-        rootDir: argv.documentationRootDir,
-        onAfterProcess: (_a = config === null || config === void 0 ? void 0 : config.config) === null || _a === void 0 ? void 0 : _a.onAfterProcess,
-        onBeforeFileWrite: (_b = config === null || config === void 0 ? void 0 : config.config) === null || _b === void 0 ? void 0 : _b.onBeforeFileWrite,
-        frontMatterHeader: (_c = config === null || config === void 0 ? void 0 : config.config) === null || _c === void 0 ? void 0 : _c.frontMatterHeader,
-    });
-    try {
-        Apexdocs_1.Apexdocs.generate();
-    }
-    catch (error) {
-        console.error(error);
-        process.exit(1);
-    }
-});
+#!/usr/bin/env node
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const yargs = __importStar(require("yargs"));
+const settings_1 = require("../settings");
+const Apexdocs_1 = require("../application/Apexdocs");
+const cosmiconfig_1 = require("cosmiconfig");
+const result = (0, cosmiconfig_1.cosmiconfig)('apexdocs').search();
+result.then((config) => {
+    var _a, _b, _c;
+    yargs.config(config === null || config === void 0 ? void 0 : config.config);
+    let argv = yargs
+        .options({
+        sourceDir: {
+            type: 'string',
+            alias: 's',
+            demandOption: true,
+            describe: 'The directory location which contains your apex .cls classes.',
+        },
+        targetDir: {
+            type: 'string',
+            alias: 't',
+            default: './docs/',
+            describe: 'The directory location where documentation will be generated to.',
+        },
+        recursive: {
+            type: 'boolean',
+            alias: 'r',
+            default: true,
+            describe: 'Whether .cls classes will be searched for recursively in the directory provided.',
+        },
+        scope: {
+            type: 'string',
+            array: true,
+            alias: 'p',
+            default: ['global'],
+            describe: 'A list of scopes to document. Values should be separated by a space, e.g --scope global public namespaceaccessible. ' +
+                'Annotations are supported and should be passed lowercased and without the @ symbol, e.g. namespaceaccessible auraenabled. ' +
+                'Note that this setting is ignored if generating an OpenApi REST specification since that looks for classes annotated with @RestResource.',
+        },
+        targetGenerator: {
+            type: 'string',
+            alias: 'g',
+            default: 'jekyll',
+            choices: ['jekyll', 'docsify', 'plain-markdown', 'openapi'],
+            describe: 'Define the static file generator for which the documents will be created. ' +
+                'Currently supports jekyll, docsify, plain markdown, and OpenAPI v3.1.0.',
+        },
+        indexOnly: {
+            type: 'boolean',
+            default: false,
+            describe: 'Defines whether only the index file should be generated.',
+        },
+        defaultGroupName: {
+            type: 'string',
+            default: 'Miscellaneous',
+            describe: 'Defines the @group name to be used when a file does not specify it.',
+        },
+        sanitizeHtml: {
+            type: 'boolean',
+            default: true,
+            describe: 'When on, any special character within your ApexDocs is converted into its HTML code representation. ' +
+                'This is specially useful when generic objects are described within the docs, e.g. "List< Foo>", "Map<Foo, Bar>" ' +
+                'because otherwise the content within < and > would be treated as HTML tags and not shown in the output. ' +
+                'Content in @example blocks are never sanitized.',
+        },
+        openApiTitle: {
+            type: 'string',
+            default: 'Apex REST Api',
+            describe: 'If using "openapi" as the target generator, this allows you to specify the OpenApi title value.',
+        },
+        title: {
+            type: 'string',
+            describe: "If this allows you to specify the title of the generated documentation's home file.",
+            default: 'Classes',
+        },
+        namespace: {
+            type: 'string',
+            describe: 'The package namespace, if any. If this value is provided the namespace will be added as a prefix to all of the parsed files. ' +
+                "If generating an OpenApi definition, it will be added to the file's Server Url.",
+        },
+        openApiFileName: {
+            type: 'string',
+            describe: 'If using "openapi" as the target generator, this allows you to specify the name of the output file.',
+            default: 'openapi',
+        },
+        sortMembersAlphabetically: {
+            type: 'boolean',
+            describe: 'Whether to sort members alphabetically.',
+            default: false,
+        },
+        includeMetadata: {
+            type: 'boolean',
+            describe: "Whether to include the file's meta.xml information: Whether it is active and and the API version",
+            default: false,
+        },
+        documentationRootDir: {
+            type: 'string',
+            describe: 'Allows you to specify the root documentation directory where the files are being generated. This can be helpful when embedding the generated docs into an existing site so that the links are generated correctly.',
+        },
+    })
+        .parseSync();
+    if (config) {
+        argv = Object.assign(Object.assign({}, config.config), argv);
+    }
+    settings_1.Settings.build({
+        sourceDirectory: argv.sourceDir,
+        recursive: argv.recursive,
+        scope: argv.scope,
+        outputDir: argv.targetDir,
+        targetGenerator: argv.targetGenerator,
+        indexOnly: argv.indexOnly,
+        defaultGroupName: argv.defaultGroupName,
+        sanitizeHtml: argv.sanitizeHtml,
+        openApiTitle: argv.openApiTitle,
+        title: argv.title,
+        namespace: argv.namespace,
+        openApiFileName: argv.openApiFileName,
+        sortMembersAlphabetically: argv.sortMembersAlphabetically,
+        includeMetadata: argv.includeMetadata,
+        rootDir: argv.documentationRootDir,
+        onAfterProcess: (_a = config === null || config === void 0 ? void 0 : config.config) === null || _a === void 0 ? void 0 : _a.onAfterProcess,
+        onBeforeFileWrite: (_b = config === null || config === void 0 ? void 0 : config.config) === null || _b === void 0 ? void 0 : _b.onBeforeFileWrite,
+        frontMatterHeader: (_c = config === null || config === void 0 ? void 0 : config.config) === null || _c === void 0 ? void 0 : _c.frontMatterHeader,
+    });
+    try {
+        Apexdocs_1.Apexdocs.generate();
+    }
+    catch (error) {
+        console.error(error);
+        process.exit(1);
+    }
+});
 //# sourceMappingURL=generate.js.map

package/lib/cli/generate.js.map

@@ -1 +1 @@
-{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../src/cli/generate.ts"],"names":[],"mappings":";;;AACA,+BAA+B;AAE/B,0CAAuC;AACvC,sDAAmD;AAEnD,6CAA0C;AAE1C,MAAM,MAAM,GAAG,IAAA,yBAAW,EAAC,UAAU,CAAC,CAAC,MAAM,EAAE,CAAC;AAChD,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;;IACrB,KAAK,CAAC,MAAM,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,CAAC,CAAC;IAC7B,IAAI,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC;QACvB,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,YAAY,EAAE,IAAI;YAClB,QAAQ,EAAE,+DAA+D;SAC1E;QACD,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,SAAS;YAClB,QAAQ,EAAE,kEAAkE;SAC7E;QACD,SAAS,EAAE;YACT,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,kFAAkF;SAC7F;QACD,KAAK,EAAE;YACL,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,CAAC,QAAQ,CAAC;YACnB,QAAQ,EACN,sHAAsH;gBACtH,4HAA4H;gBAC5H,0IAA0I;SAC7I;QACD,eAAe,EAAE;YACf,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,QAAQ;YACjB,OAAO,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,gBAAgB,EAAE,SAAS,CAAC;YAC3D,QAAQ,EACN,4EAA4E;gBAC5E,yEAAyE;SAC5E;QACD,SAAS,EAAE;YACT,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,KAAK;YACd,QAAQ,EAAE,0DAA0D;SACrE;QACD,gBAAgB,EAAE;YAChB,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,eAAe;YACxB,QAAQ,EAAE,qEAAqE;SAChF;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;YACb,QAAQ,EACN,sGAAsG;gBACtG,kHAAkH;gBAClH,0GAA0G;gBAC1G,iDAAiD;SACpD;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,eAAe;YACxB,QAAQ,EAAE,iGAAiG;SAC5G;QACD,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,qFAAqF;YAC/F,OAAO,EAAE,SAAS;SACnB;QACD,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,QAAQ,EACN,+HAA+H;gBAC/H,iFAAiF;SACpF;QACD,eAAe,EAAE;YACf,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,qGAAqG;YAC/G,OAAO,EAAE,SAAS;SACnB;QACD,yBAAyB,EAAE;YACzB,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,yCAAyC;YACnD,OAAO,EAAE,KAAK;SACf;QACD,eAAe,EAAE;YACf,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,kGAAkG;YAC5G,OAAO,EAAE,KAAK;SACf;QACD,oBAAoB,EAAE;YACpB,IAAI,EAAE,QAAQ;YACd,QAAQ,EACN,oNAAoN;SACvN;KACF,CAAC,CAAC,IAAI,CAAC;IAER,IAAI,MAAM,EAAE;QACV,IAAI,mCAAQ,MAAM,CAAC,MAAM,GAAK,IAAI,CAAE,CAAC;KACtC;IAED,mBAAQ,CAAC,KAAK,CAAC;QACb,eAAe,EAAE,IAAI,CAAC,SAAS;QAC/B,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,eAAe,EAAE,IAAI,CAAC,eAAmC;QACzD,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;QACvC,YAAY,EAAE,IAAI,CAAC,YAAY;QAC/B,YAAY,EAAE,IAAI,CAAC,YAAY;QAC/B,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,eAAe,EAAE,IAAI,CAAC,eAAe;QACrC,yBAAyB,EAAE,IAAI,CAAC,yBAAyB;QACzD,eAAe,EAAE,IAAI,CAAC,eAAe;QACrC,OAAO,EAAE,IAAI,CAAC,oBAAoB;QAClC,cAAc,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,cAAc;QAC9C,iBAAiB,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,iBAAiB;QACpD,iBAAiB,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,iBAAiB;KACrD,CAAC,CAAC;IAEH,IAAI;QACF,mBAAQ,CAAC,QAAQ,EAAE,CAAC;KACrB;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;AACH,CAAC,CAAC,CAAC"}
+{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../src/cli/generate.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AACA,6CAA+B;AAE/B,0CAAuC;AACvC,sDAAmD;AAEnD,6CAA0C;AAE1C,MAAM,MAAM,GAAG,IAAA,yBAAW,EAAC,UAAU,CAAC,CAAC,MAAM,EAAE,CAAC;AAChD,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;;IACrB,KAAK,CAAC,MAAM,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,CAAC,CAAC;IAC7B,IAAI,IAAI,GAAG,KAAK;SACb,OAAO,CAAC;QACP,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,YAAY,EAAE,IAAI;YAClB,QAAQ,EAAE,+DAA+D;SAC1E;QACD,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,SAAS;YAClB,QAAQ,EAAE,kEAAkE;SAC7E;QACD,SAAS,EAAE;YACT,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,kFAAkF;SAC7F;QACD,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,IAAI;YACX,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,CAAC,QAAQ,CAAC;YACnB,QAAQ,EACN,sHAAsH;gBACtH,4HAA4H;gBAC5H,0IAA0I;SAC7I;QACD,eAAe,EAAE;YACf,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,QAAQ;YACjB,OAAO,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,gBAAgB,EAAE,SAAS,CAAC;YAC3D,QAAQ,EACN,4EAA4E;gBAC5E,yEAAyE;SAC5E;QACD,SAAS,EAAE;YACT,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,KAAK;YACd,QAAQ,EAAE,0DAA0D;SACrE;QACD,gBAAgB,EAAE;YAChB,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,eAAe;YACxB,QAAQ,EAAE,qEAAqE;SAChF;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;YACb,QAAQ,EACN,sGAAsG;gBACtG,kHAAkH;gBAClH,0GAA0G;gBAC1G,iDAAiD;SACpD;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,eAAe;YACxB,QAAQ,EAAE,iGAAiG;SAC5G;QACD,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,qFAAqF;YAC/F,OAAO,EAAE,SAAS;SACnB;QACD,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,QAAQ,EACN,+HAA+H;gBAC/H,iFAAiF;SACpF;QACD,eAAe,EAAE;YACf,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,qGAAqG;YAC/G,OAAO,EAAE,SAAS;SACnB;QACD,yBAAyB,EAAE;YACzB,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,yCAAyC;YACnD,OAAO,EAAE,KAAK;SACf;QACD,eAAe,EAAE;YACf,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,kGAAkG;YAC5G,OAAO,EAAE,KAAK;SACf;QACD,oBAAoB,EAAE;YACpB,IAAI,EAAE,QAAQ;YACd,QAAQ,EACN,oNAAoN;SACvN;KACF,CAAC;SACD,SAAS,EAAE,CAAC;IAEf,IAAI,MAAM,EAAE,CAAC;QACX,IAAI,mCAAQ,MAAM,CAAC,MAAM,GAAK,IAAI,CAAE,CAAC;IACvC,CAAC;IAED,mBAAQ,CAAC,KAAK,CAAC;QACb,eAAe,EAAE,IAAI,CAAC,SAAS;QAC/B,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,eAAe,EAAE,IAAI,CAAC,eAAmC;QACzD,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;QACvC,YAAY,EAAE,IAAI,CAAC,YAAY;QAC/B,YAAY,EAAE,IAAI,CAAC,YAAY;QAC/B,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,eAAe,EAAE,IAAI,CAAC,eAAe;QACrC,yBAAyB,EAAE,IAAI,CAAC,yBAAyB;QACzD,eAAe,EAAE,IAAI,CAAC,eAAe;QACrC,OAAO,EAAE,IAAI,CAAC,oBAAoB;QAClC,cAAc,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,cAAc;QAC9C,iBAAiB,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,iBAAiB;QACpD,iBAAiB,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,iBAAiB;KACrD,CAAC,CAAC;IAEH,IAAI,CAAC;QACH,mBAAQ,CAAC,QAAQ,EAAE,CAAC;IACtB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC,CAAC,CAAC"}

package/lib/core/generate-docs.d.ts

@@ -0,0 +1,23 @@
+import { Type } from '@cparra/apex-reflection';
+import * as E from 'fp-ts/Either';
+export declare const documentType: (type: Type, linkGenerator: import("../adapters/references").GetRenderableContentByTypeName, namespace?: string | undefined) => string;
+export type DocumentationBundle = {
+    format: 'markdown';
+    referenceGuide: string;
+    docs: DocOutput[];
+};
+type DocumentationConfig = {
+    scope: string[];
+    outputDir: string;
+    namespace?: string;
+    sortMembersAlphabetically?: boolean;
+    defaultGroupName: string;
+    referenceGuideTemplate: string;
+};
+type DocOutput = {
+    docContents: string;
+    typeName: string;
+    type: 'class' | 'interface' | 'enum';
+};
+export declare function generateDocs(input: string[], config?: Partial<DocumentationConfig>): E.Either<string[], DocumentationBundle>;
+export {};