fork-version 1.6.0 → 1.7.3

package/CHANGELOG.md

@@ -1,5 +1,37 @@
 # Fork Version
 
+## 1.7.3 (2024-11-03)
+
+
+### Refactor
+
+* general cleanup of error message handling ([#78](https://github.com/eglavin/fork-version/issues/78)) ([a83ff13](https://github.com/eglavin/fork-version/commit/a83ff13443d50edfba18c5502d9c38e834e3236d))
+
+
+## 1.7.2 (2024-11-02)
+
+
+### Chore
+
+* bump pnpm dependency ([#77](https://github.com/eglavin/fork-version/issues/77)) ([158c70c](https://github.com/eglavin/fork-version/commit/158c70c06311fb624be03b522c06730f8f314d37))
+
+
+## 1.7.1 (2024-11-01)
+
+
+### Docs
+
+* update using npx section of readme ([737a72a](https://github.com/eglavin/fork-version/commit/737a72a8485a5e1035543245c498e9f76ce1050b))
+
+
+## 1.7.0 (2024-10-31)
+
+
+### Features
+
+* add yaml support ([#76](https://github.com/eglavin/fork-version/issues/76)) ([2a0d89e](https://github.com/eglavin/fork-version/commit/2a0d89e6174ef098ec7fc697ff05e24572b4a84c))
+
+
 ## 1.6.0 (2024-10-27)
 
 

package/README.md

@@ -41,19 +41,28 @@ Fork-Version can be configured either through a config file or by passing option
 
 ### Using `npx` (Recommended)
 
-To use Fork-Version with `npx` you can use the following command, by using `npx` you can also use Fork-Version without installation and on other projects including non node projects.
+To use Fork-Version without installation you can use `npx`:
 
 ```sh
 npx fork-version
 ```
 
+`npx` is a package runner which allows you to execute npm packages without installation, this can be useful when working on projects outside of the Node ecosystem.
+
 > [!NOTE]
-> If you want to use a specific version you can add a version tag to the end of the name.
+> By default `npx` will use the latest release, if you want to use a specific version you can add a version tag to the end of the name.
 >
-> Example: `npx fork-version@1.4.67`
+> Example: `npx fork-version@1.7.0`
 >
 > The version tag needs to match against one of the [published versions on npm](https://www.npmjs.com/package/fork-version?activeTab=versions).
 
+Alternatively you can use other npm compatible javascript runtime's:
+
+| Runner | Command                    |
+| ------ | -------------------------- |
+| bun    | `bunx fork-version`        |
+| deno   | `deno -A npm:fork-version` |
+
 ### Install Locally
 
 To install the package locally to your project you can use one of the following commands:
@@ -63,6 +72,7 @@ To install the package locally to your project you can use one of the following
 | npm             | `npm install fork-version --save-dev` |
 | yarn            | `yarn add fork-version --dev`         |
 | pnpm            | `pnpm add fork-version --save-dev`    |
+| bun             | `bun install fork-version --dev`      |
 
 You can then add the following entry to your package.json scripts section and use it like any other script you already use in your project.
 
@@ -76,6 +86,16 @@ You can then add the following entry to your package.json scripts section and us
 
 For example if you use npm you can now use `npm run release` to run Fork-Version.
 
+### Exit Codes
+
+When ran as a cli tool Fork-Version will exit with one of the following exit codes:
+
+| Exit Code | Description                  |
+| --------- | ---------------------------- |
+| 0         | Success                      |
+| 1         | General Error                |
+| 3         | Config File Validation Error |
+
 ### Command Line Options
 
 <!-- START COMMAND LINE OPTIONS -->
@@ -129,6 +149,11 @@ Conventional Changelog Overrides:
   --release-commit-message-format  Override the default release commit message format.
   --release-message-suffix         Add a suffix to the end of the release message.
 
+Exit Codes:
+  0: Success
+  1: General Error
+  3: Config File Validation Error
+
 Examples:
   $ fork-version
     Run fork-version in the current directory with default options.
@@ -374,6 +399,7 @@ Adds a suffix to the end of the release message, useful to add a `[skip ci]` mes
 ### Supported File Types
 
 - [Json Package](#json-package)
+- [Yaml Package](#yaml-package)
 - [Plain Text](#plain-text)
 - [MS Build](#ms-build)
 
@@ -389,6 +415,20 @@ A json package is a json file which contains a version property, such as a npm p
 }
 ```
 
+#### Yaml Package
+
+A yaml package is a yaml file which contains a version property, such as a dart pubspec.yaml file.
+
+```yaml
+name: wordionary
+description: "My project"
+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 will have just the version as the content.

package/dist/{chunk-MC3XSR7P.cjs → chunk-PKSCXRF2.cjs}

@@ -10,6 +10,7 @@ var meow = require('meow');
 var conventionalChangelogConfigSpec = require('conventional-changelog-config-spec');
 var child_process = require('child_process');
 var jsoncParser = require('jsonc-parser');
+var yaml = require('yaml');
 var cheerio = require('cheerio/slim');
 var semver3 = require('semver');
 var conventionalRecommendedBump = require('conventional-recommended-bump');
@@ -389,6 +390,11 @@ Conventional Changelog Overrides:
   --release-commit-message-format  Override the default release commit message format.
   --release-message-suffix         Add a suffix to the end of the release message.
 
+Exit Codes:
+  0: Success
+  1: General Error
+  3: Config File Validation Error
+
 Examples:
   $ fork-version
     Run fork-version in the current directory with default options.
@@ -403,7 +409,7 @@ Examples:
     Run fork-version and update all "package.json" files in subdirectories.`;
 function getCliArguments() {
   return meow__default.default(helperText, {
-    importMeta: ({ url: (typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('chunk-MC3XSR7P.cjs', document.baseURI).href)) }),
+    importMeta: ({ url: (typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('chunk-PKSCXRF2.cjs', document.baseURI).href)) }),
     booleanDefault: void 0,
     helpIndent: 0,
     flags: {
@@ -601,7 +607,7 @@ async function loadConfigFile(configFilePath) {
       if (fileContent2[PACKAGE_JSON_CONFIG_KEY] && typeof fileContent2[PACKAGE_JSON_CONFIG_KEY] === "object") {
         const parsed3 = ForkConfigSchema.partial().safeParse(fileContent2[PACKAGE_JSON_CONFIG_KEY]);
         if (!parsed3.success) {
-          throw parsed3.error;
+          throw new Error(`Validation error in: ${configFilePath}`, { cause: parsed3.error });
         }
         return parsed3.data;
       }
@@ -609,14 +615,14 @@ async function loadConfigFile(configFilePath) {
     }
     const parsed2 = ForkConfigSchema.partial().safeParse(fileContent2);
     if (!parsed2.success) {
-      throw parsed2.error;
+      throw new Error(`Validation error in: ${configFilePath}`, { cause: parsed2.error });
     }
     return parsed2.data;
   }
   const fileContent = await bundleRequire.bundleRequire({ filepath: configFilePath });
   const parsed = ForkConfigSchema.partial().safeParse(fileContent.mod.default || fileContent.mod);
   if (!parsed.success) {
-    throw parsed.error;
+    throw new Error(`Validation error in: ${configFilePath}`, { cause: parsed.error });
   }
   return parsed.data;
 }
@@ -707,7 +713,7 @@ var JSONPackage = class {
           isPrivate: typeof parsedJson?.private === "boolean" ? parsedJson.private : true
         };
       }
-      this.logger.warn(`[File Manager] Unable to determine json package: ${fileName}`);
+      this.logger.warn(`[File Manager] Unable to determine json version: ${fileName}`);
     }
   }
   write(fileState, newVersion) {
@@ -732,6 +738,59 @@ function setStringInJsonc(jsonc, jsonPath, newString) {
   const edits = jsoncParser.modify(jsonc, jsonPath, newString, {});
   return jsoncParser.applyEdits(jsonc, edits);
 }
+var YAMLPackage = class {
+  constructor(config, logger) {
+    this.config = config;
+    this.logger = logger;
+  }
+  /**
+   * 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
+    };
+  }
+  read(fileName) {
+    const filePath = path.resolve(this.config.path, fileName);
+    if (fileExists(filePath)) {
+      const fileContents = fs.readFileSync(filePath, "utf-8");
+      const fileVersion = yaml.parse(fileContents)?.version;
+      if (fileVersion) {
+        const parsedVersion = this.handleBuildNumber(fileVersion);
+        return {
+          name: fileName,
+          path: filePath,
+          version: parsedVersion.version || "",
+          builderNumber: parsedVersion.builderNumber ?? void 0
+        };
+      }
+    }
+    this.logger.warn(`[File Manager] Unable to determine yaml version: ${fileName}`);
+  }
+  write(fileState, newVersion) {
+    const fileContents = fs.readFileSync(fileState.path, "utf8");
+    const yamlDocument = yaml.parseDocument(fileContents);
+    let newFileVersion = newVersion;
+    if (fileState.builderNumber !== void 0) {
+      newFileVersion += `+${fileState.builderNumber}`;
+    }
+    yamlDocument.set("version", newFileVersion);
+    fs.writeFileSync(fileState.path, yamlDocument.toString(), "utf8");
+  }
+  isSupportedFile(fileName) {
+    return fileName.endsWith(".yaml") || fileName.endsWith(".yml");
+  }
+};
 var PlainText = class {
   constructor(config, logger) {
     this.config = config;
@@ -747,7 +806,7 @@ var PlainText = class {
         version: fileContents || ""
       };
     }
-    this.logger.warn(`[File Manager] Unable to determine plain text: ${fileName}`);
+    this.logger.warn(`[File Manager] Unable to determine plain text version: ${fileName}`);
   }
   write(fileState, newVersion) {
     fs.writeFileSync(fileState.path, newVersion, "utf8");
@@ -777,7 +836,7 @@ var MSBuildProject = class {
           version
         };
       }
-      this.logger.warn(`[File Manager] Unable to determine ms-build package: ${fileName}`);
+      this.logger.warn(`[File Manager] Unable to determine ms-build version: ${fileName}`);
     }
   }
   write(fileState, newVersion) {
@@ -803,10 +862,12 @@ var FileManager = class {
     this.config = config;
     this.logger = logger;
     this.JSONPackage = new JSONPackage(config, logger);
+    this.YAMLPackage = new YAMLPackage(config, logger);
     this.PlainText = new PlainText(config, logger);
     this.MSBuildProject = new MSBuildProject(config, logger);
   }
   JSONPackage;
+  YAMLPackage;
   PlainText;
   MSBuildProject;
   /**
@@ -827,6 +888,9 @@ var FileManager = class {
     if (this.JSONPackage.isSupportedFile(_fileName)) {
       return this.JSONPackage.read(fileName);
     }
+    if (this.YAMLPackage.isSupportedFile(_fileName)) {
+      return this.YAMLPackage.read(fileName);
+    }
     if (this.PlainText.isSupportedFile(_fileName)) {
       return this.PlainText.read(fileName);
     }
@@ -854,6 +918,9 @@ var FileManager = class {
     if (this.JSONPackage.isSupportedFile(_fileName)) {
       return this.JSONPackage.write(fileState, newVersion);
     }
+    if (this.YAMLPackage.isSupportedFile(_fileName)) {
+      return this.YAMLPackage.write(fileState, newVersion);
+    }
     if (this.PlainText.isSupportedFile(_fileName)) {
       return this.PlainText.write(fileState, newVersion);
     }
@@ -906,17 +973,20 @@ function getReleaseType(releaseType, currentVersion, preReleaseTag) {
 }
 
 // src/process/version.ts
-async function getCurrentVersion(config, logger, fileManager, filesToUpdate) {
+async function getCurrentVersion(config, logger, git, fileManager, filesToUpdate) {
   const files = [];
   const versions = /* @__PURE__ */ new Set();
   for (const file of filesToUpdate) {
+    if (await git.shouldIgnore(file)) {
+      logger.debug(`[Git Ignored] ${file}`);
+      continue;
+    }
     const fileState = fileManager.read(file);
     if (fileState) {
       files.push(fileState);
-      if (config.currentVersion) {
-        continue;
+      if (!config.currentVersion) {
+        versions.add(fileState.version);
       }
-      versions.add(fileState.version);
     }
   }
   if (config.currentVersion) {
@@ -925,7 +995,7 @@ async function getCurrentVersion(config, logger, fileManager, filesToUpdate) {
   if (versions.size === 0 && config.gitTagFallback) {
     const version = await getLatestGitTagVersion(config.tagPrefix);
     if (version) {
-      logger.log(`[Version] Using git tag fallback.`);
+      logger.warn(`Using latest git tag fallback`);
       versions.add(version);
     }
   }
@@ -935,8 +1005,9 @@ async function getCurrentVersion(config, logger, fileManager, filesToUpdate) {
     if (!config.allowMultipleVersions) {
       throw new Error("Found multiple versions");
     }
-    logger.warn("[WARNING] Found multiple versions, using the first one.");
-    logger.log(`Versions: ${Array.from(versions).join(", ")}`);
+    logger.warn(
+      `Found multiple versions (${Array.from(versions).join(", ")}), using the higher semver version`
+    );
   }
   const currentVersion = semver3__default.default.rsort(Array.from(versions))[0];
   if (config.inspectVersion) {
@@ -951,7 +1022,7 @@ async function getCurrentVersion(config, logger, fileManager, filesToUpdate) {
 }
 async function getNextVersion(config, logger, currentVersion) {
   if (config.skipBump) {
-    logger.log("Skip bump, using current version as next version");
+    logger.warn(`Skip bump, using ${currentVersion} as the next version`);
     return {
       version: currentVersion
     };
@@ -964,14 +1035,14 @@ async function getNextVersion(config, logger, currentVersion) {
   }
   const isPreMajor = semver3__default.default.lt(currentVersion, "1.0.0");
   let recommendedBump;
-  try {
-    if (config.releaseAs) {
-      recommendedBump = {
-        releaseType: config.releaseAs,
-        level: -1,
-        reason: "User defined"
-      };
-    } else {
+  if (config.releaseAs) {
+    recommendedBump = {
+      releaseType: config.releaseAs,
+      level: -1,
+      reason: "User defined"
+    };
+  } else {
+    try {
       recommendedBump = await conventionalRecommendedBump__default.default({
         preset: {
           name: "conventionalcommits",
@@ -982,9 +1053,11 @@ async function getNextVersion(config, logger, currentVersion) {
         tagPrefix: config.tagPrefix,
         cwd: config.path
       });
+    } catch (cause) {
+      throw new Error(`[conventional-recommended-bump] Unable to determine next version`, {
+        cause
+      });
     }
-  } catch (_error) {
-    throw new Error(`[conventional-recommended-bump] Unable to determine next version`);
   }
   if (recommendedBump.releaseType) {
     const releaseType = getReleaseType(
@@ -992,18 +1065,18 @@ async function getNextVersion(config, logger, currentVersion) {
       currentVersion,
       config.preRelease
     );
-    const state = {
+    const nextVersion = semver3__default.default.inc(
+      currentVersion,
+      releaseType,
+      typeof config.preRelease === "string" ? config.preRelease : void 0
+    ) ?? "";
+    logger.log(`Next version: ${nextVersion} (${releaseType})`);
+    return {
       ...recommendedBump,
       preMajor: isPreMajor,
       releaseType,
-      version: semver3__default.default.inc(
-        currentVersion,
-        releaseType,
-        typeof config.preRelease === "string" ? config.preRelease : void 0
-      ) ?? ""
+      version: nextVersion
     };
-    logger.log(`Next version: ${state.version} (${state.releaseType})`);
-    return state;
   }
   throw new Error("Unable to find next version");
 }
@@ -1038,9 +1111,8 @@ function getNewReleaseContent(config, logger, nextVersion) {
         merges: null,
         path: config.path
       }
-    ).on("error", (error) => {
-      logger.error("[conventional-changelog] Unable to parse changes");
-      throw error;
+    ).on("error", (cause) => {
+      throw new Error("[conventional-changelog] Unable to parse changes", { cause });
     }).on("data", (chunk) => {
       newContent += chunk.toString();
     }).on("end", () => {
@@ -1050,7 +1122,7 @@ function getNewReleaseContent(config, logger, nextVersion) {
 }
 async function updateChangelog(config, logger, nextVersion) {
   if (config.skipChangelog) {
-    logger.log("Skip changelog update");
+    logger.warn("Skip changelog update");
     return;
   }
   if (config.header.search(RELEASE_PATTERN) !== -1) {
@@ -1058,12 +1130,13 @@ async function updateChangelog(config, logger, nextVersion) {
   }
   const changelogPath = path.resolve(config.path, config.changelog);
   if (!config.dryRun && !fileExists(changelogPath)) {
-    logger.log(`Creating Changelog file: ${changelogPath}`);
+    logger.log(`Creating Changelog: ${changelogPath}`);
     fs.writeFileSync(changelogPath, "\n", "utf8");
+  } else {
+    logger.log(`Updating Changelog: ${changelogPath}`);
   }
   const oldContent = getOldReleaseContent(changelogPath, fileExists(changelogPath));
   const newContent = await getNewReleaseContent(config, logger, nextVersion);
-  logger.log(`Updating Changelog: ${changelogPath}`);
   if (!config.dryRun && newContent) {
     fs.writeFileSync(
       changelogPath,
@@ -1087,7 +1160,7 @@ function formatCommitMessage(message, version) {
 // src/process/commit.ts
 async function commitChanges(config, logger, git, files, nextVersion) {
   if (config.skipCommit) {
-    logger.log("Skip commit");
+    logger.warn("Skip commit");
     return;
   }
   logger.log("Committing changes");
@@ -1119,7 +1192,7 @@ async function commitChanges(config, logger, git, files, nextVersion) {
 // src/process/tag.ts
 async function tagChanges(config, logger, git, nextVersion) {
   if (config.skipTag) {
-    logger.log("Skip tag creation");
+    logger.warn("Skip tag creation");
     return;
   }
   const tag = `${config.tagPrefix}${nextVersion}`;
@@ -1142,5 +1215,5 @@ exports.getNextVersion = getNextVersion;
 exports.getUserConfig = getUserConfig;
 exports.tagChanges = tagChanges;
 exports.updateChangelog = updateChangelog;
-//# sourceMappingURL=chunk-MC3XSR7P.cjs.map
-//# sourceMappingURL=chunk-MC3XSR7P.cjs.map
+//# sourceMappingURL=chunk-PKSCXRF2.cjs.map
+//# sourceMappingURL=chunk-PKSCXRF2.cjs.map