From 2eae2f1f1f258b6c270e544d12fae1b150fb2610 Mon Sep 17 00:00:00 2001
From: Jeroen Claassens <support@favware.tech>
Date: Sat, 7 Sep 2024 10:44:53 +0200
Subject: [PATCH] feat(npm): add missing options and document all options with
 tsdoc comments

---
 npm/git-cliff/src/options.ts | 79 ++++++++++++++++++++++++++++++++----
 1 file changed, 71 insertions(+), 8 deletions(-)

diff --git a/npm/git-cliff/src/options.ts b/npm/git-cliff/src/options.ts
index 4d43a6f1bf..addc33025c 100644
--- a/npm/git-cliff/src/options.ts
+++ b/npm/git-cliff/src/options.ts
@@ -1,29 +1,92 @@
 export type Options = Partial<{
+  //#region Flags
+  /** Prints help information */
   help: boolean;
+  /** Prints version information */
   version: boolean;
+  /** Increases the logging verbosity */
   verbose: boolean;
+  /** Prints bumped version for unreleased changes */
+  bumpedVersion: boolean;
+  /** Processes the commits starting from the latest tag */
+  latest: boolean;
+  /** Processes the commits that belong to the current tag */
+  current: boolean;
+  /** Processes the commits that do not belong to a tag */
+  unreleased: boolean;
+  /** Sorts the tags topologically */
+  topoOrder: boolean;
+  /** Disables the external command execution */
+  noExec: boolean;
+  /** Prints changelog context as JSON */
+  context: boolean;
+  //#endregion
+
+  //#region Options
+  /** Writes the default configuration file to cliff.toml */
   init: boolean | string;
+  /**
+   * Bumps the version for unreleased changes
+   * @default 'auto'
+   */
+  bump: "auto" | "major" | "minor" | "patch";
+  /**
+   * Sets the configuration file
+   * @default 'cliff.toml'
+   */
   config: string;
+  /** Sets the working directory */
   workdir: string;
+  /** Sets the git repository */
   repository: string;
+  /** Sets the path to include related commits */
   includePath: string;
+  /** Sets the path to exclude related commits */
   excludePath: string;
+  /** Sets the regex for matching git tags */
+  tagPattern: string;
+  /** Sets custom commit messages to include in the changelog */
   withCommit: string;
+  /** Sets custom message for the latest release */
+  withTagMessage: string;
+  /** Sets the tags to ignore in the changelog */
+  ignoreTags: string | string[];
+  /** Sets the tags to count in the changelog */
+  countTags: string | string[];
+  /** Sets commits that will be skipped in the changelog */
   skipCommit: string | string[];
+  /** Prepends entries to the given changelog file */
   prepend: string;
+  /** Writes output to the given file */
   output: string;
+  /** Sets the tag for the latest version */
   tag: string;
-  bump: boolean;
-  bumpedVersion: boolean;
+  /** Sets the template for the changelog body */
   body: string;
-  latest: boolean;
-  current: boolean;
-  unreleased: boolean;
-  topoOrder: boolean;
-  noExec: boolean;
-  context: boolean;
+  /** Generates changelog from a JSON context */
+  fromContext: string;
+  /** Strips the given parts from the changelog */
   strip: "header" | "footer" | "all";
+  /**
+   * Sets sorting of the commits inside sections
+   * @default 'oldest'
+   */
   sort: "oldest" | "newest";
+  /** Sets the GitHub API token */
   githubToken: string;
+  /** Sets the GitHub repository */
   githubRepo: string;
+  /** Sets the GitLab API token */
+  gitlabToken: string;
+  /** Sets the GitLab repository */
+  gitlabRepo: string;
+  /** Sets the Gitea API token */
+  giteaToken: string;
+  /** Sets the Gitea repository */
+  giteaRepo: string;
+  /** Sets the Bitbucket API token */
+  bitbucketToken: string;
+  /** Sets the Bitbucket repository */
+  bitbucketRepo: string;
+  //#endregion
 }>;