@cparra/apexdocs 3.3.0-alpha.0 → 3.3.0

package/dist/cli/generate.js

@@ -1,14 +1,13 @@
 #!/usr/bin/env node
 'use strict';
 
-var logger$1 = require('../logger-C3kCwNpQ.js');
+var index = require('../Apexdocs-BXshUaEK.js');
+var module$1 = require('module');
 var cosmiconfig = require('cosmiconfig');
-var yargs = require('yargs');
 var E = require('fp-ts/Either');
 var cosmiconfigTypescriptLoader = require('cosmiconfig-typescript-loader');
 var _function = require('fp-ts/function');
 require('fp-ts/TaskEither');
-require('simple-git');
 require('js-yaml');
 require('path');
 require('fp-ts/Task');
@@ -20,31 +19,35 @@ require('handlebars');
 require('fp-ts/boolean');
 require('fs');
 require('fp-ts/lib/TaskEither');
-require('minimatch');
-require('node:path');
-require('node:fs');
 require('chalk');
+require('minimatch');
 
+var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
 function _interopNamespaceDefault(e) {
-  var n = Object.create(null);
-  if (e) {
-    Object.keys(e).forEach(function (k) {
-      if (k !== 'default') {
-        var d = Object.getOwnPropertyDescriptor(e, k);
-        Object.defineProperty(n, k, d.get ? d : {
-          enumerable: true,
-          get: function () { return e[k]; }
-        });
-      }
-    });
-  }
-  n.default = e;
-  return Object.freeze(n);
+	var n = Object.create(null);
+	if (e) {
+		Object.keys(e).forEach(function (k) {
+			if (k !== 'default') {
+				var d = Object.getOwnPropertyDescriptor(e, k);
+				Object.defineProperty(n, k, d.get ? d : {
+					enumerable: true,
+					get: function () { return e[k]; }
+				});
+			}
+		});
+	}
+	n.default = e;
+	return Object.freeze(n);
 }
 
-var yargs__namespace = /*#__PURE__*/_interopNamespaceDefault(yargs);
 var E__namespace = /*#__PURE__*/_interopNamespaceDefault(E);
 
+var require$1 = (
+			false
+				? /* @__PURE__ */ module$1.createRequire((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('cli/generate.js', document.baseURI).href)))
+				: require
+		);
+
 const markdownOptions = {
   sourceDir: {
     type: "string",
@@ -55,19 +58,19 @@ const markdownOptions = {
   targetDir: {
     type: "string",
     alias: "t",
-    default: logger$1.markdownDefaults.targetDir,
+    default: index.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: index.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."
   },
   defaultGroupName: {
     type: "string",
-    default: logger$1.markdownDefaults.defaultGroupName,
+    default: index.markdownDefaults.defaultGroupName,
     describe: "Defines the @group name to be used when a file does not specify it."
   },
   namespace: {
@@ -77,23 +80,23 @@ const markdownOptions = {
   sortAlphabetically: {
     type: "boolean",
     describe: "Whether to sort files and members alphabetically.",
-    default: logger$1.markdownDefaults.sortAlphabetically
+    default: index.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: index.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: index.markdownDefaults.linkingStrategy
   },
   referenceGuideTitle: {
     type: "string",
     describe: "The title of the reference guide.",
-    default: logger$1.markdownDefaults.referenceGuideTitle
+    default: index.markdownDefaults.referenceGuideTitle
   }
 };
 
@@ -107,12 +110,12 @@ const openApiOptions = {
   targetDir: {
     type: "string",
     alias: "t",
-    default: logger$1.openApiDefaults.targetDir,
+    default: index.openApiDefaults.targetDir,
     describe: "The directory location where the OpenApi file will be generated."
   },
   fileName: {
     type: "string",
-    default: logger$1.openApiDefaults.fileName,
+    default: index.openApiDefaults.fileName,
     describe: "The name of the OpenApi file to be generated."
   },
   namespace: {
@@ -121,12 +124,12 @@ const openApiOptions = {
   },
   title: {
     type: "string",
-    default: logger$1.openApiDefaults.title,
+    default: index.openApiDefaults.title,
     describe: "The title of the OpenApi file."
   },
   apiVersion: {
     type: "string",
-    default: logger$1.openApiDefaults.apiVersion,
+    default: index.openApiDefaults.apiVersion,
     describe: "The version of the OpenApi file."
   }
 };
@@ -136,18 +139,7 @@ const changeLogOptions = {
     type: "string",
     alias: "p",
     demandOption: true,
-    describe: "The directory location of the previous version of the source code. If previousGitReference is provided, this value should be the directory in which the Apex source code resides within the repository."
-  },
-  // TODO: Validate that if previousGitReference is provided, repoPath is also provided.
-  repoPath: {
-    type: "string",
-    alias: "g",
-    describe: "The path to the git repository. Must be provided if previousGitReference is provided."
-  },
-  previousGitReference: {
-    type: "string",
-    alias: "r",
-    describe: "The git reference of the previous version of the source code."
+    describe: "The directory location of the previous version of the source code."
   },
   currentVersionDir: {
     type: "string",
@@ -158,20 +150,25 @@ const changeLogOptions = {
   targetDir: {
     type: "string",
     alias: "t",
-    default: logger$1.changeLogDefaults.targetDir,
+    default: index.changeLogDefaults.targetDir,
     describe: "The directory location where the changelog file will be generated."
   },
   fileName: {
     type: "string",
-    default: logger$1.changeLogDefaults.fileName,
+    default: index.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: index.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."
+  },
+  skipIfNoChanges: {
+    type: "boolean",
+    default: index.changeLogDefaults.skipIfNoChanges,
+    describe: "Skip the changelog generation if there are no changes between the previous and current version."
   }
 };
 
@@ -214,6 +211,7 @@ var __async$1 = (__this, __arguments, generator) => {
     step((generator = generator.apply(__this, __arguments)).next());
   });
 };
+const yargs = require$1("yargs");
 const configOnlyMarkdownDefaults = {
   targetGenerator: "markdown",
   excludeTags: [],
@@ -279,22 +277,32 @@ function extractArgsForCommandProvidedThroughCli(extractFromProcessFn, config) {
   }
 }
 function extractArgsForCommandsProvidedInConfig(extractFromProcessFn, config) {
-  const configs = Object.entries(config).map(([generator, generatorConfig]) => {
+  const providedThroughCli = yargs.parseSync(extractFromProcessFn());
+  const hasACommandBeenProvided = providedThroughCli._.length > 0;
+  const configs = Object.entries(config).filter(([generator]) => hasACommandBeenProvided ? providedThroughCli._[0] === generator : true).map(([generator, generatorConfig]) => {
     switch (generator) {
       case "markdown":
         return _function.pipe(
-          validateMultiCommandConfig(extractFromProcessFn, "markdown", generatorConfig),
-          E__namespace.map(() => __spreadValues(__spreadValues({}, configOnlyMarkdownDefaults), generatorConfig))
+          extractMultiCommandConfig(extractFromProcessFn, "markdown", generatorConfig),
+          E__namespace.map((cliArgs) => {
+            console.log("markdown", cliArgs);
+            return cliArgs;
+          }),
+          E__namespace.map((cliArgs) => __spreadValues(__spreadValues(__spreadValues({}, configOnlyMarkdownDefaults), generatorConfig), cliArgs))
         );
       case "openapi":
         return _function.pipe(
-          validateMultiCommandConfig(extractFromProcessFn, "openapi", generatorConfig),
-          E__namespace.map(() => __spreadValues(__spreadValues({}, configOnlyOpenApiDefaults), generatorConfig))
+          extractMultiCommandConfig(extractFromProcessFn, "openapi", generatorConfig),
+          E__namespace.map((cliArgs) => __spreadValues(__spreadValues(__spreadValues({}, configOnlyOpenApiDefaults), generatorConfig), cliArgs))
         );
       case "changelog":
         return _function.pipe(
-          validateMultiCommandConfig(extractFromProcessFn, "changelog", generatorConfig),
-          E__namespace.map(() => __spreadValues(__spreadValues({}, configOnlyChangelogDefaults), generatorConfig))
+          extractMultiCommandConfig(extractFromProcessFn, "changelog", generatorConfig),
+          E__namespace.map((cliArgs) => {
+            console.log("changelog", cliArgs);
+            return cliArgs;
+          }),
+          E__namespace.map((cliArgs) => __spreadValues(__spreadValues(__spreadValues({}, configOnlyChangelogDefaults), generatorConfig), cliArgs))
         );
     }
   });
@@ -321,21 +329,21 @@ function getConfigType(config) {
   return E__namespace.right({ _type: "single-command-config" });
 }
 function extractYargsDemandingCommand(extractFromProcessFn, config) {
-  return yargs__namespace.config(config.config).command(
+  return yargs.config(config.config).command(
     "markdown",
     "Generate documentation from Apex classes as a Markdown site.",
     (yargs2) => yargs2.options(markdownOptions)
   ).command(
     "openapi",
     "Generate an OpenApi REST specification from Apex classes.",
-    () => yargs__namespace.options(openApiOptions)
+    () => yargs.options(openApiOptions)
   ).command(
     "changelog",
     "Generate a changelog from 2 versions of the source code.",
-    () => yargs__namespace.options(changeLogOptions)
+    () => yargs.options(changeLogOptions)
   ).demandCommand().parseSync(extractFromProcessFn());
 }
-function validateMultiCommandConfig(extractFromProcessFn, command, config) {
+function extractMultiCommandConfig(extractFromProcessFn, command, config) {
   function getOptions(generator) {
     switch (generator) {
       case "markdown":
@@ -347,19 +355,11 @@ function validateMultiCommandConfig(extractFromProcessFn, command, config) {
     }
   }
   const options = getOptions(command);
+  console.log("config", config);
   return E__namespace.tryCatch(() => {
-    yargs__namespace.config(config).options(options).check((argv) => {
-      if (argv._.length > 0) {
-        throw new Error(
-          `Unexpected command "${argv._[0]}". 
-            The command name should be provided in the configuration when using the current configuration format.`
-        );
-      } else {
-        return true;
-      }
-    }).fail((msg) => {
+    return yargs(extractFromProcessFn()).config(config).options(options).fail((msg) => {
       throw new Error(`Invalid configuration for command "${command}": ${msg}`);
-    }).parse(extractFromProcessFn());
+    }).parseSync();
   }, E__namespace.toError);
 }
 
@@ -383,7 +383,7 @@ var __async = (__this, __arguments, generator) => {
     step((generator = generator.apply(__this, __arguments)).next());
   });
 };
-const logger = new logger$1.StdOutLogger();
+const logger = new index.StdOutLogger();
 function main() {
   function parseResult(result) {
     E__namespace.match(catchUnexpectedError, (successMessage) => {
@@ -397,7 +397,7 @@ function main() {
   extractArgs().then((maybeConfigs) => __async(this, null, function* () {
     E__namespace.match(catchUnexpectedError, (configs) => __async(this, null, function* () {
       for (const config of configs) {
-        yield logger$1.Apexdocs.generate(config, logger).then(parseResult);
+        yield index.Apexdocs.generate(config, logger).then(parseResult);
       }
     }))(maybeConfigs);
   })).catch(catchUnexpectedError);

package/dist/index.d.ts

@@ -40,13 +40,12 @@ type UserDefinedOpenApiConfig = {
 type UserDefinedChangelogConfig = {
   targetGenerator: 'changelog';
   previousVersionDir: string;
-  repoPath?: string;
-  previousGitReference?: string;
   currentVersionDir: string;
   targetDir: string;
   fileName: string;
   scope: string[];
   exclude: string[];
+  skipIfNoChanges: boolean;
 };
 
 type UserDefinedConfig = UserDefinedMarkdownConfig | UserDefinedOpenApiConfig | UserDefinedChangelogConfig;

package/dist/index.js

@@ -1,10 +1,9 @@
 'use strict';
 
-var logger = require('./logger-C3kCwNpQ.js');
-var E = require('fp-ts/Either');
+var index = require('./Apexdocs-BXshUaEK.js');
 require('fp-ts/function');
 require('fp-ts/TaskEither');
-require('simple-git');
+require('fp-ts/Either');
 require('js-yaml');
 require('path');
 require('fp-ts/Task');
@@ -16,138 +15,13 @@ require('handlebars');
 require('fp-ts/boolean');
 require('fs');
 require('fp-ts/lib/TaskEither');
-require('minimatch');
-require('node:path');
-require('node:fs');
 require('chalk');
+require('minimatch');
 
-function _interopNamespaceDefault(e) {
-  var n = Object.create(null);
-  if (e) {
-    Object.keys(e).forEach(function (k) {
-      if (k !== 'default') {
-        var d = Object.getOwnPropertyDescriptor(e, k);
-        Object.defineProperty(n, k, d.get ? d : {
-          enumerable: true,
-          get: function () { return e[k]; }
-        });
-      }
-    });
-  }
-  n.default = e;
-  return Object.freeze(n);
-}
-
-var E__namespace = /*#__PURE__*/_interopNamespaceDefault(E);
-
-var __defProp$1 = Object.defineProperty;
-var __getOwnPropSymbols$1 = Object.getOwnPropertySymbols;
-var __hasOwnProp$1 = Object.prototype.hasOwnProperty;
-var __propIsEnum$1 = Object.prototype.propertyIsEnumerable;
-var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __spreadValues$1 = (a, b) => {
-  for (var prop in b || (b = {}))
-    if (__hasOwnProp$1.call(b, prop))
-      __defNormalProp$1(a, prop, b[prop]);
-  if (__getOwnPropSymbols$1)
-    for (var prop of __getOwnPropSymbols$1(b)) {
-      if (__propIsEnum$1.call(b, prop))
-        __defNormalProp$1(a, prop, b[prop]);
-    }
-  return a;
-};
-var __async = (__this, __arguments, generator) => {
-  return new Promise((resolve, reject) => {
-    var fulfilled = (value) => {
-      try {
-        step(generator.next(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var rejected = (value) => {
-      try {
-        step(generator.throw(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
-    step((generator = generator.apply(__this, __arguments)).next());
-  });
-};
-function process(config) {
-  return __async(this, null, function* () {
-    const logger$1 = new logger.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);
-    E__namespace.match(
-      (errors) => {
-        throw errors;
-      },
-      () => {
-      }
-    )(result);
-  });
-}
-function getDefault(config) {
-  switch (config.targetGenerator) {
-    case "markdown":
-      return logger.markdownDefaults;
-    case "openapi":
-      return logger.openApiDefaults;
-    case "changelog":
-      return logger.changeLogDefaults;
-    default:
-      throw new Error("Unknown target generator");
-  }
-}
 
-var __defProp = Object.defineProperty;
-var __defProps = Object.defineProperties;
-var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
-var __getOwnPropSymbols = Object.getOwnPropertySymbols;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __propIsEnum = Object.prototype.propertyIsEnumerable;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __spreadValues = (a, b) => {
-  for (var prop in b || (b = {}))
-    if (__hasOwnProp.call(b, prop))
-      __defNormalProp(a, prop, b[prop]);
-  if (__getOwnPropSymbols)
-    for (var prop of __getOwnPropSymbols(b)) {
-      if (__propIsEnum.call(b, prop))
-        __defNormalProp(a, prop, b[prop]);
-    }
-  return a;
-};
-var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
-function defineMarkdownConfig(config) {
-  return __spreadProps(__spreadValues(__spreadValues({}, logger.markdownDefaults), config), {
-    targetGenerator: "markdown"
-  });
-}
-function defineOpenApiConfig(config) {
-  return __spreadProps(__spreadValues(__spreadValues({}, logger.openApiDefaults), config), {
-    targetGenerator: "openapi"
-  });
-}
-function defineChangelogConfig(config) {
-  return __spreadProps(__spreadValues(__spreadValues({}, logger.changeLogDefaults), config), {
-    targetGenerator: "changelog"
-  });
-}
-function skip() {
-  return {
-    _tag: "Skip"
-  };
-}
 
-exports.defineChangelogConfig = defineChangelogConfig;
-exports.defineMarkdownConfig = defineMarkdownConfig;
-exports.defineOpenApiConfig = defineOpenApiConfig;
-exports.process = process;
-exports.skip = skip;
+exports.defineChangelogConfig = index.defineChangelogConfig;
+exports.defineMarkdownConfig = index.defineMarkdownConfig;
+exports.defineOpenApiConfig = index.defineOpenApiConfig;
+exports.process = index.process;
+exports.skip = index.skip;