fork-version 5.1.3 → 5.1.5

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Fork Version
 
+## [5.1.5](https://github.com/eglavin/fork-version/compare/v5.1.4...v5.1.5) (2026-04-26)
+
+
+### Refactor
+
+* set no-color and date-order opts when getting commits ([2756155](https://github.com/eglavin/fork-version/commit/27561551745da68f7eaa2b298a2a34b803cc2a6d))
+
+
+### Test
+
+* add test for long running branch scenario ([4dfcbbc](https://github.com/eglavin/fork-version/commit/4dfcbbcec5a27a8baf66dff440b58d9d6ef864f9))
+* tag out of order commit test as skippable when not running in e2e mode ([b7d67e3](https://github.com/eglavin/fork-version/commit/b7d67e3fd5cfaccccffd2173473dfd85d2dc2728))
+
+
+## [5.1.4](https://github.com/eglavin/fork-version/compare/v5.1.3...v5.1.4) (2026-04-18)
+
+
+### Refactor
+
+* add defineFileManager function ([6e0f437](https://github.com/eglavin/fork-version/commit/6e0f4371824a232f85880a80b218d13b3decb25f))
+
+
 ## [5.1.3](https://github.com/eglavin/fork-version/compare/v5.1.2...v5.1.3) (2026-04-18)
 
 

package/README.md

@@ -574,6 +574,9 @@ Example `test.json` file:
 
 Example Custom File Manager implementation:
 
+- [Using a class to define a file manager](./examples/custom-file-manager/fork.config.ts)
+- [Using the defineFileManager function](./examples/custom-file-manager/fork.config.defineFileManager.ts)
+
 ```ts
 // fork.config.ts
 import { readFile, writeFile } from "node:fs/promises";

package/dist/files/file-manager.d.ts

@@ -61,6 +61,12 @@ interface IFileManager {
    */
   isSupportedFile(filePath: string): boolean;
 }
+/**
+ * Helper function to define a custom file manager with proper typing.
+ *
+ * [Fork-Version - Custom File Managers](https://github.com/eglavin/fork-version#custom-file-updaters)
+ */
+declare function defineFileManager(fileManager: IFileManager): IFileManager;
 declare class FileManager {
   #private;
   constructor(config: ForkConfig, logger: Logger);
@@ -90,4 +96,4 @@ declare class FileManager {
   write(fileState: FileState, newVersion: string): Promise<void>;
 }
 //#endregion
-export { FileManager, FileState, IFileManager, MissingPropertyException };
+export { FileManager, FileState, IFileManager, MissingPropertyException, defineFileManager };

package/dist/files/file-manager.js

@@ -22,6 +22,14 @@ var MissingPropertyException = class extends Error {
 		this.propertyName = propertyName;
 	}
 };
+/**
+* Helper function to define a custom file manager with proper typing.
+*
+* [Fork-Version - Custom File Managers](https://github.com/eglavin/fork-version#custom-file-updaters)
+*/
+function defineFileManager(fileManager) {
+	return fileManager;
+}
 var FileManager = class {
 	#config;
 	#logger;
@@ -97,4 +105,4 @@ var FileManager = class {
 	}
 };
 //#endregion
-export { FileManager, MissingPropertyException };
+export { FileManager, MissingPropertyException, defineFileManager };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { ParserOptions, createParserOptions } from "./commit-parser/options.js";
 import { Logger } from "./services/logger.js";
-import { FileManager, FileState, IFileManager, MissingPropertyException } from "./files/file-manager.js";
+import { FileManager, FileState, IFileManager, MissingPropertyException, defineFileManager } from "./files/file-manager.js";
 import { ChangelogPresetConfig, ChangelogPresetConfigType, Config, ForkConfig } from "./config/types.js";
 import { Git } from "./services/git.js";
 import { inspect } from "./commands/inspect.js";
@@ -18,4 +18,4 @@ import { NextVersion, getNextVersion } from "./process/get-next-version.js";
 import { updateChangelog } from "./process/changelog.js";
 import { commitChanges } from "./process/commit.js";
 import { tagChanges } from "./process/tag.js";
-export { type ChangelogPresetConfig, type ChangelogPresetConfigType, type Commit, type CommitMerge, type CommitNote, CommitParser, type CommitReference, type CommitRevert, type CommitsSinceTag, type Config, type CurrentVersion, FileManager, type FileState, type ForkConfig, ForkConfigJSONSchema, ForkConfigJSSchema, Git, type IFileManager, Logger, MissingPropertyException, type NextVersion, type ParserOptions, commitChanges, createParserOptions, defineConfig, filterRevertedCommits, getCommitsSinceTag, getCurrentVersion, getNextVersion, getUserConfig, inspect, main, tagChanges, updateChangelog, validateConfig };
+export { type ChangelogPresetConfig, type ChangelogPresetConfigType, type Commit, type CommitMerge, type CommitNote, CommitParser, type CommitReference, type CommitRevert, type CommitsSinceTag, type Config, type CurrentVersion, FileManager, type FileState, type ForkConfig, ForkConfigJSONSchema, ForkConfigJSSchema, Git, type IFileManager, Logger, MissingPropertyException, type NextVersion, type ParserOptions, commitChanges, createParserOptions, defineConfig, defineFileManager, filterRevertedCommits, getCommitsSinceTag, getCurrentVersion, getNextVersion, getUserConfig, inspect, main, tagChanges, updateChangelog, validateConfig };

package/dist/index.js

@@ -14,6 +14,6 @@ import { ForkConfigJSONSchema, ForkConfigJSSchema } from "./config/schema.js";
 import { defineConfig } from "./config/define-config.js";
 import { Git } from "./services/git.js";
 import { getUserConfig } from "./config/user-config.js";
-import { FileManager, MissingPropertyException } from "./files/file-manager.js";
+import { FileManager, MissingPropertyException, defineFileManager } from "./files/file-manager.js";
 import { Logger } from "./services/logger.js";
-export { CommitParser, FileManager, ForkConfigJSONSchema, ForkConfigJSSchema, Git, Logger, MissingPropertyException, commitChanges, createParserOptions, defineConfig, filterRevertedCommits, getCommitsSinceTag, getCurrentVersion, getNextVersion, getUserConfig, inspect, main, tagChanges, updateChangelog, validateConfig };
+export { CommitParser, FileManager, ForkConfigJSONSchema, ForkConfigJSSchema, Git, Logger, MissingPropertyException, commitChanges, createParserOptions, defineConfig, defineFileManager, filterRevertedCommits, getCommitsSinceTag, getCurrentVersion, getNextVersion, getUserConfig, inspect, main, tagChanges, updateChangelog, validateConfig };

package/dist/services/git.d.ts

@@ -87,35 +87,33 @@ declare class Git {
    */
   getRemoteUrl(): Promise<string>;
   /**
-   * `getTags` returns valid semver version tags in order of the commit history
+   * Returns an array of tags from the git log, filtered by an optional tag prefix and pre-release configuration.
    *
-   * Using `git log` to get the commit history, we then parse the tags from the
-   * commit details which is expected to be in the following format:
-   * ```txt
-   * commit 3841b1d05750d42197fe958e3d8e06df378a842d (HEAD -> main, tag: v1.0.2, tag: v1.0.1, tag: v1.0.0)
-   * Author: Username <username@example.com>
-   * Date:   Sat Nov 9 15:00:00 2024 +0000
+   * @example
+   * ```ts
+   * // Given the following git log: (HEAD -> main, tag: v1.0.2, tag: v1.0.1, tag: v1.0.0)
+   * await git.getTags("v"); // ["v1.0.2", "v1.0.1", "v1.0.0"]
+   *
+   * // Given the following git log: (HEAD -> main, tag: v1.0.2-0, tag: v1.0.1-0, tag: v1.0.0)
+   * await git.getTags("v", true); // ["v1.0.2-0", "v1.0.1-0", "v1.0.0"]
    *
-   *     chore(release): v1.0.0
+   * // Given the following git log: (HEAD -> main, tag: v1.0.2-alpha.0, tag: v1.0.1-alpha.0, tag: v1.0.0)
+   * await git.getTags("v", "alpha"); // ["v1.0.2-alpha.0", "v1.0.1-alpha.0", "v1.0.0"]
    * ```
    *
    * - [Functionality extracted from the conventional-changelog - git-semver-tags project](https://github.com/conventional-changelog/conventional-changelog/blob/fac8045242099c016f5f3905e54e02b7d466bd7b/packages/git-semver-tags/index.js)
    * - [conventional-changelog git-semver-tags MIT Licence](https://github.com/conventional-changelog/conventional-changelog/blob/fac8045242099c016f5f3905e54e02b7d466bd7b/packages/git-semver-tags/LICENSE.md)
-   *
-   * @example
-   * ```ts
-   * await git.getTags("v"); // ["v1.0.2", "v1.0.1", "v1.0.0"]
-   * ```
    */
   getTags(tagPrefix?: string, preRelease?: string | boolean): Promise<string[]>;
   /**
-   * Get commit history in a parsable format
+   * Returns an array of commits between two git references (e.g., tags, branches, or commits), optionally filtered by file paths.
    *
-   * An array of strings with commit details is returned in the following format:
+   * Each commit in the returned array is a string containing the following information, separated by newlines:
    * ```txt
    * subject
    * body
    * hash
+   * ref names
    * committer date
    * committer name
    * committer email
@@ -123,6 +121,7 @@ declare class Git {
    *
    * @example
    * ```ts
+   * await git.getCommits("v1.0.0", "HEAD");
    * await git.getCommits("v1.0.0", "HEAD", "src/utils");
    * ```
    */

package/dist/services/git.js

@@ -180,28 +180,25 @@ var Git = class {
 		return false;
 	}
 	/**
-	* `getTags` returns valid semver version tags in order of the commit history
+	* Returns an array of tags from the git log, filtered by an optional tag prefix and pre-release configuration.
 	*
-	* Using `git log` to get the commit history, we then parse the tags from the
-	* commit details which is expected to be in the following format:
-	* ```txt
-	* commit 3841b1d05750d42197fe958e3d8e06df378a842d (HEAD -> main, tag: v1.0.2, tag: v1.0.1, tag: v1.0.0)
-	* Author: Username <username@example.com>
-	* Date:   Sat Nov 9 15:00:00 2024 +0000
+	* @example
+	* ```ts
+	* // Given the following git log: (HEAD -> main, tag: v1.0.2, tag: v1.0.1, tag: v1.0.0)
+	* await git.getTags("v"); // ["v1.0.2", "v1.0.1", "v1.0.0"]
+	*
+	* // Given the following git log: (HEAD -> main, tag: v1.0.2-0, tag: v1.0.1-0, tag: v1.0.0)
+	* await git.getTags("v", true); // ["v1.0.2-0", "v1.0.1-0", "v1.0.0"]
 	*
-	*     chore(release): v1.0.0
+	* // Given the following git log: (HEAD -> main, tag: v1.0.2-alpha.0, tag: v1.0.1-alpha.0, tag: v1.0.0)
+	* await git.getTags("v", "alpha"); // ["v1.0.2-alpha.0", "v1.0.1-alpha.0", "v1.0.0"]
 	* ```
 	*
 	* - [Functionality extracted from the conventional-changelog - git-semver-tags project](https://github.com/conventional-changelog/conventional-changelog/blob/fac8045242099c016f5f3905e54e02b7d466bd7b/packages/git-semver-tags/index.js)
 	* - [conventional-changelog git-semver-tags MIT Licence](https://github.com/conventional-changelog/conventional-changelog/blob/fac8045242099c016f5f3905e54e02b7d466bd7b/packages/git-semver-tags/LICENSE.md)
-	*
-	* @example
-	* ```ts
-	* await git.getTags("v"); // ["v1.0.2", "v1.0.1", "v1.0.0"]
-	* ```
 	*/
 	async getTags(tagPrefix, preRelease) {
-		const logOutput = await this.log("--decorate", "--no-color", "--date-order");
+		const logOutput = await this.log("--format=%d", "--no-color", "--date-order");
 		/**
 		* Search for tags in the following formats:
 		* @example "tag: 1.2.3," or "tag: 1.2.3)"
@@ -221,13 +218,14 @@ var Git = class {
 		return tags;
 	}
 	/**
-	* Get commit history in a parsable format
+	* Returns an array of commits between two git references (e.g., tags, branches, or commits), optionally filtered by file paths.
 	*
-	* An array of strings with commit details is returned in the following format:
+	* Each commit in the returned array is a string containing the following information, separated by newlines:
 	* ```txt
 	* subject
 	* body
 	* hash
+	* ref names
 	* committer date
 	* committer name
 	* committer email
@@ -235,6 +233,7 @@ var Git = class {
 	*
 	* @example
 	* ```ts
+	* await git.getCommits("v1.0.0", "HEAD");
 	* await git.getCommits("v1.0.0", "HEAD", "src/utils");
 	* ```
 	*/
@@ -250,7 +249,7 @@ var Git = class {
 			"%cE",
 			SCISSOR
 		].join("%n");
-		const splitCommits = (await this.log(`--format=${LOG_FORMAT}`, [from, to].filter(Boolean).join(".."), paths.length ? "--" : "", ...paths)).split(`\n${SCISSOR}\n`);
+		const splitCommits = (await this.log(`--format=${LOG_FORMAT}`, "--no-color", "--date-order", [from, to].filter(Boolean).join(".."), paths.length ? "--" : "", ...paths)).split(`\n${SCISSOR}\n`);
 		if (splitCommits.length === 0) return splitCommits;
 		if (splitCommits[0] === SCISSOR) splitCommits.shift();
 		if (splitCommits[splitCommits.length - 1] === "") splitCommits.pop();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fork-version",
-  "version": "5.1.3",
+  "version": "5.1.5",
   "license": "MIT",
   "description": "Fork-Version automates version control tasks such as determining, updating, and committing versions, files, and changelogs, simplifying the process when adhering to the conventional commit standard.",
   "keywords": [