fork-version 4.1.9 → 5.0.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Fork Version
 
+## [5.0.0](https://github.com/eglavin/fork-version/compare/v4.1.10...v5.0.0) (2026-04-09)
+
+
+### Refactor
+
+* migrate scripts to use built in node typescript support ([50c2b0e](https://github.com/eglavin/fork-version/commit/50c2b0e7c6205c5587dd01c0e939b1c113f5f01e))
+* move config definition away from zod schema ([3c8efd3](https://github.com/eglavin/fork-version/commit/3c8efd3584da304f463de19f18014797bd53ab52))
+* pnpm prune ([ad722b5](https://github.com/eglavin/fork-version/commit/ad722b52afa3cb1a1efead53d9e0643a3751eaae))
+* replace tsup with tsdown ([ce4f740](https://github.com/eglavin/fork-version/commit/ce4f740d5edcbbb100f079f004f005f0f16ac860))
+
+
+## [4.1.10](https://github.com/eglavin/fork-version/compare/v4.1.9...v4.1.10) (2026-04-06)
+
+
+### Refactor
+
+* separate default and user parser options to handle validating user options ([cc27b10](https://github.com/eglavin/fork-version/commit/cc27b10dfb858f9778cc016f4d62f0df1b9ee7e9))
+
+
 ## [4.1.9](https://github.com/eglavin/fork-version/compare/v4.1.8...v4.1.9) (2026-04-05)
 
 

package/dist/cli.d.ts

@@ -1 +1 @@
-#!/usr/bin/env node
+export { };

package/dist/cli.js

@@ -1,198 +1,59 @@
 #!/usr/bin/env node
-import { getUserConfig, Logger, FileManager, Git, main, inspect, validateConfig } from './chunk-X4NB24VR.js';
-import { writeFileSync } from 'fs';
-import { join } from 'path';
-import { ZodError } from 'zod';
-import meow from 'meow';
-
-var helperText = `Usage:
-  $ fork-version [command?] [options?]
-
-Commands:
-  main                             Bumps the version, update files, generate changelog, commit, and tag. [Default when no command is provided]
-  inspect                          Print the current version and git tag, then exits.
-  inspect-version                  Print the current version then exits.
-  inspect-tag                      Print the current git tag then exits.
-  validate-config                  Validates the configuration and exits.
-
-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"]
-  --pre-release                    Mark this release as a pre-release.
-  --pre-release-tag                Mark this release with a tagged pre-release. [Example: "alpha", "beta", "rc"]
-  --current-version                If set, Fork-Version will use this version instead of trying to determine one.
-  --next-version                   If set, Fork-Version will attempt to update to this version, instead of incrementing using "conventional-commit".
-  --release-as                     Release as increments the version by the specified level. [Choices: "major", "minor", "patch"]
-
-Flags:
-  --allow-multiple-versions        Don't throw an error if multiple versions are found in the given files. [Default: true]
-  --commit-all                     Commit all changes, not just files updated by Fork-Version.
-  --changelog-all                  If this flag is set, all default commit types will be added to the changelog.
-  --debug                          Output debug information.
-  --dry-run                        No output will be written to disk or committed.
-  --silent                         Run without logging to the terminal.
-  --git-tag-fallback               If unable to find a version in the given files, fallback and attempt to use the latest git tag. [Default: true]
-  --sign                           If true, git will sign the commit with the systems GPG key.
-  --verify                         If true, git will run user defined git hooks before committing.
-  --as-json                        Output the result as JSON.
-
-  To negate a flag you can prefix it with "no-", for example "--no-git-tag-fallback" will not fallback to the latest git tag.
-
-Skip Steps:
-  --skip-bump                      Skip the version bump step.
-  --skip-changelog                 Skip updating the changelog.
-  --skip-commit                    Skip committing the changes.
-  --skip-tag                       Skip tagging the commit.
-
-Conventional Changelog Overrides:
-  --commit-url-format              Override the default commit URL format.
-  --compare-url-format             Override the default compare URL format.
-  --issue-url-format               Override the default issue URL format.
-  --user-url-format                Override the default user URL format.
-  --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
-  2: Unknown Command
-  3: Config File Validation Error
-
-Examples:
-  $ fork-version
-    Run fork-version in the current directory with default options.
-
-  $ fork-version --path ./packages/my-package
-    Run fork-version in the "./packages/my-package" directory.
-
-  $ fork-version --file package.json --file MyApi.csproj
-    Run fork-version and update the "package.json" and "MyApi.csproj" files.
-
-  $ 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.`;
-function getCliArguments() {
-  return meow(helperText, {
-    importMeta: import.meta,
-    booleanDefault: void 0,
-    helpIndent: 0,
-    flags: {
-      // Commands
-      /** @deprecated Set the `inspect-version` command instead. */
-      inspectVersion: { type: "boolean" },
-      // Options
-      files: { type: "string", isMultiple: true, aliases: ["file"], shortFlag: "F" },
-      glob: { type: "string", shortFlag: "G" },
-      path: { type: "string", shortFlag: "P" },
-      changelog: { type: "string" },
-      header: { type: "string" },
-      tagPrefix: { type: "string" },
-      preRelease: { type: "boolean" },
-      preReleaseTag: { type: "string" },
-      currentVersion: { type: "string" },
-      nextVersion: { type: "string" },
-      releaseAs: { type: "string", choices: ["major", "minor", "patch"] },
-      // Flags
-      allowMultipleVersions: { type: "boolean" },
-      commitAll: { type: "boolean" },
-      changelogAll: { type: "boolean" },
-      debug: { type: "boolean" },
-      dryRun: { type: "boolean" },
-      silent: { type: "boolean" },
-      gitTagFallback: { type: "boolean" },
-      sign: { type: "boolean" },
-      verify: { type: "boolean" },
-      asJson: { type: "boolean" },
-      // Skip Steps
-      skipBump: { type: "boolean" },
-      skipChangelog: { type: "boolean" },
-      skipCommit: { type: "boolean" },
-      skipTag: { type: "boolean" },
-      // Changelog Overrides
-      commitUrlFormat: { type: "string" },
-      compareUrlFormat: { type: "string" },
-      issueUrlFormat: { type: "string" },
-      userUrlFormat: { type: "string" },
-      releaseCommitMessageFormat: { type: "string" },
-      releaseMessageSuffix: { type: "string" }
-    }
-  });
-}
-
-// src/cli.ts
+import { inspect } from "./commands/inspect.js";
+import { main } from "./commands/main.js";
+import { validateConfig } from "./commands/validate-config.js";
+import { Git } from "./services/git.js";
+import { getUserConfig } from "./config/user-config.js";
+import { FileManager } from "./files/file-manager.js";
+import { Logger } from "./services/logger.js";
+import { getCliArguments } from "./config/cli-arguments.js";
+import { join } from "node:path";
+import { writeFileSync } from "node:fs";
+import { ZodError } from "zod";
+//#region src/cli.ts
 async function runFork() {
-  const startTime = Date.now();
-  const cliArguments = getCliArguments();
-  const config = await getUserConfig(cliArguments);
-  const logger = new Logger(config);
-  const fileManager = new FileManager(config, logger);
-  const git = new Git(config);
-  switch (config.command) {
-    case "validate-config": {
-      validateConfig(config);
-      break;
-    }
-    case "inspect-version":
-    case "inspect-tag":
-    case "inspect": {
-      await inspect(config, logger, fileManager, git);
-      break;
-    }
-    case "main": {
-      const result = await main(config, logger, fileManager, git);
-      const branchName = await git.getBranchName();
-      logger.log(
-        `
-Run \`git push --follow-tags origin ${branchName}\` to push the changes and the tag.`
-      );
-      if (result.current.files.some((file) => file.name === "package.json" && !file.isPrivate)) {
-        const npmTag = typeof config.preRelease === "string" ? config.preRelease : "prerelease";
-        logger.log(
-          `${result.next.releaseType}`.startsWith("pre") ? `Run \`npm publish --tag ${npmTag}\` to publish the package.` : "Run `npm publish` to publish the package."
-        );
-      }
-      if (!config.dryRun && config.debug) {
-        writeFileSync(
-          join(config.path, `fork-version-${Date.now()}.debug-log.json`),
-          JSON.stringify(result, null, 2)
-        );
-      }
-      break;
-    }
-    default: {
-      logger.error(`Unknown command: ${config.command}`);
-      process.exit(2);
-    }
-  }
-  logger.debug(`Completed in ${Date.now() - startTime} ms`);
+	const startTime = Date.now();
+	const config = await getUserConfig(getCliArguments());
+	const logger = new Logger(config);
+	const fileManager = new FileManager(config, logger);
+	const git = new Git(config);
+	switch (config.command) {
+		case "validate-config":
+			validateConfig(config);
+			break;
+		case "inspect-version":
+		case "inspect-tag":
+		case "inspect":
+			await inspect(config, logger, fileManager, git);
+			break;
+		case "main": {
+			const result = await main(config, logger, fileManager, git);
+			const branchName = await git.getBranchName();
+			logger.log(`\nRun \`git push --follow-tags origin ${branchName}\` to push the changes and the tag.`);
+			if (result.current.files.some((file) => file.name === "package.json" && !file.isPrivate)) {
+				const npmTag = typeof config.preRelease === "string" ? config.preRelease : "prerelease";
+				logger.log(`${result.next.releaseType}`.startsWith("pre") ? `Run \`npm publish --tag ${npmTag}\` to publish the package.` : "Run `npm publish` to publish the package.");
+			}
+			if (!config.dryRun && config.debug) writeFileSync(join(config.path, `fork-version-${Date.now()}.debug-log.json`), JSON.stringify(result, null, 2));
+			break;
+		}
+		default:
+			logger.error(`Unknown command: ${config.command}`);
+			process.exit(2);
+	}
+	logger.debug(`Completed in ${Date.now() - startTime} ms`);
 }
 runFork().catch((error) => {
-  if (error instanceof Error) {
-    if (error.cause instanceof ZodError) {
-      console.error(error.message);
-      for (const err of error.cause.issues) {
-        console.log(`${err.path.join(", ")} => ${err.message}`);
-      }
-      process.exit(3);
-    }
-    console.error(error.message);
-    if (error.stack) console.error(error.stack);
-  } else {
-    console.error(error);
-  }
-  process.exit(1);
+	if (error instanceof Error) {
+		if (error.cause instanceof ZodError) {
+			console.error(error.message);
+			for (const err of error.cause.issues) console.log(`${err.path.join(", ")} => ${err.message}`);
+			process.exit(3);
+		}
+		console.error(error.message);
+		if (error.stack) console.error(error.stack);
+	} else console.error(error);
+	process.exit(1);
 });
-//# sourceMappingURL=cli.js.map
-//# sourceMappingURL=cli.js.map
+//#endregion
+export {};

package/dist/commands/inspect.d.ts

@@ -0,0 +1,9 @@
+import { ForkConfig } from "../config/types.js";
+import { Logger } from "../services/logger.js";
+import { FileManager } from "../files/file-manager.js";
+import { Git } from "../services/git.js";
+
+//#region src/commands/inspect.d.ts
+declare function inspect(config: ForkConfig, logger: Logger, fileManager: FileManager, git: Git): Promise<void>;
+//#endregion
+export { inspect };

package/dist/commands/inspect.js

@@ -0,0 +1,41 @@
+import { getCommitsSinceTag } from "../process/get-commits.js";
+import { getCurrentVersion } from "../process/get-current-version.js";
+import { styleText } from "node:util";
+//#region src/commands/inspect.ts
+async function inspect(config, logger, fileManager, git) {
+	let latestTag = "";
+	let latestVersion = "";
+	try {
+		const commits = await getCommitsSinceTag(config, logger, git);
+		if (commits.latestTag) {
+			latestTag = commits.latestTag;
+			latestVersion = commits.latestTagVersion ?? "";
+		}
+		const currentVersion = await getCurrentVersion(config, logger, git, fileManager, config.files, latestVersion);
+		if (currentVersion.version) latestVersion = currentVersion.version;
+	} catch {}
+	if (!latestVersion && !latestTag) {
+		console.error(styleText("yellowBright", "No version found. Make sure you have at least one tag in your repository."));
+		process.exit(1);
+		return;
+	}
+	switch (config.command) {
+		case "inspect-version":
+			console.log(config.asJson ? JSON.stringify({ version: latestVersion }, null, 2) : latestVersion);
+			return;
+		case "inspect-tag":
+			console.log(config.asJson ? JSON.stringify({ tag: latestTag }, null, 2) : latestTag);
+			return;
+		default:
+			console.log(config.asJson ? JSON.stringify({
+				version: latestVersion,
+				tag: latestTag
+			}, null, 2) : `
+Version: ${latestVersion}
+Tag: ${latestTag}
+`.trim());
+			return;
+	}
+}
+//#endregion
+export { inspect };

package/dist/commands/main.d.ts

@@ -0,0 +1,16 @@
+import { ForkConfig } from "../config/types.js";
+import { Logger } from "../services/logger.js";
+import { FileManager } from "../files/file-manager.js";
+import { Git } from "../services/git.js";
+import { CommitsSinceTag } from "../process/get-commits.js";
+import { CurrentVersion } from "../process/get-current-version.js";
+import { NextVersion } from "../process/get-next-version.js";
+//#region src/commands/main.d.ts
+declare function main(config: ForkConfig, logger: Logger, fileManager: FileManager, git: Git): Promise<{
+  config: ForkConfig;
+  commits: CommitsSinceTag;
+  current: CurrentVersion;
+  next: NextVersion;
+}>;
+//#endregion
+export { main };

package/dist/commands/main.js

@@ -0,0 +1,30 @@
+import { getCommitsSinceTag } from "../process/get-commits.js";
+import { getCurrentVersion } from "../process/get-current-version.js";
+import { 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";
+//#region 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, commits.latestTagVersion);
+	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
+	};
+}
+//#endregion
+export { main };

package/dist/commands/validate-config.d.ts

@@ -0,0 +1,6 @@
+import { ForkConfig } from "../config/types.js";
+
+//#region src/commands/validate-config.d.ts
+declare function validateConfig(config: ForkConfig): void;
+//#endregion
+export { validateConfig };

package/dist/commands/validate-config.js

@@ -0,0 +1,11 @@
+//#region src/commands/validate-config.ts
+function validateConfig(config) {
+	console.log(`
+⚙️ Configuration:
+${JSON.stringify(config, null, 2)}
+
+✅ Configuration is valid.
+`);
+}
+//#endregion
+export { validateConfig };

package/dist/commit-parser/commit-parser.d.ts

@@ -0,0 +1,114 @@
+import { ParserOptions } from "./options.js";
+import { Logger } from "../services/logger.js";
+import { Commit, CommitNote, CommitReference } from "./types.js";
+
+//#region src/commit-parser/commit-parser.d.ts
+declare class CommitParser {
+  #private;
+  constructor(userOptions?: Partial<ParserOptions>);
+  setLogger(logger: Logger): this;
+  createCommit(): Commit;
+  /**
+   * Parse the raw commit message into its expected parts
+   * - subject
+   * - body
+   * - hash
+   * - date
+   * - name
+   * - email
+   *
+   * @throws {ParserError}
+   */
+  parseRawCommit(rawCommit: string): Commit;
+  /**
+   * Parse the commit subject into its expected parts
+   * - type
+   * - scope (optional)
+   * - breaking change (optional)
+   * - title
+   *
+   * @throws {ParserError}
+   */
+  parseSubject(commit: Commit): boolean;
+  /**
+   * Parse merge information from the commit subject
+   * @example
+   * ```txt
+   * "Merge pull request #123 from fork-version/feature"
+   * ```
+   */
+  parseMerge(commit: Commit): boolean;
+  /**
+   * Parse revert information from the commit body
+   * @example
+   * ```txt
+   * "Revert "feat: initial commit"
+   *
+   * This reverts commit 4a79e9e546b4020d2882b7810dc549fa71960f4f."
+   * ```
+   */
+  parseRevert(commit: Commit): boolean;
+  /**
+   * Search for mentions from the commit line
+   * @example
+   * ```txt
+   * "@fork-version"
+   * ```
+   */
+  parseMentions(line: string, outMentions: Set<string>): boolean;
+  /**
+   * Search for references from the commit line
+   * @example
+   * ```txt
+   * "#1234"
+   * "owner/repo#1234"
+   * ```
+   */
+  parseReferenceParts(referenceText: string, action: string | null): CommitReference[] | undefined;
+  /**
+   * Search for actions and references from the commit line
+   * @example
+   * ```txt
+   * "Closes #1234"
+   * "fixes owner/repo#1234"
+   * ```
+   */
+  parseReferences(line: string, outReferences: CommitReference[]): boolean;
+  /**
+   * Search for notes from the commit line
+   * @example
+   * ```txt
+   * "BREAKING CHANGE: this is a breaking change"
+   * ```
+   */
+  parseNotes(line: string, outNotes: CommitNote[]): boolean;
+  /**
+   * Parse the raw commit for mentions, references and notes
+   */
+  parseRawLines(commit: Commit): void;
+  /**
+   * Parse a commit log with the following format separated by new line characters:
+   * ```txt
+   * refactor: add test file
+   * Add a test file to the project
+   * 4ef2c86d393a9660aa9f753144256b1f200c16bd
+   * 2024-12-22T17:36:50Z
+   * Fork Version
+   * fork-version@example.com
+   * ```
+   *
+   * @example
+   * ```ts
+   * parse("refactor: add test file\nAdd a test file to the project\n4ef2c86d393a9660aa9f753144256b1f200c16bd\n2024-12-22T17:36:50Z\nFork Version\nfork-version@example.com");
+   * ```
+   *
+   * The expected input value can be generated by running the following command:
+   * ```sh
+   * git log --format="%s%n%b%n%H%n%cI%n%cN%n%cE%n"
+   * ```
+   * @see {@link https://git-scm.com/docs/pretty-formats|Git Pretty Format Documentation}
+   */
+  parse(rawCommit: string): Commit | undefined;
+}
+//#endregion
+export { CommitParser };