fork-version 4.1.7 → 4.1.8

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Fork Version
 
+## [4.1.8](https://github.com/eglavin/fork-version/compare/v4.1.7...v4.1.8) (2026-04-05)
+
+
+### Docs
+
+* update readme with details on commit parser options ([9a8ba6d](https://github.com/eglavin/fork-version/commit/9a8ba6de3dcccfdb1ae62d12792ffc39122342cd))
+
+
+### Refactor
+
+* add detected git host name to schema ([9728a1e](https://github.com/eglavin/fork-version/commit/9728a1efb813436adef0358310ce24469e36f311))
+* extract detect git host to allow expanding options ([b330727](https://github.com/eglavin/fork-version/commit/b330727d4f9d5dfafae5796c20ff57834e56de49))
+* improve git host detection ([d231e6c](https://github.com/eglavin/fork-version/commit/d231e6ca1bf389869602577f843fbf996e3587e3))
+* set commit parser options from detected git host ([840584f](https://github.com/eglavin/fork-version/commit/840584fefc94868457cf3c77979a795133219d64))
+
+
 ## [4.1.7](https://github.com/eglavin/fork-version/compare/v4.1.6...v4.1.7) (2026-03-08)
 
 

package/README.md

@@ -314,12 +314,14 @@ Alternatively you can define your config using a key in your `package.json` file
 | gitTagFallback                                        | boolean          | true                    | If unable to find a version in the given files, fallback and attempt to use the latest git tag                      |
 | sign                                                  | boolean          | false                   | Sign the commit with the systems GPG key                                                                            |
 | verify                                                | boolean          | false                   | Run user defined git hooks before committing                                                                        |
+| asJson                                                | boolean          | false                   | Print inspected output as a parsable json string                                                                    |
 | skipBump                                              | boolean          | false                   | Skip the bump step                                                                                                  |
 | skipChangelog                                         | boolean          | false                   | Skip the changelog step                                                                                             |
 | skipCommit                                            | boolean          | false                   | Skip the commit step                                                                                                |
 | skipTag                                               | boolean          | false                   | Skip the tag step                                                                                                   |
 | [changelogPresetConfig](#configchangelogpresetconfig) | object           | {}                      | Override defaults from the "conventional-changelog-conventionalcommits" preset configuration                        |
 | releaseMessageSuffix                                  | string           | -                       | Add a suffix to the end of the release message                                                                      |
+| [commitParserOptions](#configcommitparseroptions)     | object           | {}                      | Options to pass to commits parser                                                                                   |
 
 ##### config.files
 
@@ -430,6 +432,35 @@ Adds a suffix to the end of the release message, useful to add a `[skip ci]` mes
 - [GitHub Actions - Skipping workflow runs](https://docs.github.com/en/actions/managing-workflow-runs/skipping-workflow-runs)
 - [Azure Devops - Skipping CI for individual pushes](https://learn.microsoft.com/en-us/azure/devops/pipelines/repos/azure-repos-git?view=azure-devops&tabs=yaml#skipping-ci-for-individual-pushes)
 
+##### config.commitParserOptions
+
+The commit parser options allow you to configure the regex patterns used to parse commits. This is useful if your team has a specific commit message format that doesn't match the default conventional commit format.
+
+| Property               | Type           | Description                                       |
+| :--------------------- | :------------- | :------------------------------------------------ |
+| subjectPattern         | Regex          | Pattern to match commit subjects                  |
+| mergePattern           | Regex          | Pattern to match merge commits                    |
+| revertPattern          | Regex          | Pattern to match revert commits                   |
+| commentPattern         | Regex          | Pattern to match commented out lines              |
+| mentionPattern         | Regex          | Pattern to match mentions                         |
+| referenceActions       | Array\<string> | List of action labels to match reference sections |
+| referenceActionPattern | Regex          | Pattern to match reference sections               |
+| issuePrefixes          | Array\<string> | List of issue prefixes to match issue ids         |
+| issuePattern           | Regex          | Pattern to match issue references                 |
+| noteKeywords           | Array\<string> | List of keywords to match note titles             |
+| notePattern            | Regex          | Pattern to match note sections                    |
+
+[View the commit parser options to see the default patterns used.](./src/commit-parser/options.ts)
+
+If you are using one of the following Git hosts, Fork-Version will automatically use the correct commit parser options for that host:
+
+- GitHub
+- GitLab
+- BitBucket
+- Azure DevOps
+
+[View the `detect-git-host` function to see how Fork-Version detects the git host.](./src/detect-git-host/detect-git-host.ts)
+
 ### Supported File Types
 
 - [Json Package](#json-package)

package/dist/{chunk-JYQTKLHN.cjs → chunk-KRGBUNRK.cjs}

@@ -278,10 +278,10 @@ var ForkConfigSchema = zod.z.object({
    */
   verify: zod.z.boolean().describe("If true, git will run user defined git hooks before committing."),
   /**
-   * Output result as JSON.
+   * Print inspected output as a parsable json string.
    * @default false
    */
-  asJson: zod.z.boolean().describe("Output the result as JSON."),
+  asJson: zod.z.boolean().describe("Print inspected output as a parsable json string."),
   // Skip Steps
   //
   /**
@@ -304,17 +304,34 @@ var ForkConfigSchema = zod.z.object({
    * @default false
    */
   skipTag: zod.z.boolean().describe("Skip the tag step."),
+  // Parser Options
+  //
+  /**
+   * The detected git host:
+   * - `GitHub`
+   * - `GitLab`
+   * - `Bitbucket`
+   * - `Azure Devops`
+   * - Or undefined if unknown or not detected.
+   */
+  detectedGitHost: zod.z.string().optional().describe(
+    "The detected git host, such as GitHub, GitLab, Bitbucket, Azure Devops, or undefined if unknown or not detected."
+  ),
   /**
    * Override the default "conventional-changelog-conventionalcommits" preset configuration.
    */
-  changelogPresetConfig: ChangelogPresetConfigSchema.partial().describe(
+  changelogPresetConfig: ChangelogPresetConfigSchema.partial().optional().describe(
     'Override the default "conventional-changelog-conventionalcommits" preset configuration.'
   ),
   /**
    * Add a suffix to the release commit message.
    * @example "[skip ci]"
    */
-  releaseMessageSuffix: zod.z.string().optional().describe("Add a suffix to the release commit message.")
+  releaseMessageSuffix: zod.z.string().optional().describe("Add a suffix to the release commit message."),
+  /**
+   * Options to pass to commits parser.
+   */
+  commitParserOptions: zod.z.looseObject().optional().describe("Options to pass to commits parser.")
 });
 
 // src/utils/escape-regex.ts
@@ -591,7 +608,7 @@ ${SCISSOR}
     return splitCommits;
   }
 };
-function getChangelogPresetConfig(mergedConfig, cliArguments, detectedGitHost) {
+function getChangelogPresetConfig(mergedConfig, cliArguments, detectedChangelogOptions) {
   const preset = {
     name: "conventionalcommits"
   };
@@ -615,8 +632,8 @@ function getChangelogPresetConfig(mergedConfig, cliArguments, detectedGitHost) {
       }
     });
   }
-  if (detectedGitHost) {
-    Object.entries(detectedGitHost).forEach(([key, value]) => {
+  if (detectedChangelogOptions) {
+    Object.entries(detectedChangelogOptions).forEach(([key, value]) => {
       if (value !== void 0) {
         preset[key] = value;
       }
@@ -692,41 +709,175 @@ All notable changes to this project will be documented in this file. See [fork-v
   skipBump: false,
   skipChangelog: false,
   skipCommit: false,
-  skipTag: false,
-  changelogPresetConfig: {}
+  skipTag: false
 };
 
-// src/config/detect-git-host.ts
-async function detectGitHost(path) {
-  const remoteUrl = await new Git({ path }).getRemoteUrl();
-  if (remoteUrl.startsWith("https://") && remoteUrl.includes("@dev.azure.com/")) {
-    const match = /^https:\/\/(?<atorganisation>.*?)@dev.azure.com\/(?<organisation>.*?)\/(?<project>.*?)\/_git\/(?<repository>.*?)(?:\.git)?$/.exec(
+// src/detect-git-host/host-github.ts
+function detectGitHubOptions(remoteUrl) {
+  let matches = null;
+  if (/^https:\/\/(.*)?github\.com/.test(remoteUrl)) {
+    matches = /^https:\/\/(.*)?github\.com\/(?<organisation>.*?)\/(?<repository>.*?)(?:\.git)?$/.exec(
+      remoteUrl
+    );
+  } else if (remoteUrl.startsWith("git@github.com:")) {
+    matches = /^git@github\.com:(?<organisation>.*?)\/(?<repository>.*?)(?:\.git)?$/.exec(
+      remoteUrl
+    );
+  }
+  if (matches?.groups) {
+    const { organisation = "", repository = "" } = matches.groups;
+    return {
+      hostName: "GitHub",
+      changelogOptions: {
+        commitUrlFormat: `https://github.com/${organisation}/${repository}/commit/{{hash}}`,
+        compareUrlFormat: `https://github.com/${organisation}/${repository}/compare/{{previousTag}}...{{currentTag}}`,
+        issueUrlFormat: `https://github.com/${organisation}/${repository}/issues/{{id}}`,
+        issuePrefixes: ["#", "gh-"]
+      },
+      commitParserOptions: {
+        mergePattern: /^Merge pull request #(?<id>\d*) from (?<source>.*)/i,
+        issuePrefixes: ["#", "gh-"]
+      }
+    };
+  }
+  return void 0;
+}
+
+// src/detect-git-host/host-gitlab.ts
+function detectGitlabOptions(remoteUrl) {
+  let matches = null;
+  if (/^https:\/\/(.*)?gitlab\.com/.test(remoteUrl)) {
+    matches = /^https:\/\/(.*)?gitlab\.com\/(?<organisation>.*?)\/(?<repository>.*?)(?:\.git)?$/.exec(
+      remoteUrl
+    );
+  } else if (remoteUrl.startsWith("git@gitlab.com:")) {
+    matches = /^git@gitlab\.com:(?<organisation>.*?)\/(?<repository>.*?)(?:\.git)?$/.exec(
+      remoteUrl
+    );
+  }
+  if (matches?.groups) {
+    const { organisation = "", repository = "" } = matches.groups;
+    return {
+      hostName: "GitLab",
+      changelogOptions: {
+        commitUrlFormat: `https://gitlab.com/${organisation}/${repository}/-/commit/{{hash}}`,
+        compareUrlFormat: `https://gitlab.com/${organisation}/${repository}/-/compare/{{previousTag}}...{{currentTag}}`,
+        issueUrlFormat: `https://gitlab.com/${organisation}/${repository}/-/issues/{{id}}`
+      },
+      commitParserOptions: {
+        mergePattern: /^Merge branch '(?<source>.*)' into '(.*)'/i,
+        // https://docs.gitlab.com/user/project/issues/managing_issues/#default-closing-pattern
+        referenceActions: [
+          "close",
+          "closes",
+          "closed",
+          "closing",
+          "fix",
+          "fixes",
+          "fixed",
+          "fixing",
+          "resolve",
+          "resolves",
+          "resolved",
+          "resolving",
+          "implement",
+          "implements",
+          "implemented",
+          "implementing"
+        ]
+      }
+    };
+  }
+  return void 0;
+}
+
+// src/detect-git-host/host-bitbucket.ts
+function detectBitbucketOptions(remoteUrl) {
+  let matches = null;
+  if (/^https:\/\/(.*)?bitbucket\.(org|com)/.test(remoteUrl)) {
+    matches = /^https:\/\/(.*)?bitbucket\.(?<domain>org|com)\/(?<organisation>.*?)\/(?<repository>.*?)(?:\.git)?$/.exec(
+      remoteUrl
+    );
+  } else if (remoteUrl.startsWith("git@bitbucket.org:")) {
+    matches = /^git@bitbucket\.(?<domain>org|com):(?<organisation>.*?)\/(?<repository>.*?)(?:\.git)?$/.exec(
+      remoteUrl
+    );
+  }
+  if (matches?.groups) {
+    const { domain = "", organisation = "", repository = "" } = matches.groups;
+    return {
+      hostName: "Bitbucket",
+      changelogOptions: {
+        commitUrlFormat: `https://bitbucket.${domain}/${organisation}/${repository}/commits/{{hash}}`,
+        compareUrlFormat: `https://bitbucket.${domain}/${organisation}/${repository}/branches/compare/{{currentTag}}..{{previousTag}}`,
+        // Bitbucket doesn't have a builtin issue tracker like GitHub or GitLab, this should be overridden by the user if they want to link to issues in their changelog.
+        issueUrlFormat: `https://bitbucket.${domain}/${organisation}/${repository}/issues/{{id}}`
+      },
+      commitParserOptions: {
+        mergePattern: /^Merged in (?<source>.*) \(pull request #(?<id>\d*)\)/i
+      }
+    };
+  }
+  return void 0;
+}
+
+// src/detect-git-host/host-azure-devops.ts
+function detectAzureDevopsOptions(remoteUrl) {
+  let matches = null;
+  if (/^https:\/\/(.*)?dev\.azure\.com/.test(remoteUrl)) {
+    matches = /^https:\/\/(.*)?dev\.azure\.com\/(?<organisation>.*?)\/(?<project>.*?)\/_git\/(?<repository>.*?)(?:\.git)?$/.exec(
       remoteUrl
     );
-    if (match?.groups) {
-      const { organisation = "", project = "", repository = "" } = match.groups;
-      return {
-        detectedGitHost: "Azure",
-        commitUrlFormat: `{{host}}/${organisation}/${project}/_git/${repository}/commit/{{hash}}`,
-        compareUrlFormat: `{{host}}/${organisation}/${project}/_git/${repository}/branchCompare?baseVersion=GT{{previousTag}}&targetVersion=GT{{currentTag}}`,
-        issueUrlFormat: `{{host}}/${organisation}/${project}/_workitems/edit/{{id}}`
-      };
-    }
   } else if (remoteUrl.startsWith("git@ssh.dev.azure.com:")) {
-    const match = /^git@ssh.dev.azure.com:v\d\/(?<organisation>.*?)\/(?<project>.*?)\/(?<repository>.*?)(?:\.git)?$/.exec(
+    matches = /^git@ssh\.dev\.azure\.com:v\d\/(?<organisation>.*?)\/(?<project>.*?)\/(?<repository>.*?)(?:\.git)?$/.exec(
       remoteUrl
     );
-    if (match?.groups) {
-      const { organisation = "", project = "", repository = "" } = match.groups;
-      return {
-        detectedGitHost: "Azure",
-        commitUrlFormat: `{{host}}/${organisation}/${project}/_git/${repository}/commit/{{hash}}`,
-        compareUrlFormat: `{{host}}/${organisation}/${project}/_git/${repository}/branchCompare?baseVersion=GT{{previousTag}}&targetVersion=GT{{currentTag}}`,
-        issueUrlFormat: `{{host}}/${organisation}/${project}/_workitems/edit/{{id}}`
-      };
+  }
+  if (matches?.groups) {
+    const { organisation = "", project = "", repository = "" } = matches.groups;
+    return {
+      hostName: "Azure Devops",
+      changelogOptions: {
+        commitUrlFormat: `https://dev.azure.com/${organisation}/${project}/_git/${repository}/commit/{{hash}}`,
+        compareUrlFormat: `https://dev.azure.com/${organisation}/${project}/_git/${repository}/branchCompare?baseVersion=GT{{previousTag}}&targetVersion=GT{{currentTag}}`,
+        issueUrlFormat: `https://dev.azure.com/${organisation}/${project}/_workitems/edit/{{id}}`
+      },
+      commitParserOptions: {
+        mergePattern: /^Merged PR (?<id>\d*): (?<source>.*)/i
+      }
+    };
+  }
+  return void 0;
+}
+
+// src/detect-git-host/detect-git-host.ts
+async function detectGitHost(path) {
+  const remoteUrl = await new Git({ path }).getRemoteUrl();
+  if (remoteUrl.includes("github.com")) {
+    const githubOptions = detectGitHubOptions(remoteUrl);
+    if (githubOptions) {
+      return githubOptions;
+    }
+  }
+  if (remoteUrl.includes("gitlab.com")) {
+    const gitlabOptions = detectGitlabOptions(remoteUrl);
+    if (gitlabOptions) {
+      return gitlabOptions;
+    }
+  }
+  if (/bitbucket\.(org|com)/.test(remoteUrl)) {
+    const bitbucketOptions = detectBitbucketOptions(remoteUrl);
+    if (bitbucketOptions) {
+      return bitbucketOptions;
+    }
+  }
+  if (remoteUrl.includes("dev.azure.com")) {
+    const azureDevopsOptions = detectAzureDevopsOptions(remoteUrl);
+    if (azureDevopsOptions) {
+      return azureDevopsOptions;
     }
   }
-  return null;
+  return void 0;
 }
 var PACKAGE_JSON_CONFIG_KEY = "fork-version";
 async function loadConfigFile(cwd) {
@@ -813,11 +964,6 @@ async function getUserConfig(cliArguments) {
   }
   const files = mergeFiles(configFile?.files, cliArguments.flags.files, globResults);
   const detectedGitHost = await detectGitHost(cwd);
-  const changelogPresetConfig = getChangelogPresetConfig(
-    mergedConfig,
-    cliArguments.flags,
-    detectedGitHost
-  );
   let command = DEFAULT_CONFIG.command;
   if (cliArguments.input.length > 0 && cliArguments.input[0].trim()) {
     command = cliArguments.input[0].trim().toLowerCase();
@@ -838,7 +984,16 @@ async function getUserConfig(cliArguments) {
       cliArguments.flags.preReleaseTag ?? cliArguments.flags.preRelease ?? configFile.preRelease
     ),
     silent: shouldBeSilent || mergedConfig.silent,
-    changelogPresetConfig
+    detectedGitHost: detectedGitHost?.hostName,
+    changelogPresetConfig: getChangelogPresetConfig(
+      mergedConfig,
+      cliArguments.flags,
+      detectedGitHost?.changelogOptions
+    ),
+    commitParserOptions: {
+      ...detectedGitHost?.commitParserOptions,
+      ...mergedConfig.commitParserOptions
+    }
   };
 }
 var Logger = class {
@@ -1677,7 +1832,7 @@ function cleanTag(tag, tagPrefix) {
 
 // src/process/get-commits.ts
 async function getCommitsSinceTag(config, logger, git) {
-  const commitParser = new CommitParser();
+  const commitParser = new CommitParser(config.commitParserOptions);
   if (config.debug) commitParser.setLogger(logger);
   const latestTag = await git.getMostRecentTag(config.tagPrefix);
   if (!latestTag) {
@@ -2105,5 +2260,5 @@ exports.main = main;
 exports.tagChanges = tagChanges;
 exports.updateChangelog = updateChangelog;
 exports.validateConfig = validateConfig;
-//# sourceMappingURL=chunk-JYQTKLHN.cjs.map
-//# sourceMappingURL=chunk-JYQTKLHN.cjs.map
+//# sourceMappingURL=chunk-KRGBUNRK.cjs.map
+//# sourceMappingURL=chunk-KRGBUNRK.cjs.map