fork-version 3.0.2 → 3.1.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Fork Version
 
+## [3.1.0](https://github.com/eglavin/fork-version/compare/v3.0.2...v3.1.0) (2025-10-05)
+
+
+### Features
+
+* implement new command flow for inspect-* commands ([d89e4e0](https://github.com/eglavin/fork-version/commit/d89e4e07803180c7b79847ed4a5e1241ee19074b))
+
+
 ## [3.0.2](https://github.com/eglavin/fork-version/compare/v3.0.1...v3.0.2) (2025-10-02)
 
 

package/README.md

@@ -87,6 +87,17 @@ 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.
 
+### Commands
+
+Fork-Version has a number of command modes which will make the program behave differently. The default "command" is the `main` mode, this mode will be used when no other command is defined.
+
+| 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.                                   |
+| `validate-config`   | Validates the configuration and exit.                                  |
+
 ### Exit Codes
 
 When ran as a cli tool Fork-Version will exit with one of the following exit codes:
@@ -95,6 +106,7 @@ When ran as a cli tool Fork-Version will exit with one of the following exit cod
 | --------- | ---------------------------- |
 | 0         | Success                      |
 | 1         | General Error                |
+| 2         | Unknown Command              |
 | 3         | Config File Validation Error |
 
 ### Command Line Options
@@ -105,17 +117,24 @@ The following help text can be viewed by running the following command: `npx for
 
 ```text
 Usage:
-  $ fork-version [options]
+  $ fork-version [command?] [options?]
 
 Commands:
-  --help                           Show this help message.
-  --version                        Show the current version of Fork-Version.
-  --inspect-version                If set, Fork-Version will print the current project version and exit.
+  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.
+  validate-config                  Validates the configuration and exits.
 
-Options:
+General Options:
+  --version                        Show the current version of Fork-Version and exit.
+  --help                           Show this help message and exit.
+
+Location Options:
   --file, -F                       List of the files to be updated. [Default: ["bower.json", "deno.json", "deno.jsonc", "jsr.json", "jsr.jsonc", "manifest.json", "npm-shrinkwrap.json", "package-lock.json", "package.json"]]
   --glob, -G                       Glob pattern to match files to be updated.
   --path, -P                       The path Fork-Version will run from. [Default: process.cwd()]
+
+Options:
   --changelog                      Name of the changelog file. [Default: "CHANGELOG.md"]
   --header                         The header text for the changelog.
   --tag-prefix                     Specify a prefix for the created tag. [Default: "v"]
@@ -155,6 +174,7 @@ Conventional Changelog Overrides:
 Exit Codes:
   0: Success
   1: General Error
+  2: Unknown Command
   3: Config File Validation Error
 
 Examples:
@@ -169,6 +189,9 @@ Examples:
 
   $ fork-version --glob "*/package.json"
     Run fork-version and update all "package.json" files in subdirectories.
+
+  $ fork-version inspect-version
+    Prints the current version and exits.
 ```
 
 <!-- END COMMAND LINE OPTIONS -->
@@ -268,7 +291,7 @@ Alternatively you can define your config using a key in your `package.json` file
 
 | Property                                              | Type             | Default                 | Description                                                                                                         |
 | :---------------------------------------------------- | :--------------- | :---------------------- | :------------------------------------------------------------------------------------------------------------------ |
-| inspectVersion                                        | boolean          | -                       | Print the current version and exits                                                                                 |
+| command                                               | string           | `main`                  | The command to run. Can be one of: main, inspect-version, inspect-tag, validate-config. Defaults to main.           |
 | [files](#configfiles)                                 | Array\<string>   | `["package.json", ...]` | List of the files to be updated                                                                                     |
 | [glob](#configglob)                                   | string           | -                       | Glob pattern to match files to be updated                                                                           |
 | path                                                  | string           | `process.cwd()`         | The path Fork-Version will run from                                                                                 |

package/dist/{chunk-YSWJMT7B.cjs → chunk-BPV4HZ7U.cjs}

@@ -101,11 +101,26 @@ var ChangelogPresetConfigSchema = zod.z.object({
 var ForkConfigSchema = zod.z.object({
   // Commands
   //
+  /**
+   * The command to run, can be one of the following:
+   *
+   * - `main` - Bumps the version, update files, generate changelog, commit, and tag.
+   * - `inspect-version` - Prints the current version and exits.
+   * - `inspect-tag` - Prints the current git tag and exits.
+   * - `validate-config` - Validates the configuration and exits.
+   *
+   * @default "main"
+   */
+  command: zod.z.literal(["main", "inspect-version", "inspect-tag", "validate-config"]).describe(
+    "The command to run. Can be one of: main, inspect-version, inspect-tag, validate-config. Defaults to main."
+  ),
   /**
    * If set, Fork-Version will print the current version and exit.
    * @default false
+   *
+   * @deprecated Set the `inspect-version` command instead.
    */
-  inspectVersion: zod.z.boolean().describe("If set, Fork-Version will print the current version and exit."),
+  inspectVersion: zod.z.boolean().optional().describe("If set, Fork-Version will print the current version and exit."),
   // Options
   //
   /**
@@ -656,7 +671,7 @@ function getChangelogPresetConfig(mergedConfig, cliArguments, detectedGitHost) {
 // src/config/defaults.ts
 var DEFAULT_CONFIG = {
   // Commands
-  inspectVersion: false,
+  command: "main",
   // Options
   files: [
     "package.json",
@@ -792,12 +807,12 @@ function mergeFiles(configFiles, cliFiles, globResults) {
 
 // src/config/user-config.ts
 async function getUserConfig(cliArguments) {
-  const cwd = cliArguments.path ? path.resolve(cliArguments.path) : process.cwd();
+  const cwd = cliArguments.flags.path ? path.resolve(cliArguments.flags.path) : process.cwd();
   const configFile = await loadConfigFile(cwd);
   const mergedConfig = {
     ...DEFAULT_CONFIG,
     ...configFile,
-    ...cliArguments
+    ...cliArguments.flags
   };
   let globResults = [];
   if (mergedConfig.glob) {
@@ -807,21 +822,33 @@ async function getUserConfig(cliArguments) {
       nodir: true
     });
   }
-  const files = mergeFiles(configFile?.files, cliArguments?.files, globResults);
+  const files = mergeFiles(configFile?.files, cliArguments.flags.files, globResults);
   const detectedGitHost = await detectGitHost(cwd);
   const changelogPresetConfig = getChangelogPresetConfig(
     mergedConfig,
-    cliArguments,
+    cliArguments.flags,
     detectedGitHost
   );
+  let command = DEFAULT_CONFIG.command;
+  if (cliArguments.input.length > 0 && cliArguments.input[0].trim()) {
+    command = cliArguments.input[0].trim().toLowerCase();
+  } else if (mergedConfig.command.trim()) {
+    command = mergedConfig.command.trim().toLowerCase();
+  }
+  if (mergedConfig.inspectVersion) {
+    command = "inspect-version";
+  }
+  const shouldBeSilent = ![DEFAULT_CONFIG.command].includes(command);
   return {
     ...mergedConfig,
+    command,
     files,
     path: cwd,
     preRelease: (
       // Meow doesn't support multiple flags with the same name, so we need to check both.
-      cliArguments.preReleaseTag ?? cliArguments.preRelease ?? configFile.preRelease
+      cliArguments.flags.preReleaseTag ?? cliArguments.flags.preRelease ?? configFile.preRelease
     ),
+    silent: shouldBeSilent || mergedConfig.silent,
     changelogPresetConfig
   };
 }
@@ -834,7 +861,7 @@ var Logger = class {
     this.warn = this.warn.bind(this);
     this.error = this.error.bind(this);
     this.debug = this.debug.bind(this);
-    this.disableLogs = this.config.silent || this.config.inspectVersion;
+    this.disableLogs = this.config.silent;
   }
   disableLogs = false;
   log(...messages) {
@@ -1170,6 +1197,76 @@ var FileManager = class {
   }
 };
 
+// src/commands/validate-config.ts
+function validateConfig(config) {
+  console.log(`
+\u2699\uFE0F Configuration:
+${JSON.stringify(config, null, 2)}
+
+\u2705 Configuration is valid.
+`);
+}
+async function getCurrentVersion(config, logger, git, fileManager, filesToUpdate) {
+  const files = [];
+  const versions = /* @__PURE__ */ new Set();
+  for (const file of filesToUpdate) {
+    if (await git.isIgnored(file)) {
+      logger.debug(`[Git Ignored] ${file}`);
+      continue;
+    }
+    const fileState = fileManager.read(file);
+    if (fileState) {
+      files.push(fileState);
+      if (!config.currentVersion) {
+        versions.add(fileState.version);
+      }
+    }
+  }
+  if (config.currentVersion) {
+    versions.add(config.currentVersion);
+  }
+  if (versions.size === 0 && config.gitTagFallback) {
+    const version = await git.getHighestSemverVersionFromTags(config.tagPrefix);
+    if (version) {
+      logger.warn(`Using latest git tag as fallback`);
+      versions.add(version);
+    }
+  }
+  if (versions.size === 0) {
+    throw new Error("Unable to find current version");
+  } else if (versions.size > 1) {
+    if (!config.allowMultipleVersions) {
+      throw new Error("Found multiple versions");
+    }
+    logger.warn(
+      `Found multiple versions (${Array.from(versions).join(", ")}), using the higher semver version`
+    );
+  }
+  const currentVersion = semver__default.default.rsort(Array.from(versions))[0];
+  logger.log(`Current version: ${currentVersion}`);
+  return {
+    files,
+    version: currentVersion
+  };
+}
+
+// src/commands/inspect-version.ts
+async function inspectVersion(config, logger, fileManager, git) {
+  let foundVersion = "";
+  try {
+    const currentVersion = await getCurrentVersion(config, logger, git, fileManager, config.files);
+    if (currentVersion) foundVersion = currentVersion.version;
+  } catch {
+  }
+  console.log(foundVersion);
+}
+
+// src/commands/inspect-tag.ts
+async function inspectTag(config, git) {
+  const tag = await git.getMostRecentTag(config.tagPrefix);
+  console.log(tag ?? "");
+}
+
 // src/utils/trim-string-array.ts
 function trimStringArray(array) {
   const items = [];
@@ -1644,53 +1741,6 @@ async function getCommitsSinceTag(config, logger, git) {
     commits: filteredCommits
   };
 }
-async function getCurrentVersion(config, logger, git, fileManager, filesToUpdate) {
-  const files = [];
-  const versions = /* @__PURE__ */ new Set();
-  for (const file of filesToUpdate) {
-    if (await git.isIgnored(file)) {
-      logger.debug(`[Git Ignored] ${file}`);
-      continue;
-    }
-    const fileState = fileManager.read(file);
-    if (fileState) {
-      files.push(fileState);
-      if (!config.currentVersion) {
-        versions.add(fileState.version);
-      }
-    }
-  }
-  if (config.currentVersion) {
-    versions.add(config.currentVersion);
-  }
-  if (versions.size === 0 && config.gitTagFallback) {
-    const version = await git.getHighestSemverVersionFromTags(config.tagPrefix);
-    if (version) {
-      logger.warn(`Using latest git tag as fallback`);
-      versions.add(version);
-    }
-  }
-  if (versions.size === 0) {
-    throw new Error("Unable to find current version");
-  } else if (versions.size > 1) {
-    if (!config.allowMultipleVersions) {
-      throw new Error("Found multiple versions");
-    }
-    logger.warn(
-      `Found multiple versions (${Array.from(versions).join(", ")}), using the higher semver version`
-    );
-  }
-  const currentVersion = semver__default.default.rsort(Array.from(versions))[0];
-  if (config.inspectVersion) {
-    console.log(currentVersion);
-    process.exit(0);
-  }
-  logger.log(`Current version: ${currentVersion}`);
-  return {
-    files,
-    version: currentVersion
-  };
-}
 function getPriority(type) {
   return ["patch", "minor", "major"].indexOf(type ?? "");
 }
@@ -1922,6 +1972,29 @@ async function tagChanges(config, logger, git, nextVersion) {
   );
 }
 
+// src/commands/main.ts
+async function main(config, logger, fileManager, git) {
+  logger.log(`Running fork-version - ${(/* @__PURE__ */ new Date()).toUTCString()}`);
+  logger.warn(config.dryRun ? "[Dry Run] No changes will be written to disk.\n" : "");
+  const commits = await getCommitsSinceTag(config, logger, git);
+  const current = await getCurrentVersion(config, logger, git, fileManager, config.files);
+  const next = await getNextVersion(config, logger, commits.commits, current.version);
+  logger.log("Updating files: ");
+  for (const outFile of current.files) {
+    logger.log(`  - ${outFile.path}`);
+    fileManager.write(outFile, next.version);
+  }
+  await updateChangelog(config, logger, next.version);
+  await commitChanges(config, logger, git, current.files, next.version);
+  await tagChanges(config, logger, git, next.version);
+  return {
+    config,
+    commits,
+    current,
+    next
+  };
+}
+
 exports.CommitParser = CommitParser;
 exports.FileManager = FileManager;
 exports.ForkConfigSchema = ForkConfigSchema;
@@ -1934,7 +2007,11 @@ exports.getCommitsSinceTag = getCommitsSinceTag;
 exports.getCurrentVersion = getCurrentVersion;
 exports.getNextVersion = getNextVersion;
 exports.getUserConfig = getUserConfig;
+exports.inspectTag = inspectTag;
+exports.inspectVersion = inspectVersion;
+exports.main = main;
 exports.tagChanges = tagChanges;
 exports.updateChangelog = updateChangelog;
-//# sourceMappingURL=chunk-YSWJMT7B.cjs.map
-//# sourceMappingURL=chunk-YSWJMT7B.cjs.map
+exports.validateConfig = validateConfig;
+//# sourceMappingURL=chunk-BPV4HZ7U.cjs.map
+//# sourceMappingURL=chunk-BPV4HZ7U.cjs.map