fork-version 4.1.4 → 4.1.8

package/CHANGELOG.md

@@ -1,5 +1,45 @@
 # 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)
+
+
+### Refactor
+
+* improve inspect command ([0b78aab](https://github.com/eglavin/fork-version/commit/0b78aab5dd9be49ffccba173fdb99e13eac52fbd))
+
+
+## [4.1.6](https://github.com/eglavin/fork-version/compare/v4.1.5...v4.1.6) (2026-03-08)
+
+
+### Refactor
+
+* remove duplicate get tags function ([ec2962a](https://github.com/eglavin/fork-version/commit/ec2962a99f0da0335079ef6fa677f3023325cdcf))
+
+
+## [4.1.5](https://github.com/eglavin/fork-version/compare/v4.1.4...v4.1.5) (2026-03-08)
+
+
+### Refactor
+
+* remove typescript member visibility modifiers in favour of private fields ([c2e0749](https://github.com/eglavin/fork-version/commit/c2e07494bb2af69f04c0ecfc13eb342705c904aa))
+
+
 ## [4.1.4](https://github.com/eglavin/fork-version/compare/v4.1.3...v4.1.4) (2026-03-08)
 
 

package/README.md

@@ -94,8 +94,9 @@ Fork-Version has a number of command modes which will make the program behave di
 | Command             | Description                                                            |
 | ------------------- | ---------------------------------------------------------------------- |
 | `main`              | Bumps the version, update files, generate changelog, commits, and tag. |
-| `inspect-version`   | Prints the current version and exit.                                   |
-| `inspect-tag`       | Prints the current git tag and exit.                                   |
+| `inspect`           | Print the current version and git tag, then exit.                       |
+| `inspect-version`   | Print the current version then exit.                                   |
+| `inspect-tag`       | Print the current git tag then exit.                                   |
 | `validate-config`   | Validates the configuration and exit.                                  |
 
 ### Exit Codes
@@ -121,8 +122,9 @@ Usage:
 
 Commands:
   main                             Bumps the version, update files, generate changelog, commit, and tag. [Default when no command is provided]
-  inspect-version                  Prints the current version and exits.
-  inspect-tag                      Prints the current git tag and exits.
+  inspect                          Print the current version and git tag, then exits.
+  inspect-version                  Print the current version then exits.
+  inspect-tag                      Print the current git tag then exits.
   validate-config                  Validates the configuration and exits.
 
 General Options:
@@ -154,6 +156,7 @@ Flags:
   --git-tag-fallback               If unable to find a version in the given files, fallback and attempt to use the latest git tag. [Default: true]
   --sign                           If true, git will sign the commit with the systems GPG key.
   --verify                         If true, git will run user defined git hooks before committing.
+  --as-json                        Output the result as JSON.
 
   To negate a flag you can prefix it with "no-", for example "--no-git-tag-fallback" will not fallback to the latest git tag.
 
@@ -311,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
 
@@ -427,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)