@cparra/apexdocs 3.17.0 → 3.17.1-beta.0

package/dist/cli/generate.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 'use strict';
 
-var logger$1 = require('../logger-Cr1iCXZc.js');
+var Apexdocs = require('../Apexdocs-ChhmlY0h.js');
 var cosmiconfig = require('cosmiconfig');
 var yargs = require('yargs');
 var E = require('fp-ts/Either');
@@ -24,9 +24,9 @@ require('fp-ts/boolean');
 require('fp-ts/Array');
 require('fs');
 require('fp-ts/lib/TaskEither');
+require('chalk');
 require('minimatch');
 require('@salesforce/source-deploy-retrieve');
-require('chalk');
 
 function _interopNamespaceDefault(e) {
   var n = Object.create(null);
@@ -79,42 +79,42 @@ const markdownOptions = {
   targetDir: {
     type: "string",
     alias: "t",
-    default: logger$1.markdownDefaults.targetDir,
+    default: Apexdocs.markdownDefaults.targetDir,
     describe: "The directory location where documentation will be generated to."
   },
   scope: {
     type: "string",
     array: true,
     alias: "p",
-    default: logger$1.markdownDefaults.scope,
+    default: Apexdocs.markdownDefaults.scope,
     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."
   },
   customObjectVisibility: {
     type: "string",
     array: true,
     alias: "v",
-    default: logger$1.markdownDefaults.customObjectVisibility,
+    default: Apexdocs.markdownDefaults.customObjectVisibility,
     choices: ["public", "protected", "packageprotected"],
     describe: "Controls which custom objects are documented. Values should be separated by a space."
   },
   defaultGroupName: {
     type: "string",
-    default: logger$1.markdownDefaults.defaultGroupName,
+    default: Apexdocs.markdownDefaults.defaultGroupName,
     describe: "Defines the @group name to be used when a file does not specify it."
   },
   customObjectsGroupName: {
     type: "string",
-    default: logger$1.markdownDefaults.customObjectsGroupName,
+    default: Apexdocs.markdownDefaults.customObjectsGroupName,
     describe: "The name under which custom objects will be grouped in the Reference Guide"
   },
   triggersGroupName: {
     type: "string",
-    default: logger$1.markdownDefaults.triggersGroupName,
+    default: Apexdocs.markdownDefaults.triggersGroupName,
     describe: "The name under which triggers will be grouped in the Reference Guide"
   },
   lwcGroupName: {
     type: "string",
-    default: logger$1.markdownDefaults.lwcGroupName,
+    default: Apexdocs.markdownDefaults.lwcGroupName,
     describe: "The name under which Lightning Web Components will be grouped in the Reference Guide"
   },
   namespace: {
@@ -124,28 +124,28 @@ const markdownOptions = {
   sortAlphabetically: {
     type: "boolean",
     describe: "Whether to sort files and members alphabetically.",
-    default: logger$1.markdownDefaults.sortAlphabetically
+    default: Apexdocs.markdownDefaults.sortAlphabetically
   },
   includeMetadata: {
     type: "boolean",
     describe: "Whether to include the file's meta.xml information: Whether it is active and and the API version",
-    default: logger$1.markdownDefaults.includeMetadata
+    default: Apexdocs.markdownDefaults.includeMetadata
   },
   linkingStrategy: {
     type: "string",
     describe: "The strategy to use when linking to other documentation pages.",
     choices: ["relative", "no-link", "none"],
-    default: logger$1.markdownDefaults.linkingStrategy
+    default: Apexdocs.markdownDefaults.linkingStrategy
   },
   referenceGuideTitle: {
     type: "string",
     describe: "The title of the reference guide.",
-    default: logger$1.markdownDefaults.referenceGuideTitle
+    default: Apexdocs.markdownDefaults.referenceGuideTitle
   },
   includeFieldSecurityMetadata: {
     type: "boolean",
     describe: "Whether to include the compliance category and security classification for fields in the generated files.",
-    default: logger$1.markdownDefaults.includeFieldSecurityMetadata
+    default: Apexdocs.markdownDefaults.includeFieldSecurityMetadata
   },
   includeInlineHelpTextMetadata: {
     type: "boolean",
@@ -154,17 +154,17 @@ const markdownOptions = {
   experimentalLwcSupport: {
     type: "boolean",
     describe: "Enable experimental support for documenting Lightning Web Components (LWC).",
-    default: logger$1.markdownDefaults.experimentalLwcSupport
+    default: Apexdocs.markdownDefaults.experimentalLwcSupport
   },
   parallelReflection: {
     type: "boolean",
     describe: "Parallelize CPU-heavy reflection via worker threads.",
-    default: logger$1.markdownDefaults.parallelReflection
+    default: Apexdocs.markdownDefaults.parallelReflection
   },
   parallelReflectionMaxWorkers: {
     type: "number",
     describe: "Maximum number of worker threads to use for parallel reflection. Defaults to a reasonable value based on CPU count.",
-    default: logger$1.markdownDefaults.parallelReflectionMaxWorkers
+    default: Apexdocs.markdownDefaults.parallelReflectionMaxWorkers
   }
 };
 
@@ -200,12 +200,12 @@ const openApiOptions = {
   targetDir: {
     type: "string",
     alias: "t",
-    default: logger$1.openApiDefaults.targetDir,
+    default: Apexdocs.openApiDefaults.targetDir,
     describe: "The directory location where the OpenApi file will be generated."
   },
   fileName: {
     type: "string",
-    default: logger$1.openApiDefaults.fileName,
+    default: Apexdocs.openApiDefaults.fileName,
     describe: "The name of the OpenApi file to be generated."
   },
   namespace: {
@@ -214,23 +214,23 @@ const openApiOptions = {
   },
   title: {
     type: "string",
-    default: logger$1.openApiDefaults.title,
+    default: Apexdocs.openApiDefaults.title,
     describe: "The title of the OpenApi file."
   },
   apiVersion: {
     type: "string",
-    default: logger$1.openApiDefaults.apiVersion,
+    default: Apexdocs.openApiDefaults.apiVersion,
     describe: "The version of the OpenApi file."
   },
   parallelReflection: {
     type: "boolean",
     describe: "Parallelize CPU-heavy reflection via worker threads.",
-    default: logger$1.openApiDefaults.parallelReflection
+    default: Apexdocs.openApiDefaults.parallelReflection
   },
   parallelReflectionMaxWorkers: {
     type: "number",
     describe: "Maximum number of worker threads to use for parallel reflection. Defaults to a reasonable value based on CPU count.",
-    default: logger$1.openApiDefaults.parallelReflectionMaxWorkers
+    default: Apexdocs.openApiDefaults.parallelReflectionMaxWorkers
   }
 };
 
@@ -249,12 +249,12 @@ const changeLogOptions = {
   parallelReflection: {
     type: "boolean",
     describe: "Parallelize CPU-heavy reflection via worker threads.",
-    default: logger$1.markdownDefaults.parallelReflection
+    default: Apexdocs.markdownDefaults.parallelReflection
   },
   parallelReflectionMaxWorkers: {
     type: "number",
     describe: "Maximum number of worker threads to use for parallel reflection. Defaults to a reasonable value based on CPU count.",
-    default: logger$1.markdownDefaults.parallelReflectionMaxWorkers
+    default: Apexdocs.markdownDefaults.parallelReflectionMaxWorkers
   },
   previousVersionDir: {
     type: "string",
@@ -273,32 +273,32 @@ const changeLogOptions = {
   targetDir: {
     type: "string",
     alias: "t",
-    default: logger$1.changeLogDefaults.targetDir,
+    default: Apexdocs.changeLogDefaults.targetDir,
     describe: "The directory location where the changelog file will be generated."
   },
   fileName: {
     type: "string",
-    default: logger$1.changeLogDefaults.fileName,
+    default: Apexdocs.changeLogDefaults.fileName,
     describe: "The name of the changelog file to be generated."
   },
   scope: {
     type: "string",
     array: true,
     alias: "s",
-    default: logger$1.changeLogDefaults.scope,
+    default: Apexdocs.changeLogDefaults.scope,
     describe: "The list of scope to respect when generating the changelog. 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."
   },
   customObjectVisibility: {
     type: "string",
     array: true,
     alias: "v",
-    default: logger$1.changeLogDefaults.customObjectVisibility,
+    default: Apexdocs.changeLogDefaults.customObjectVisibility,
     choices: ["public", "protected", "packageprotected"],
     describe: "Controls which custom objects are documented. Values should be separated by a space."
   },
   skipIfNoChanges: {
     type: "boolean",
-    default: logger$1.changeLogDefaults.skipIfNoChanges,
+    default: Apexdocs.changeLogDefaults.skipIfNoChanges,
     describe: "Skip the changelog generation if there are no changes between the previous and current version."
   }
 };
@@ -342,6 +342,14 @@ var __async$1 = (__this, __arguments, generator) => {
     step((generator = generator.apply(__this, __arguments)).next());
   });
 };
+const globalOptions = {
+  debug: {
+    type: "boolean",
+    demandOption: false,
+    default: false,
+    describe: "Enable debug logging."
+  }
+};
 const configOnlyMarkdownDefaults = {
   targetGenerator: "markdown",
   excludeTags: [],
@@ -398,13 +406,13 @@ function extractArgsForCommandProvidedThroughCli(extractFromProcessFn, config) {
   switch (mergedConfig.targetGenerator) {
     case "markdown":
       return _function.pipe(
-        logger$1.validateSourceDirectoryConfig(extractSourceDirectoryConfig(mergedConfig)),
+        Apexdocs.validateSourceDirectoryConfig(extractSourceDirectoryConfig(mergedConfig)),
         E__namespace.mapLeft((error) => new Error(`Invalid markdown configuration: ${error.message}`)),
         E__namespace.map(() => __spreadValues(__spreadValues({}, configOnlyMarkdownDefaults), mergedConfig))
       );
     case "openapi":
       return _function.pipe(
-        logger$1.validateSourceDirectoryConfig(extractSourceDirectoryConfig(mergedConfig)),
+        Apexdocs.validateSourceDirectoryConfig(extractSourceDirectoryConfig(mergedConfig)),
         E__namespace.mapLeft((error) => new Error(`Invalid openapi configuration: ${error.message}`)),
         E__namespace.map(() => __spreadValues(__spreadValues({}, configOnlyOpenApiDefaults), mergedConfig))
       );
@@ -432,7 +440,7 @@ function extractArgsForCommandsProvidedInConfig(extractFromProcessFn, config) {
           E__namespace.flatMap((cliArgs) => {
             const mergedConfig = __spreadValues(__spreadValues(__spreadValues({}, configOnlyMarkdownDefaults), generatorConfig), cliArgs);
             return _function.pipe(
-              logger$1.validateSourceDirectoryConfig(extractSourceDirectoryConfig(mergedConfig)),
+              Apexdocs.validateSourceDirectoryConfig(extractSourceDirectoryConfig(mergedConfig)),
               E__namespace.mapLeft((error) => new Error(`Invalid markdown configuration: ${error.message}`)),
               E__namespace.map(() => mergedConfig)
             );
@@ -444,7 +452,7 @@ function extractArgsForCommandsProvidedInConfig(extractFromProcessFn, config) {
           E__namespace.flatMap((cliArgs) => {
             const mergedConfig = __spreadValues(__spreadValues(__spreadValues({}, configOnlyOpenApiDefaults), generatorConfig), cliArgs);
             return _function.pipe(
-              logger$1.validateSourceDirectoryConfig(extractSourceDirectoryConfig(mergedConfig)),
+              Apexdocs.validateSourceDirectoryConfig(extractSourceDirectoryConfig(mergedConfig)),
               E__namespace.mapLeft((error) => new Error(`Invalid openapi configuration: ${error.message}`)),
               E__namespace.map(() => mergedConfig)
             );
@@ -490,7 +498,7 @@ function getConfigType(config) {
   return E__namespace.right({ _type: "single-command-config" });
 }
 function extractYargsDemandingCommand(extractFromProcessFn, config) {
-  return yargs.config(config.config).command(
+  return yargs.config(config.config).options(globalOptions).command(
     "markdown",
     "Generate documentation from Apex classes as a Markdown site.",
     (yargs2) => yargs2.options(markdownOptions).check(validateMarkdownArgs)
@@ -528,7 +536,7 @@ function extractMultiCommandConfig(extractFromProcessFn, command, config) {
   const options = getOptions(command);
   const validator = getValidationFunction(command);
   return E__namespace.tryCatch(() => {
-    return yargs(extractFromProcessFn()).config(config).options(options).check(validator).fail((msg) => {
+    return yargs(extractFromProcessFn()).config(config).options(globalOptions).options(options).check(validator).fail((msg) => {
       throw new Error(`Invalid configuration for command "${command}": ${msg}`);
     }).parseSync();
   }, E__namespace.toError);
@@ -549,8 +557,8 @@ function validateChangelogConfig(config) {
   };
   return _function.pipe(
     E__namespace.Do,
-    E__namespace.bind("previousValid", () => logger$1.validateSourceDirectoryConfig(previousVersionConfig)),
-    E__namespace.bind("currentValid", () => logger$1.validateSourceDirectoryConfig(currentVersionConfig)),
+    E__namespace.bind("previousValid", () => Apexdocs.validateSourceDirectoryConfig(previousVersionConfig)),
+    E__namespace.bind("currentValid", () => Apexdocs.validateSourceDirectoryConfig(currentVersionConfig)),
     E__namespace.map(() => config)
   );
 }
@@ -575,12 +583,43 @@ var __async = (__this, __arguments, generator) => {
     step((generator = generator.apply(__this, __arguments)).next());
   });
 };
-const logger = new logger$1.StdOutLogger();
+function isDebugEnabledFromProcessArgs() {
+  return process.argv.includes("--debug");
+}
+const logger = new Apexdocs.StdOutLogger();
+logger.setDebug(isDebugEnabledFromProcessArgs());
+if (logger.isDebugEnabled()) {
+  process.env.APEXDOCS_DEBUG = "true";
+}
 function main() {
-  function parseResult(result) {
-    E__namespace.match(catchUnexpectedError, (successMessage) => {
-      logger.logSingle(successMessage);
-    })(result);
+  const aggregatedFailures = [];
+  let commandsRun = 0;
+  function printDebugSummary() {
+    if (!logger.isDebugEnabled()) {
+      return;
+    }
+    logger.debug(`commandsRun=${commandsRun}`);
+    logger.debug(`aggregatedFailures=${aggregatedFailures.length}`);
+  }
+  function printFailuresAtEnd() {
+    if (aggregatedFailures.length === 0) {
+      return;
+    }
+    logger.logSingle("\u26A0\uFE0F Some operations completed with errors. Please review the following issues:", "red");
+    for (const failure of aggregatedFailures) {
+      logger.error(failure);
+    }
+  }
+  function parseResult(result, config) {
+    E__namespace.match(
+      (failure) => {
+        logger.logSingle(`${config.targetGenerator}: completed with errors`, "red");
+        aggregatedFailures.push(failure);
+      },
+      (successMessage) => {
+        logger.logSingle(successMessage);
+      }
+    )(result);
   }
   function catchUnexpectedError(error) {
     logger.error(`\u274C An error occurred while processing the request: ${error}`);
@@ -589,7 +628,23 @@ function main() {
   extractArgs().then((maybeConfigs) => __async(null, null, function* () {
     E__namespace.match(catchUnexpectedError, (configs) => __async(null, null, function* () {
       for (const config of configs) {
-        yield logger$1.Apexdocs.generate(config, logger).then(parseResult);
+        commandsRun++;
+        if (logger.isDebugEnabled()) {
+          logger.debug(`Currently processing generator: ${config.targetGenerator}`);
+        }
+        const result = yield Apexdocs.Apexdocs.generate(config, logger);
+        if (logger.isDebugEnabled()) {
+          logger.logSingle(
+            `${config.targetGenerator}: ${E__namespace.isRight(result) ? "success" : "failure"}`,
+            E__namespace.isRight(result) ? "green" : "red"
+          );
+        }
+        parseResult(result, config);
+      }
+      printFailuresAtEnd();
+      printDebugSummary();
+      if (aggregatedFailures.length > 0) {
+        process.exitCode = 1;
       }
     }))(maybeConfigs);
   })).catch(catchUnexpectedError);

package/dist/index.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 'use strict';
 
-var logger = require('./logger-Cr1iCXZc.js');
+var Apexdocs = require('./Apexdocs-ChhmlY0h.js');
 var E = require('fp-ts/Either');
 require('fp-ts/function');
 require('fp-ts/TaskEither');
@@ -21,9 +21,9 @@ require('fp-ts/boolean');
 require('fp-ts/Array');
 require('fs');
 require('fp-ts/lib/TaskEither');
+require('chalk');
 require('minimatch');
 require('@salesforce/source-deploy-retrieve');
-require('chalk');
 
 function _interopNamespaceDefault(e) {
   var n = Object.create(null);
@@ -82,12 +82,12 @@ var __async = (__this, __arguments, generator) => {
 };
 function process(config) {
   return __async(this, null, function* () {
-    const logger$1 = new logger.NoLogger();
+    const logger = new Apexdocs.NoLogger();
     const configWithDefaults = __spreadValues$1(__spreadValues$1({}, getDefault(config)), config);
     if (!configWithDefaults.sourceDir) {
       throw new Error("sourceDir is required");
     }
-    const result = yield logger.Apexdocs.generate(configWithDefaults, logger$1);
+    const result = yield Apexdocs.Apexdocs.generate(configWithDefaults, logger);
     E__namespace.match(
       (errors) => {
         throw errors;
@@ -100,11 +100,11 @@ function process(config) {
 function getDefault(config) {
   switch (config.targetGenerator) {
     case "markdown":
-      return logger.markdownDefaults;
+      return Apexdocs.markdownDefaults;
     case "openapi":
-      return logger.openApiDefaults;
+      return Apexdocs.openApiDefaults;
     case "changelog":
-      return logger.changeLogDefaults;
+      return Apexdocs.changeLogDefaults;
     default:
       throw new Error("Unknown target generator");
   }
@@ -130,23 +130,23 @@ var __spreadValues = (a, b) => {
 };
 var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
 function defineMarkdownConfig(config) {
-  return __spreadProps(__spreadValues(__spreadValues({}, logger.markdownDefaults), config), {
+  return __spreadProps(__spreadValues(__spreadValues({}, Apexdocs.markdownDefaults), config), {
     targetGenerator: "markdown"
   });
 }
 function defineOpenApiConfig(config) {
-  return __spreadProps(__spreadValues(__spreadValues({}, logger.openApiDefaults), config), {
+  return __spreadProps(__spreadValues(__spreadValues({}, Apexdocs.openApiDefaults), config), {
     targetGenerator: "openapi"
   });
 }
 function defineChangelogConfig(config) {
-  return __spreadProps(__spreadValues(__spreadValues({}, logger.changeLogDefaults), config), {
+  return __spreadProps(__spreadValues(__spreadValues({}, Apexdocs.changeLogDefaults), config), {
     targetGenerator: "changelog"
   });
 }
 
-exports.skip = logger.skip;
-exports.templateHelpers = logger.templateHelpers;
+exports.skip = Apexdocs.skip;
+exports.templateHelpers = Apexdocs.templateHelpers;
 exports.defineChangelogConfig = defineChangelogConfig;
 exports.defineMarkdownConfig = defineMarkdownConfig;
 exports.defineOpenApiConfig = defineOpenApiConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cparra/apexdocs",
-  "version": "3.17.0",
+  "version": "3.17.1-beta.0",
   "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
   "engines": {
     "node": ">=18"