fork-version 5.1.0 → 5.1.1

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Fork Version
 
+## [5.1.1](https://github.com/eglavin/fork-version/compare/v5.1.0...v5.1.1) (2026-04-12)
+
+
+### Docs
+
+* add all files and custom file manager examples ([43c85a4](https://github.com/eglavin/fork-version/commit/43c85a482906f73c7b45a28a522bec150b3f2cff))
+* update build metadata info in readme ([e03c362](https://github.com/eglavin/fork-version/commit/e03c362094b7f0685fd386c7754f705a4d727472))
+
+
+### Refactor
+
+* move build metadata out of yaml class ([59627fc](https://github.com/eglavin/fork-version/commit/59627fc903bcd5aae1b44954fd6183417025a2f3))
+
+
 ## [5.1.0](https://github.com/eglavin/fork-version/compare/v5.0.2...v5.1.0) (2026-04-11)
 
 

package/README.md

@@ -472,6 +472,15 @@ If you are using one of the following Git hosts, Fork-Version will automatically
 - [Install Shield ISM](#install-shield-ism)
 - [Custom File Updater's](#custom-file-updaters)
 
+> [!Note]
+> If your version strings include build metadata like one of the following examples:
+>
+> - 1.2.3+49a3f2b
+> - 1.2.3-0+49a3f2b
+> - 1.2.3-alpha.0+49a3f2b
+>
+> this metadata will be retained without modification.
+
 #### Json Package
 
 A json package is a json file which contains a version property, such as a npm package.json file.
@@ -495,9 +504,6 @@ publish_to: 'none'
 version: 1.2.3
 ```
 
-> [!NOTE]
-> If you're using Fork-Version for a flutter project, Fork-Version will split the version and the builder number on the "+" character, the version will be updated and the builder number will be left as is.
-
 #### Plain Text
 
 A plain text file is a file which contains just the version as the content. Files that end with `version.txt` will be treated as a plain text version file.

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

@@ -14,6 +14,7 @@ declare class MissingPropertyException extends Error {
 interface FileState {
   path: string;
   version: string;
+  buildMetadata?: string;
   [other: string]: unknown;
 }
 interface IFileManager {

package/dist/files/file-manager.js

@@ -5,6 +5,7 @@ import { PlainText } from "./plain-text.js";
 import { MSBuildProject } from "./ms-build-project.js";
 import { ARMBicep } from "./arm-bicep.js";
 import { InstallShieldISM } from "./install-shield-ism.js";
+import { extractBuildMetadata } from "../utils/extract-build-metadata.js";
 import { isAbsolute, relative, resolve } from "node:path";
 //#region src/files/file-manager.ts
 /**
@@ -57,7 +58,15 @@ var FileManager = class {
 		if (!fileExists(filePath)) return;
 		for (const fileManager of this.#fileManagers) if (fileManager.isSupportedFile(fileNameLower)) {
 			try {
-				return await fileManager.read(filePath);
+				const fileState = await fileManager.read(filePath);
+				if (fileState) {
+					const { version, buildMetadata } = extractBuildMetadata(fileState.version);
+					if (buildMetadata) {
+						fileState.version = version;
+						fileState.buildMetadata = buildMetadata;
+					}
+				}
+				return fileState;
 			} catch (error) {
 				if (error instanceof MissingPropertyException) this.#logger.warn(`[File Manager] Missing '${error.propertyName}' property in ${error.fileType} file: ${relativePath}`);
 				else throw new Error(`An unexpected error occurred while reading file: ${filePath}`, { cause: error });
@@ -81,7 +90,9 @@ var FileManager = class {
 		if (this.#config.dryRun) return;
 		const relativePath = relative(this.#config.path, fileState.path);
 		const fileNameLower = relativePath.toLocaleLowerCase();
-		for (const fileManager of this.#fileManagers) if (fileManager.isSupportedFile(fileNameLower)) return await fileManager.write(fileState, newVersion);
+		let updatedVersion = newVersion;
+		if (fileState?.buildMetadata) updatedVersion += `+${fileState.buildMetadata}`;
+		for (const fileManager of this.#fileManagers) if (fileManager.isSupportedFile(fileNameLower)) return await fileManager.write(fileState, updatedVersion);
 		this.#logger.error(`[File Manager] Unsupported file: ${relativePath}`);
 	}
 };

package/dist/files/yaml-package.js

@@ -15,36 +15,17 @@ import { parse, parseDocument } from "yaml";
 * ```
 */
 var YAMLPackage = class {
-	/**
-	* If the version is returned with a "+" symbol in the value then the version might be from a
-	* flutter `pubspec.yaml` file, if so we want to retain the input builderNumber by splitting it
-	* and joining it again later.
-	*/
-	#handleBuildNumber(fileVersion) {
-		const [version, builderNumber] = fileVersion.split("+");
-		if (/^\d+$/.test(builderNumber)) return {
-			version,
-			builderNumber
-		};
-		return { version: fileVersion };
-	}
 	async read(filePath) {
 		const fileVersion = parse(await readFile(filePath, "utf8"))?.version;
-		if (fileVersion) {
-			const parsedVersion = this.#handleBuildNumber(fileVersion);
-			return {
-				path: filePath,
-				version: parsedVersion.version || "",
-				builderNumber: parsedVersion.builderNumber ?? void 0
-			};
-		}
+		if (fileVersion) return {
+			path: filePath,
+			version: fileVersion
+		};
 		throw new MissingPropertyException("YAML", "version");
 	}
 	async write(fileState, newVersion) {
 		const yamlDocument = parseDocument(await readFile(fileState.path, "utf8"));
-		let newFileVersion = newVersion;
-		if (fileState.builderNumber !== void 0) newFileVersion += `+${fileState.builderNumber}`;
-		yamlDocument.set("version", newFileVersion);
+		yamlDocument.set("version", newVersion);
 		await writeFile(fileState.path, yamlDocument.toString(), "utf8");
 	}
 	isSupportedFile(fileName) {

package/dist/utils/extract-build-metadata.js

@@ -0,0 +1,37 @@
+//#region src/utils/extract-build-metadata.ts
+/**
+* This function is used to separate build metadata from the version string.
+* Build metadata is denoted by a plus sign (`+`) followed by a string of characters.
+*
+* Example version strings including build metadata:
+* - `1.2.3+49a3f2b`
+* - `1.2.3-0+49a3f2b`
+* - `1.2.3-alpha.0+49a3f2b`
+*
+* In the above examples, the build metadata is `+49a3f2b`, which should be
+* ignored when determining the next version.
+*
+* @param version The version string to extract build metadata from.
+* @return Both the version string without build metadata and the extracted build metadata (if any).
+*
+* @example
+* ```ts
+* const versionWithMetadata = "1.2.3+49a3f2b";
+* const { version, buildMetadata } = extractBuildMetadata(versionWithMetadata);
+* console.log(version); // Output: "1.2.3"
+* console.log(buildMetadata); // Output: "49a3f2b"
+* ```
+*/
+function extractBuildMetadata(version) {
+	const plusIndex = version.indexOf("+");
+	if (plusIndex === -1) return {
+		version,
+		buildMetadata: void 0
+	};
+	return {
+		version: version.substring(0, plusIndex),
+		buildMetadata: version.substring(plusIndex + 1) || void 0
+	};
+}
+//#endregion
+export { extractBuildMetadata };

package/package.json

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