@cparra/apexdocs 3.3.0 → 3.3.1

package/dist/cli/generate.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 'use strict';
 
-var index = require('../Apexdocs-BXshUaEK.js');
+var logger$1 = require('../logger-Q5m1eQv2.js');
 var module$1 = require('module');
 var cosmiconfig = require('cosmiconfig');
 var E = require('fp-ts/Either');
@@ -19,8 +19,8 @@ require('handlebars');
 require('fp-ts/boolean');
 require('fs');
 require('fp-ts/lib/TaskEither');
-require('chalk');
 require('minimatch');
+require('chalk');
 
 var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
 function _interopNamespaceDefault(e) {
@@ -58,19 +58,19 @@ const markdownOptions = {
   targetDir: {
     type: "string",
     alias: "t",
-    default: index.markdownDefaults.targetDir,
+    default: logger$1.markdownDefaults.targetDir,
     describe: "The directory location where documentation will be generated to."
   },
   scope: {
     type: "string",
     array: true,
     alias: "p",
-    default: index.markdownDefaults.scope,
+    default: logger$1.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: index.markdownDefaults.defaultGroupName,
+    default: logger$1.markdownDefaults.defaultGroupName,
     describe: "Defines the @group name to be used when a file does not specify it."
   },
   namespace: {
@@ -80,23 +80,23 @@ const markdownOptions = {
   sortAlphabetically: {
     type: "boolean",
     describe: "Whether to sort files and members alphabetically.",
-    default: index.markdownDefaults.sortAlphabetically
+    default: logger$1.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: index.markdownDefaults.includeMetadata
+    default: logger$1.markdownDefaults.includeMetadata
   },
   linkingStrategy: {
     type: "string",
     describe: "The strategy to use when linking to other documentation pages.",
     choices: ["relative", "no-link", "none"],
-    default: index.markdownDefaults.linkingStrategy
+    default: logger$1.markdownDefaults.linkingStrategy
   },
   referenceGuideTitle: {
     type: "string",
     describe: "The title of the reference guide.",
-    default: index.markdownDefaults.referenceGuideTitle
+    default: logger$1.markdownDefaults.referenceGuideTitle
   }
 };
 
@@ -110,12 +110,12 @@ const openApiOptions = {
   targetDir: {
     type: "string",
     alias: "t",
-    default: index.openApiDefaults.targetDir,
+    default: logger$1.openApiDefaults.targetDir,
     describe: "The directory location where the OpenApi file will be generated."
   },
   fileName: {
     type: "string",
-    default: index.openApiDefaults.fileName,
+    default: logger$1.openApiDefaults.fileName,
     describe: "The name of the OpenApi file to be generated."
   },
   namespace: {
@@ -124,12 +124,12 @@ const openApiOptions = {
   },
   title: {
     type: "string",
-    default: index.openApiDefaults.title,
+    default: logger$1.openApiDefaults.title,
     describe: "The title of the OpenApi file."
   },
   apiVersion: {
     type: "string",
-    default: index.openApiDefaults.apiVersion,
+    default: logger$1.openApiDefaults.apiVersion,
     describe: "The version of the OpenApi file."
   }
 };
@@ -150,24 +150,24 @@ const changeLogOptions = {
   targetDir: {
     type: "string",
     alias: "t",
-    default: index.changeLogDefaults.targetDir,
+    default: logger$1.changeLogDefaults.targetDir,
     describe: "The directory location where the changelog file will be generated."
   },
   fileName: {
     type: "string",
-    default: index.changeLogDefaults.fileName,
+    default: logger$1.changeLogDefaults.fileName,
     describe: "The name of the changelog file to be generated."
   },
   scope: {
     type: "string",
     array: true,
     alias: "s",
-    default: index.changeLogDefaults.scope,
+    default: logger$1.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,
+    default: logger$1.changeLogDefaults.skipIfNoChanges,
     describe: "Skip the changelog generation if there are no changes between the previous and current version."
   }
 };
@@ -383,7 +383,7 @@ var __async = (__this, __arguments, generator) => {
     step((generator = generator.apply(__this, __arguments)).next());
   });
 };
-const logger = new index.StdOutLogger();
+const logger = new logger$1.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 index.Apexdocs.generate(config, logger).then(parseResult);
+        yield logger$1.Apexdocs.generate(config, logger).then(parseResult);
       }
     }))(maybeConfigs);
   })).catch(catchUnexpectedError);

package/dist/index.d.ts

@@ -137,6 +137,11 @@ type TransformDocPage = (
   doc: DocPageData,
 ) => Partial<ConfigurableDocPageData> | Promise<Partial<ConfigurableDocPageData>>;
 
+/**
+ * Represents a file to be skipped.
+ */
+declare function skip(): Skip;
+
 type CallableConfig = Partial<UserDefinedConfig> & {
     sourceDir: string;
     targetGenerator: Generators;
@@ -165,9 +170,5 @@ type ConfigurableChangelogConfig = Omit<Partial<UserDefinedChangelogConfig>, 'ta
  * @param config The configuration to use.
  */
 declare function defineChangelogConfig(config: ConfigurableChangelogConfig): Partial<UserDefinedChangelogConfig>;
-/**
- * Represents a file to be skipped.
- */
-declare function skip(): Skip;
 
 export { type ConfigurableChangelogConfig, type ConfigurableDocPageData, type ConfigurableDocPageReference, type ConfigurableHooks, type ConfigurableMarkdownConfig, type ConfigurableOpenApiConfig, type DocPageData, type DocPageReference, type ReferenceGuidePageData, type Skip, type TransformDocPage, type TransformDocs, type TransformReference, type TransformReferenceGuide, defineChangelogConfig, defineMarkdownConfig, defineOpenApiConfig, process, skip };

package/dist/index.js

@@ -1,9 +1,9 @@
 'use strict';
 
-var index = require('./Apexdocs-BXshUaEK.js');
+var logger = require('./logger-Q5m1eQv2.js');
+var E = require('fp-ts/Either');
 require('fp-ts/function');
 require('fp-ts/TaskEither');
-require('fp-ts/Either');
 require('js-yaml');
 require('path');
 require('fp-ts/Task');
@@ -15,13 +15,131 @@ require('handlebars');
 require('fp-ts/boolean');
 require('fs');
 require('fp-ts/lib/TaskEither');
-require('chalk');
 require('minimatch');
+require('chalk');
+
+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"
+  });
+}
 
-exports.defineChangelogConfig = index.defineChangelogConfig;
-exports.defineMarkdownConfig = index.defineMarkdownConfig;
-exports.defineOpenApiConfig = index.defineOpenApiConfig;
-exports.process = index.process;
-exports.skip = index.skip;
+exports.skip = logger.skip;
+exports.defineChangelogConfig = defineChangelogConfig;
+exports.defineMarkdownConfig = defineMarkdownConfig;
+exports.defineOpenApiConfig = defineOpenApiConfig;
+exports.process = process;

package/dist/{logger-B2PHch8U.js → logger-Q5m1eQv2.js}

@@ -1604,6 +1604,11 @@ function sortClassMembers(shouldSort, classType) {
   });
 }
 
+function skip() {
+  return {
+    _tag: "Skip"
+  };
+}
 function isSkip(value) {
   return Object.prototype.hasOwnProperty.call(value, "_tag") && value._tag === "Skip";
 }
@@ -3058,6 +3063,9 @@ function areMethodsEqual(method1, method2) {
   return true;
 }
 
+function hasChanges(changelog) {
+  return changelog.newTypes.length > 0 || changelog.removedTypes.length > 0 || changelog.newOrModifiedMembers.length > 0;
+}
 function processChangelog(oldVersion, newVersion) {
   return {
     newTypes: getNewTypes(oldVersion, newVersion),
@@ -3315,6 +3323,9 @@ function generateChangeLog(oldBundles, newBundles, config) {
   }
   const convertToPageData = apply(toPageData, config.fileName);
   function handleConversion({ changelog, newManifest }) {
+    if (config.skipIfNoChanges && !hasChanges(changelog)) {
+      return skip();
+    }
     return _function.pipe(convertToRenderableChangelog(changelog, newManifest.types), compile, convertToPageData);
   }
   return _function.pipe(
@@ -3661,3 +3672,4 @@ exports.StdOutLogger = StdOutLogger;
 exports.changeLogDefaults = changeLogDefaults;
 exports.markdownDefaults = markdownDefaults;
 exports.openApiDefaults = openApiDefaults;
+exports.skip = skip;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cparra/apexdocs",
-  "version": "3.3.0",
+  "version": "3.3.1",
   "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
   "keywords": [
     "apex",
@@ -21,7 +21,7 @@
   "scripts": {
     "test": "npm run build && jest",
     "test:cov": "npm run build && jest --coverage",
-    "build": "rimraf ./lib && npm run lint && tsc --noEmit && pkgroll",
+    "build": "rimraf ./dist && npm run lint && tsc --noEmit && pkgroll",
     "lint": "eslint \"./src/**/*.{js,ts}\" --quiet --fix",
     "prepare": "npm run build",
     "version": "npm run format && git add -A src",