@cparra/apexdocs 3.1.1 → 3.2.1

package/README.md

@@ -41,10 +41,19 @@ annotated with `@RestResource`:
 apexdocs openapi -s force-app
 ```
 
+#### Changelog
+
+Run the following command to generate a changelog for your Salesforce Apex classes:
+
+```bash
+apexdocs changelog --previousVersionDir force-app-previous --currentVersionDir force-app
+```
+
 ## 🚀 Features
 
 * Generate documentation for Salesforce Apex classes as Markdown files
 * Generate an OpenApi REST specification based on `@RestResource` classes
+* Generate a changelog based on the differences between two versions of your Salesforce Apex classes
 * Support for grouping blocks of related code within a class
 * Support for ignoring files and members from being documented
 * Namespace support
@@ -146,6 +155,28 @@ apexdocs markdown -s force-app -t docs -p global public namespaceaccessible -n M
 apexdocs openapi -s force-app -t docs -n MyNamespace --title "My Custom OpenApi Title"
 ```
 
+### Changelog
+
+`changelog`
+
+#### Flags
+
+| Flag                   | Alias | Description                                                        | Default     | Required |
+|------------------------|-------|--------------------------------------------------------------------|-------------|----------|
+| `--previousVersionDir` | `-p`  | The directory location of the previous version of the source code. | N/A         | Yes      |
+| `--currentVersionDir`  | `-t`  | The directory location of the current version of the source code.  | N/A         | Yes      |
+| `--targetDir`          | `-t`  | The directory location where the changelog file will be generated. | `./docs/`   | No       |
+| `--fileName`           | N/A   | The name of the changelog file to be generated.                    | `changelog` | No       |
+| `--scope`              | N/A   | The list of scope to respect when generating the changelog.        | ['global']  | No       |
+
+#### Sample Usage
+
+```bash
+apexdocs changelog -p force-app-previous -t force-app
+```
+
+---
+
 ## 🔬 Defining a configuration file
 
 You can also use a configuration file to define the parameters that will be used when generating the documentation.
@@ -187,7 +218,7 @@ CLI will be used, or the default value will be used.
 
 ### Config Intellisense
 
-Using the `defineMarkdownConfig` (or the `defineOpenApiConfig` for OpenApi documentation) 
+Using the `defineMarkdownConfig` (or the `defineOpenApiConfig` for OpenApi documentation)
 helper will provide Typescript-powered intellisense
 for the configuration file options. This should work with both Javascript and Typescript files.
 
@@ -202,8 +233,44 @@ export default defineMarkdownConfig({
 });
 ```
 
+### Generating Different Types of Documentation
+
+You might want to generate different types of documentation using a single command. For example, if you are releasing
+a new version of your project, you might want to generate updated documentation Markdown files, and at the
+same time generate a changelog listing everything new.
+
+You can do this by providing a configuration file that exports a configuration object which keys are the type of
+documentation you want to generate.
+
+```typescript
+import { defineMarkdownConfig, defineChangelogConfig } from '@cparra/apexdocs';
+
+export default {
+  markdown: defineMarkdownConfig({
+    sourceDir: 'force-app',
+    targetDir: 'docs',
+    scope: ['global', 'public'],
+    ...
+  }),
+  changelog: defineChangelogConfig({
+    previousVersionDir: 'force-app-previous',
+    currentVersionDir: 'force-app',
+    targetDir: 'docs',
+    scope: ['global', 'public'],
+  })
+};
+```
+
+Then you only need to run the top level `apexdocs` command, and it will generate both types of documentation.
+
+```bash
+apexdocs
+```
+
 ### Excluding Tags from Appearing in the Documentation
 
+Note: Only works for Markdown documentation.
+
 You can exclude tags from appearing in the documentation by using the `excludeTags` property in the configuration file,
 which allow you to pass a list of tags that you want to exclude from the documentation.
 
@@ -219,6 +286,23 @@ export default defineMarkdownConfig({
 });
 ```
 
+### Excluding Files from Being Documented
+
+You can exclude one or multiple files from being documented by providing a list of glob patterns to
+the `exclude` property in the configuration file.
+
+```typescript
+import { defineMarkdownConfig } from "@cparra/apexdocs";
+
+export default defineMarkdownConfig({
+  sourceDir: 'force-app',
+  targetDir: 'docs',
+  scope: ['global', 'public'],
+  exclude: ['**/MyClass.cls', '**/MyOtherClass.cls'],
+  ...
+});
+```
+
 ### Configuration Hooks
 
 When defining a `.js` or `.ts` configuration file, your object export can also make use
@@ -370,12 +454,12 @@ If using Typescript, ApexDocs provides all necessary type definitions.
 
 ## 📖 Documentation Guide
 
-See the [wiki](https://github.com/cesarParra/apexdocs/wiki/%F0%9F%93%96-Documenting-Apex-code)
+See the [wiki](https://github.com/cesarParra/apexdocs/wiki/2.-%F0%9F%93%96-Documenting-Apex-code)
 for an in-depth guide on how to document your Apex code to get the most out of ApexDocs.
 
 ## 📄 Generating OpenApi REST Definitions
 
 ApexDocs can also generate OpenApi REST definitions for your Salesforce Apex classes annotated with `@RestResource`.
 
-See the [wiki](https://github.com/cesarParra/apexdocs/wiki/%F0%9F%93%84-Generating-OpenApi-REST-Definitions)
+See the [wiki](https://github.com/cesarParra/apexdocs/wiki/3.-%F0%9F%93%84-Generating-OpenApi-REST-Definitions)
 for more information.

package/dist/cli/generate.js

@@ -1,12 +1,12 @@
 #!/usr/bin/env node
 'use strict';
 
-var logger$1 = require('../logger-BATX7-be.js');
+var logger$1 = require('../logger-DIyKhj0a.js');
 var cosmiconfig = require('cosmiconfig');
 var yargs = require('yargs');
-var cosmiconfigTypescriptLoader = require('cosmiconfig-typescript-loader');
 var E = require('fp-ts/Either');
-require('fp-ts/function');
+var cosmiconfigTypescriptLoader = require('cosmiconfig-typescript-loader');
+var _function = require('fp-ts/function');
 require('fp-ts/TaskEither');
 require('js-yaml');
 require('path');
@@ -19,6 +19,7 @@ require('handlebars');
 require('fp-ts/boolean');
 require('fs');
 require('fp-ts/lib/TaskEither');
+require('minimatch');
 require('chalk');
 
 function _interopNamespaceDefault(e) {
@@ -103,7 +104,7 @@ const openApiOptions = {
   targetDir: {
     type: "string",
     alias: "t",
-    default: logger$1.markdownDefaults.targetDir,
+    default: logger$1.openApiDefaults.targetDir,
     describe: "The directory location where the OpenApi file will be generated."
   },
   fileName: {
@@ -127,6 +128,39 @@ const openApiOptions = {
   }
 };
 
+const changeLogOptions = {
+  previousVersionDir: {
+    type: "string",
+    alias: "p",
+    demandOption: true,
+    describe: "The directory location of the previous version of the source code."
+  },
+  currentVersionDir: {
+    type: "string",
+    alias: "c",
+    demandOption: true,
+    describe: "The directory location of the current version of the source code."
+  },
+  targetDir: {
+    type: "string",
+    alias: "t",
+    default: logger$1.changeLogDefaults.targetDir,
+    describe: "The directory location where the changelog file will be generated."
+  },
+  fileName: {
+    type: "string",
+    default: logger$1.changeLogDefaults.fileName,
+    describe: "The name of the changelog file to be generated."
+  },
+  scope: {
+    type: "string",
+    array: true,
+    alias: "s",
+    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."
+  }
+};
+
 var __defProp = Object.defineProperty;
 var __defProps = Object.defineProperties;
 var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
@@ -146,7 +180,7 @@ var __spreadValues = (a, b) => {
   return a;
 };
 var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
-var __async = (__this, __arguments, generator) => {
+var __async$1 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -166,18 +200,114 @@ var __async = (__this, __arguments, generator) => {
     step((generator = generator.apply(__this, __arguments)).next());
   });
 };
-const configOnlyDefaults = {
-  excludeTags: []
+const configOnlyMarkdownDefaults = {
+  targetGenerator: "markdown",
+  excludeTags: [],
+  exclude: []
+};
+const configOnlyOpenApiDefaults = {
+  targetGenerator: "openapi",
+  exclude: []
+};
+const configOnlyChangelogDefaults = {
+  targetGenerator: "changelog",
+  exclude: []
 };
-function _extractConfig() {
-  return cosmiconfig.cosmiconfig("apexdocs", {
-    loaders: {
-      ".ts": cosmiconfigTypescriptLoader.TypeScriptLoader()
+function getArgumentsFromProcess() {
+  return process.argv.slice(2);
+}
+function extractConfigFromPackageJsonOrFile() {
+  return __async$1(this, null, function* () {
+    var _a;
+    const result = yield cosmiconfig.cosmiconfig("apexdocs", {
+      loaders: {
+        ".ts": cosmiconfigTypescriptLoader.TypeScriptLoader()
+      }
+    }).search();
+    return { config: (_a = result == null ? void 0 : result.config) != null ? _a : {} };
+  });
+}
+function extractArgs() {
+  return __async$1(this, arguments, function* (extractFromProcessFn = getArgumentsFromProcess, extractConfigFn = extractConfigFromPackageJsonOrFile) {
+    const config = yield extractConfigFn();
+    function handle(configType) {
+      switch (configType._type) {
+        case "no-config":
+        case "single-command-config":
+          return handleSingleCommand(extractFromProcessFn, config);
+        case "multi-command-config":
+          return extractArgsForCommandsProvidedInConfig(extractFromProcessFn, config.config);
+      }
+    }
+    return _function.pipe(getConfigType(config), E__namespace.flatMap(handle));
+  });
+}
+function handleSingleCommand(extractFromProcessFn, config) {
+  return _function.pipe(
+    E__namespace.right(config),
+    E__namespace.flatMap((config2) => extractArgsForCommandProvidedThroughCli(extractFromProcessFn, config2)),
+    E__namespace.map((config2) => [config2])
+  );
+}
+function extractArgsForCommandProvidedThroughCli(extractFromProcessFn, config) {
+  const cliArgs = extractYargsDemandingCommand(extractFromProcessFn, config);
+  const commandName = cliArgs._[0];
+  const mergedConfig = __spreadProps(__spreadValues(__spreadValues({}, config.config), cliArgs), { targetGenerator: commandName });
+  switch (mergedConfig.targetGenerator) {
+    case "markdown":
+      return E__namespace.right(__spreadValues(__spreadValues({}, configOnlyMarkdownDefaults), mergedConfig));
+    case "openapi":
+      return E__namespace.right(__spreadValues(__spreadValues({}, configOnlyOpenApiDefaults), mergedConfig));
+    case "changelog":
+      return E__namespace.right(__spreadValues(__spreadValues({}, configOnlyChangelogDefaults), mergedConfig));
+    default:
+      return E__namespace.left(new Error(`Invalid command provided: ${mergedConfig.targetGenerator}`));
+  }
+}
+function extractArgsForCommandsProvidedInConfig(extractFromProcessFn, config) {
+  const configs = Object.entries(config).map(([generator, generatorConfig]) => {
+    switch (generator) {
+      case "markdown":
+        return _function.pipe(
+          validateMultiCommandConfig(extractFromProcessFn, "markdown", generatorConfig),
+          E__namespace.map(() => __spreadValues(__spreadValues({}, configOnlyMarkdownDefaults), generatorConfig))
+        );
+      case "openapi":
+        return _function.pipe(
+          validateMultiCommandConfig(extractFromProcessFn, "openapi", generatorConfig),
+          E__namespace.map(() => __spreadValues(__spreadValues({}, configOnlyOpenApiDefaults), generatorConfig))
+        );
+      case "changelog":
+        return _function.pipe(
+          validateMultiCommandConfig(extractFromProcessFn, "changelog", generatorConfig),
+          E__namespace.map(() => __spreadValues(__spreadValues({}, configOnlyChangelogDefaults), generatorConfig))
+        );
     }
-  }).search();
+  });
+  return E__namespace.sequenceArray(configs);
+}
+function getConfigType(config) {
+  if (!config) {
+    return E__namespace.right({ _type: "no-config" });
+  }
+  const rootKeys = Object.keys(config.config);
+  const validRootKeys = ["markdown", "openapi", "changelog"];
+  const containsAnyValidRootKey = rootKeys.some((key) => validRootKeys.includes(key));
+  if (containsAnyValidRootKey) {
+    const commands = rootKeys.filter((key) => validRootKeys.includes(key));
+    const hasInvalidCommands = rootKeys.some((key) => !validRootKeys.includes(key));
+    if (hasInvalidCommands) {
+      return E__namespace.left(new Error(`Invalid command(s) provided in the configuration file: ${rootKeys}`));
+    }
+    return E__namespace.right({
+      _type: "multi-command-config",
+      commands
+    });
+  }
+  return E__namespace.right({ _type: "single-command-config" });
 }
-function _extractYargs(config) {
-  return yargs__namespace.config(config == null ? void 0 : config.config).command(
+function extractYargsDemandingCommand(extractFromProcessFn, config) {
+  return yargs__namespace.config(config.config).command(
     "markdown",
     "Generate documentation from Apex classes as a Markdown site.",
     (yargs2) => yargs2.options(markdownOptions)
@@ -185,39 +315,77 @@ function _extractYargs(config) {
     "openapi",
     "Generate an OpenApi REST specification from Apex classes.",
     () => yargs__namespace.options(openApiOptions)
-  ).demandCommand().parseSync();
+  ).command(
+    "changelog",
+    "Generate a changelog from 2 versions of the source code.",
+    () => yargs__namespace.options(changeLogOptions)
+  ).demandCommand().parseSync(extractFromProcessFn());
 }
-function extractArgs() {
-  return __async(this, null, function* () {
-    const config = yield _extractConfig();
-    const cliArgs = _extractYargs(config);
-    const commandName = cliArgs._[0];
-    const mergedConfig = __spreadProps(__spreadValues(__spreadValues({}, config == null ? void 0 : config.config), cliArgs), { targetGenerator: commandName });
-    if (mergedConfig.targetGenerator === "markdown") {
-      return __spreadValues(__spreadValues({}, configOnlyDefaults), mergedConfig);
-    } else {
-      return mergedConfig;
+function validateMultiCommandConfig(extractFromProcessFn, command, config) {
+  function getOptions(generator) {
+    switch (generator) {
+      case "markdown":
+        return markdownOptions;
+      case "openapi":
+        return openApiOptions;
+      case "changelog":
+        return changeLogOptions;
     }
-  });
+  }
+  const options = getOptions(command);
+  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) => {
+      throw new Error(`Invalid configuration for command "${command}": ${msg}`);
+    }).parse(extractFromProcessFn());
+  }, E__namespace.toError);
 }
 
+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());
+  });
+};
 const logger = new logger$1.StdOutLogger();
 function main() {
   function parseResult(result) {
-    E__namespace.match(
-      (error) => {
-        logger.error(`\u274C An error occurred while generating the documentation: ${error}`);
-        process.exit(1);
-      },
-      (successMessage) => {
-        logger.logSingle(successMessage);
-      }
-    )(result);
+    E__namespace.match(catchUnexpectedError, (successMessage) => {
+      logger.logSingle(successMessage);
+    })(result);
   }
   function catchUnexpectedError(error) {
-    logger.error(`\u274C An unexpected error occurred: ${error.message}`);
+    logger.error(`\u274C An error occurred while processing the request: ${error}`);
     process.exit(1);
   }
-  extractArgs().then((config) => logger$1.Apexdocs.generate(config, logger).then(parseResult)).catch(catchUnexpectedError);
+  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);
+      }
+    }))(maybeConfigs);
+  })).catch(catchUnexpectedError);
 }
 main();

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+type Generators = 'markdown' | 'openapi' | 'changelog';
+
 type LinkingStrategy =
   // Links will be generated using relative paths.
   | 'relative'
@@ -21,6 +23,7 @@ type UserDefinedMarkdownConfig = {
   linkingStrategy: LinkingStrategy;
   excludeTags: string[];
   referenceGuideTitle: string;
+  exclude: string[];
 } & Partial<ConfigurableHooks>;
 
 type UserDefinedOpenApiConfig = {
@@ -31,9 +34,20 @@ type UserDefinedOpenApiConfig = {
   namespace?: string;
   title: string;
   apiVersion: string;
+  exclude: string[];
+};
+
+type UserDefinedChangelogConfig = {
+  targetGenerator: 'changelog';
+  previousVersionDir: string;
+  currentVersionDir: string;
+  targetDir: string;
+  fileName: string;
+  scope: string[];
+  exclude: string[];
 };
 
-type UserDefinedConfig = UserDefinedMarkdownConfig | UserDefinedOpenApiConfig;
+type UserDefinedConfig = UserDefinedMarkdownConfig | UserDefinedOpenApiConfig | UserDefinedChangelogConfig;
 
 type SourceFileMetadata = {
   filePath: string;
@@ -122,6 +136,16 @@ type TransformDocPage = (
   doc: DocPageData,
 ) => Partial<ConfigurableDocPageData> | Promise<Partial<ConfigurableDocPageData>>;
 
+type CallableConfig = Partial<UserDefinedConfig> & {
+    sourceDir: string;
+    targetGenerator: Generators;
+};
+/**
+ * Processes the documentation generation, similar to the main function in the CLI.
+ * @param config The configuration to use.
+ */
+declare function process(config: CallableConfig): Promise<void>;
+
 type ConfigurableMarkdownConfig = Omit<Partial<UserDefinedMarkdownConfig>, 'targetGenerator'>;
 /**
  * Helper function to define a configuration to generate Markdown documentation.
@@ -134,14 +158,15 @@ type ConfigurableOpenApiConfig = Omit<Partial<UserDefinedOpenApiConfig>, 'target
  * @param config The configuration to use.
  */
 declare function defineOpenApiConfig(config: ConfigurableOpenApiConfig): Partial<UserDefinedOpenApiConfig>;
+type ConfigurableChangelogConfig = Omit<Partial<UserDefinedChangelogConfig>, 'targetGenerator'>;
+/**
+ * Helper function to define a configuration to generate a changelog.
+ * @param config The configuration to use.
+ */
+declare function defineChangelogConfig(config: ConfigurableChangelogConfig): Partial<UserDefinedChangelogConfig>;
 /**
  * Represents a file to be skipped.
  */
 declare function skip(): Skip;
-type CallableConfig = Partial<UserDefinedConfig> & {
-    sourceDir: string;
-    targetGenerator: 'markdown' | 'openapi';
-};
-declare function process(config: CallableConfig): Promise<void>;
 
-export { 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, defineMarkdownConfig, defineOpenApiConfig, process, 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,6 +1,6 @@
 'use strict';
 
-var logger = require('./logger-BATX7-be.js');
+var logger = require('./logger-DIyKhj0a.js');
 var E = require('fp-ts/Either');
 require('fp-ts/function');
 require('fp-ts/TaskEither');
@@ -15,6 +15,7 @@ require('handlebars');
 require('fp-ts/boolean');
 require('fs');
 require('fp-ts/lib/TaskEither');
+require('minimatch');
 require('chalk');
 
 function _interopNamespaceDefault(e) {
@@ -36,25 +37,22 @@ function _interopNamespaceDefault(e) {
 
 var E__namespace = /*#__PURE__*/_interopNamespaceDefault(E);
 
-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) => {
+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.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]);
+    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 __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
 var __async = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
@@ -75,25 +73,10 @@ var __async = (__this, __arguments, generator) => {
     step((generator = generator.apply(__this, __arguments)).next());
   });
 };
-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 skip() {
-  return {
-    _tag: "Skip"
-  };
-}
 function process(config) {
   return __async(this, null, function* () {
     const logger$1 = new logger.NoLogger();
-    const configWithDefaults = __spreadValues(__spreadValues({}, getDefault(config)), config);
+    const configWithDefaults = __spreadValues$1(__spreadValues$1({}, getDefault(config)), config);
     if (!configWithDefaults.sourceDir) {
       throw new Error("sourceDir is required");
     }
@@ -113,11 +96,54 @@ function getDefault(config) {
       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;