fork-version 5.1.2 → 5.1.4

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Fork Version
 
+## [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)
+
+
+### Bug Fixes
+
+* filter unrelated prerelease tags to ensure out of order prereleases are handled bumped correctly ([1440272](https://github.com/eglavin/fork-version/commit/1440272dd55900945fae66539637d14b9b702b9b))
+
+
 ## [5.1.2](https://github.com/eglavin/fork-version/compare/v5.1.1...v5.1.2) (2026-04-13)
 
 

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/process/get-commits.d.ts

@@ -5,6 +5,7 @@ import { Commit } from "../commit-parser/types.js";
 
 //#region src/process/get-commits.d.ts
 interface CommitsSinceTag {
+  tags: string[];
   latestTag: string | undefined;
   latestTagVersion: string | undefined;
   commits: Commit[];

package/dist/process/get-commits.js

@@ -5,7 +5,8 @@ import { cleanTag } from "../utils/clean-tag.js";
 async function getCommitsSinceTag(config, logger, git) {
 	const commitParser = new CommitParser(config.commitParserOptions);
 	if (config.debug) commitParser.setLogger(logger);
-	const latestTag = await git.getMostRecentTag(config.tagPrefix);
+	const tags = await git.getTags(config.tagPrefix, config.preRelease);
+	const latestTag = tags.length > 0 ? tags[0] : void 0;
 	if (!latestTag) logger.warn("No previous tag found, using all commits");
 	const foundCommits = await git.getCommits(latestTag, "HEAD");
 	const commits = foundCommits.reduce((acc, commit) => {
@@ -16,6 +17,7 @@ async function getCommitsSinceTag(config, logger, git) {
 	const filteredCommits = filterRevertedCommits(commits);
 	logger.debug(`Found ${foundCommits.length} commits since tag: ${latestTag ?? "none"} (${commits.length} parsed, ${filteredCommits.length} after filtering reverts)`);
 	return {
+		tags,
 		latestTag,
 		latestTagVersion: cleanTag(latestTag, config.tagPrefix),
 		commits: filteredCommits

package/dist/services/git.d.ts

@@ -107,16 +107,7 @@ declare class Git {
    * await git.getTags("v"); // ["v1.0.2", "v1.0.1", "v1.0.0"]
    * ```
    */
-  getTags(tagPrefix: string | undefined): Promise<string[]>;
-  /**
-   * Returns the most recent tag from the commit history, or `undefined` if no valid semver tags are found
-   *
-   * @example
-   * ```ts
-   * await git.getMostRecentTag("v"); // "1.2.3"
-   * ```
-   */
-  getMostRecentTag(tagPrefix: string | undefined): Promise<string | undefined>;
+  getTags(tagPrefix?: string, preRelease?: string | boolean): Promise<string[]>;
   /**
    * Get commit history in a parsable format
    *

package/dist/services/git.js

@@ -1,4 +1,4 @@
-import { escapeRegex } from "../utils/escape-regex.js";
+import { cleanTag } from "../utils/clean-tag.js";
 import semver from "semver";
 import { execFile } from "node:child_process";
 //#region src/services/git.ts
@@ -16,7 +16,6 @@ var Git = class {
 		this.getBranchName = this.getBranchName.bind(this);
 		this.getRemoteUrl = this.getRemoteUrl.bind(this);
 		this.getTags = this.getTags.bind(this);
-		this.getMostRecentTag = this.getMostRecentTag.bind(this);
 		this.getCommits = this.getCommits.bind(this);
 	}
 	async #execGit(command, args) {
@@ -143,6 +142,44 @@ var Git = class {
 		}
 	}
 	/**
+	* Determine if a tag should be included based on the preRelease configuration.
+	*
+	* Example prerelease tags:
+	* - `1.2.3-alpha.0`
+	* - `1.2.3-beta.0`
+	* - `1.2.3-0`
+	*
+	* @example
+	* ```ts
+	* const tags = ["1.0.1-0", "1.0.1-alpha.0", "1.0.0"];
+	*
+	* shouldIncludeTag("1.0.1-0", true); // true
+	* shouldIncludeTag("1.0.1-alpha.0", true); // false
+	* shouldIncludeTag("1.0.0", true); // true
+	*
+	* shouldIncludeTag("1.0.1-0", "alpha"); // false
+	* shouldIncludeTag("1.0.1-alpha.0", "alpha"); // true
+	* shouldIncludeTag("1.0.0", "alpha"); // true
+	*
+	* shouldIncludeTag("1.0.1-0", false); // true
+	* shouldIncludeTag("1.0.1-alpha.0", false); // true
+	* shouldIncludeTag("1.0.0", false); // true
+	* ```
+	*
+	* @param tag The tag to evaluate (without prefix)
+	* @param preRelease The preRelease configuration value (Example: `true`, `false`, or a string like `"beta"`)
+	* @returns `true` if the tag should be included, `false` otherwise
+	*/
+	#shouldIncludeTag(tag, preRelease) {
+		if (!tag || !semver.valid(tag)) return false;
+		if (!preRelease) return true;
+		const prereleaseParts = semver.prerelease(tag);
+		if (!prereleaseParts) return true;
+		if (typeof preRelease === "string") return prereleaseParts[0] === preRelease;
+		if (preRelease === true) return prereleaseParts.length === 1;
+		return false;
+	}
+	/**
 	* `getTags` returns valid semver version tags in order of the commit history
 	*
 	* Using `git log` to get the commit history, we then parse the tags from the
@@ -163,7 +200,7 @@ var Git = class {
 	* await git.getTags("v"); // ["v1.0.2", "v1.0.1", "v1.0.0"]
 	* ```
 	*/
-	async getTags(tagPrefix) {
+	async getTags(tagPrefix, preRelease) {
 		const logOutput = await this.log("--decorate", "--no-color", "--date-order");
 		/**
 		* Search for tags in the following formats:
@@ -171,31 +208,19 @@ var Git = class {
 		*/
 		const TAG_REGEX = /tag:\s*(?<tag>.+?)[,)]/gi;
 		const tags = [];
-		const escapedTagPrefix = tagPrefix ? escapeRegex(tagPrefix) : void 0;
 		let tagMatch = null;
 		while (tagMatch = TAG_REGEX.exec(logOutput)) {
 			const { tag = "" } = tagMatch.groups ?? {};
 			if (tagPrefix) {
 				if (tag.startsWith(tagPrefix)) {
-					const tagWithoutPrefix = tag.replace(new RegExp(`^${escapedTagPrefix}`), "");
-					if (semver.valid(tagWithoutPrefix)) tags.push(tag);
+					const tagWithoutPrefix = cleanTag(tag, tagPrefix);
+					if (this.#shouldIncludeTag(tagWithoutPrefix, preRelease)) tags.push(tag);
 				}
-			} else if (/^\d/.test(tag) && semver.valid(tag)) tags.push(tag);
+			} else if (/^\d/.test(tag) && this.#shouldIncludeTag(tag, preRelease)) tags.push(tag);
 		}
 		return tags;
 	}
 	/**
-	* Returns the most recent tag from the commit history, or `undefined` if no valid semver tags are found
-	*
-	* @example
-	* ```ts
-	* await git.getMostRecentTag("v"); // "1.2.3"
-	* ```
-	*/
-	async getMostRecentTag(tagPrefix) {
-		return (await this.getTags(tagPrefix))[0] || void 0;
-	}
-	/**
 	* Get commit history in a parsable format
 	*
 	* An array of strings with commit details is returned in the following format:

package/dist/utils/clean-tag.js

@@ -13,8 +13,7 @@ import semver from "semver";
 */
 function cleanTag(tag, tagPrefix) {
 	if (!tag) return void 0;
-	const escapedTagPrefix = tagPrefix ? escapeRegex(tagPrefix) : void 0;
-	const tagWithoutPrefix = escapedTagPrefix ? tag.replace(new RegExp(`^${escapedTagPrefix}`), "") : tag;
+	const tagWithoutPrefix = tagPrefix ? tag.replace(new RegExp(`^${escapeRegex(tagPrefix)}`), "") : tag;
 	return semver.clean(tagWithoutPrefix) ?? void 0;
 }
 //#endregion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fork-version",
-  "version": "5.1.2",
+  "version": "5.1.4",
   "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": [