fork-version 4.1.9 → 5.0.0

package/dist/config/cli-arguments.d.ts

@@ -0,0 +1,109 @@
+import * as _$meow from "meow";
+
+//#region src/config/cli-arguments.d.ts
+declare function getCliArguments(): _$meow.Result<{
+  /** @deprecated Set the `inspect-version` command instead. */inspectVersion: {
+    type: "boolean";
+  };
+  files: {
+    type: "string";
+    isMultiple: true;
+    aliases: string[];
+    shortFlag: string;
+  };
+  glob: {
+    type: "string";
+    shortFlag: string;
+  };
+  path: {
+    type: "string";
+    shortFlag: string;
+  };
+  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: string[];
+  };
+  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";
+  };
+  skipBump: {
+    type: "boolean";
+  };
+  skipChangelog: {
+    type: "boolean";
+  };
+  skipCommit: {
+    type: "boolean";
+  };
+  skipTag: {
+    type: "boolean";
+  };
+  commitUrlFormat: {
+    type: "string";
+  };
+  compareUrlFormat: {
+    type: "string";
+  };
+  issueUrlFormat: {
+    type: "string";
+  };
+  userUrlFormat: {
+    type: "string";
+  };
+  releaseCommitMessageFormat: {
+    type: "string";
+  };
+  releaseMessageSuffix: {
+    type: "string";
+  };
+}>;
+//#endregion
+export { getCliArguments };

package/dist/config/cli-arguments.js

@@ -0,0 +1,141 @@
+import meow from "meow";
+//#region src/config/cli-arguments.ts
+const 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: {
+			inspectVersion: { type: "boolean" },
+			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"
+				]
+			},
+			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" },
+			skipBump: { type: "boolean" },
+			skipChangelog: { type: "boolean" },
+			skipCommit: { type: "boolean" },
+			skipTag: { type: "boolean" },
+			commitUrlFormat: { type: "string" },
+			compareUrlFormat: { type: "string" },
+			issueUrlFormat: { type: "string" },
+			userUrlFormat: { type: "string" },
+			releaseCommitMessageFormat: { type: "string" },
+			releaseMessageSuffix: { type: "string" }
+		}
+	});
+}
+//#endregion
+export { getCliArguments };

package/dist/config/defaults.js

@@ -0,0 +1,38 @@
+//#region src/config/defaults.ts
+const DEFAULT_CONFIG = {
+	command: "main",
+	files: [
+		"package.json",
+		"package-lock.json",
+		"npm-shrinkwrap.json",
+		"jsr.json",
+		"jsr.jsonc",
+		"deno.json",
+		"deno.jsonc",
+		"manifest.json",
+		"bower.json"
+	],
+	path: process.cwd(),
+	changelog: "CHANGELOG.md",
+	header: `# Changelog
+
+All notable changes to this project will be documented in this file. See [fork-version](https://github.com/eglavin/fork-version) for commit guidelines.
+`,
+	tagPrefix: "v",
+	allowMultipleVersions: true,
+	commitAll: false,
+	changelogAll: false,
+	debug: false,
+	dryRun: false,
+	silent: false,
+	gitTagFallback: true,
+	sign: false,
+	verify: false,
+	asJson: false,
+	skipBump: false,
+	skipChangelog: false,
+	skipCommit: false,
+	skipTag: false
+};
+//#endregion
+export { DEFAULT_CONFIG };

package/dist/config/define-config.d.ts

@@ -0,0 +1,9 @@
+import { Config } from "./types.js";
+
+//#region src/config/define-config.d.ts
+/**
+ * [Fork-Version - Config Properties](https://github.com/eglavin/fork-version/blob/main/README.md#config-properties)
+ */
+declare function defineConfig(config: Config): Config;
+//#endregion
+export { defineConfig };

package/dist/config/define-config.js

@@ -0,0 +1,9 @@
+//#region src/config/define-config.ts
+/**
+* [Fork-Version - Config Properties](https://github.com/eglavin/fork-version/blob/main/README.md#config-properties)
+*/
+function defineConfig(config) {
+	return config;
+}
+//#endregion
+export { defineConfig };

package/dist/config/load-config.js

@@ -0,0 +1,45 @@
+import { ForkConfigSchema } from "./schema.js";
+import { parse } from "node:path";
+import { readFileSync } from "node:fs";
+import JoyCon from "joycon";
+import { bundleRequire } from "bundle-require";
+//#region src/config/load-config.ts
+/**
+* Name of the key in the package.json file that contains the users configuration.
+*/
+const PACKAGE_JSON_CONFIG_KEY = "fork-version";
+async function loadConfigFile(cwd) {
+	const configFilePath = await new JoyCon({
+		cwd,
+		packageKey: PACKAGE_JSON_CONFIG_KEY,
+		stopDir: parse(cwd).root
+	}).resolve([
+		"fork.config.ts",
+		"fork.config.js",
+		"fork.config.cjs",
+		"fork.config.mjs",
+		"fork.config.json",
+		"package.json"
+	]);
+	if (!configFilePath) return {};
+	if (configFilePath.endsWith("json")) {
+		const fileContent = JSON.parse(readFileSync(configFilePath).toString());
+		if (configFilePath.endsWith("package.json")) {
+			if (fileContent[PACKAGE_JSON_CONFIG_KEY] && typeof fileContent[PACKAGE_JSON_CONFIG_KEY] === "object") {
+				const parsed = ForkConfigSchema.partial().safeParse(fileContent[PACKAGE_JSON_CONFIG_KEY]);
+				if (!parsed.success) throw new Error(`Validation error in: ${configFilePath}`, { cause: parsed.error });
+				return parsed.data;
+			}
+			return {};
+		}
+		const parsed = ForkConfigSchema.partial().safeParse(fileContent);
+		if (!parsed.success) throw new Error(`Validation error in: ${configFilePath}`, { cause: parsed.error });
+		return parsed.data;
+	}
+	const fileContent = await bundleRequire({ filepath: configFilePath });
+	const parsed = ForkConfigSchema.partial().safeParse(fileContent.mod.default || fileContent.mod);
+	if (!parsed.success) throw new Error(`Validation error in: ${configFilePath}`, { cause: parsed.error });
+	return parsed.data;
+}
+//#endregion
+export { loadConfigFile };

package/dist/config/merge-files.js

@@ -0,0 +1,12 @@
+import { DEFAULT_CONFIG } from "./defaults.js";
+//#region src/config/merge-files.ts
+function mergeFiles(configFiles, cliFiles, globResults) {
+	const listOfFiles = /* @__PURE__ */ new Set();
+	if (Array.isArray(configFiles)) configFiles.forEach((file) => listOfFiles.add(file));
+	if (Array.isArray(cliFiles)) cliFiles.forEach((file) => listOfFiles.add(file));
+	globResults.forEach((file) => listOfFiles.add(file));
+	if (listOfFiles.size) return Array.from(listOfFiles);
+	return DEFAULT_CONFIG.files;
+}
+//#endregion
+export { mergeFiles };

package/dist/config/schema.d.ts

@@ -0,0 +1,50 @@
+import { z } from "zod";
+
+//#region src/config/schema.d.ts
+declare const ForkConfigSchema: z.ZodObject<{
+  command: z.ZodLiteral<"main" | "inspect" | "inspect-version" | "inspect-tag" | "validate-config">;
+  inspectVersion: z.ZodOptional<z.ZodBoolean>;
+  files: z.ZodArray<z.ZodString>;
+  glob: z.ZodOptional<z.ZodString>;
+  path: z.ZodString;
+  changelog: z.ZodString;
+  header: z.ZodString;
+  tagPrefix: z.ZodString;
+  preRelease: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+  currentVersion: z.ZodOptional<z.ZodString>;
+  nextVersion: z.ZodOptional<z.ZodString>;
+  releaseAs: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"major">, z.ZodLiteral<"minor">, z.ZodLiteral<"patch">]>>;
+  allowMultipleVersions: z.ZodBoolean;
+  commitAll: z.ZodBoolean;
+  changelogAll: z.ZodBoolean;
+  debug: z.ZodBoolean;
+  dryRun: z.ZodBoolean;
+  silent: z.ZodBoolean;
+  gitTagFallback: z.ZodBoolean;
+  sign: z.ZodBoolean;
+  verify: z.ZodBoolean;
+  asJson: z.ZodBoolean;
+  skipBump: z.ZodBoolean;
+  skipChangelog: z.ZodBoolean;
+  skipCommit: z.ZodBoolean;
+  skipTag: z.ZodBoolean;
+  detectedGitHost: z.ZodOptional<z.ZodString>;
+  changelogPresetConfig: z.ZodOptional<z.ZodObject<{
+    types: z.ZodOptional<z.ZodArray<z.ZodObject<{
+      type: z.ZodString;
+      scope: z.ZodOptional<z.ZodString>;
+      section: z.ZodOptional<z.ZodString>;
+      hidden: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>>;
+    commitUrlFormat: z.ZodOptional<z.ZodString>;
+    compareUrlFormat: z.ZodOptional<z.ZodString>;
+    issueUrlFormat: z.ZodOptional<z.ZodString>;
+    userUrlFormat: z.ZodOptional<z.ZodString>;
+    releaseCommitMessageFormat: z.ZodOptional<z.ZodString>;
+    issuePrefixes: z.ZodOptional<z.ZodArray<z.ZodString>>;
+  }, z.core.$strip>>;
+  releaseMessageSuffix: z.ZodOptional<z.ZodString>;
+  commitParserOptions: z.ZodOptional<z.ZodObject<{}, z.core.$loose>>;
+}, z.core.$strip>;
+//#endregion
+export { ForkConfigSchema };

package/dist/config/schema.js

@@ -0,0 +1,61 @@
+import { z } from "zod";
+//#region src/config/schema.ts
+const ChangelogPresetConfigTypeSchema = z.object({
+	type: z.string().describe("The type of commit message, such as \"feat\", \"fix\", \"chore\"."),
+	scope: z.string().optional().describe("The scope of the commit message."),
+	section: z.string().optional().describe("The section of the `CHANGELOG` the commit should show up in."),
+	hidden: z.boolean().optional().describe("Should show in the generated changelog message?")
+});
+const ChangelogPresetConfigSchema = z.object({
+	types: z.array(ChangelogPresetConfigTypeSchema).describe("List of explicitly supported commit message types."),
+	commitUrlFormat: z.string().describe("A URL representing a specific commit at a hash."),
+	compareUrlFormat: z.string().describe("A URL representing the comparison between two git SHAs."),
+	issueUrlFormat: z.string().describe("A URL representing the issue format."),
+	userUrlFormat: z.string().describe("A URL representing a user's profile on GitHub, Gitlab, etc."),
+	releaseCommitMessageFormat: z.string().describe("A string to be used to format the auto-generated release commit message."),
+	issuePrefixes: z.array(z.string()).describe("List of prefixes used to detect references to issues.")
+});
+const ForkConfigSchema = z.object({
+	command: z.literal([
+		"main",
+		"inspect",
+		"inspect-version",
+		"inspect-tag",
+		"validate-config"
+	]).describe("The command to run. Can be one of: main, inspect, inspect-version, inspect-tag, validate-config. Defaults to main."),
+	inspectVersion: z.boolean().optional().describe("If set, Fork-Version will print the current version and exit."),
+	files: z.array(z.string()).describe("List of the files to be updated."),
+	glob: z.string().optional().describe("Glob pattern to match files to be updated."),
+	path: z.string().describe("The path Fork-Version will run from. Defaults to \"process.cwd()\"."),
+	changelog: z.string().describe("Name of the changelog file. Defaults to \"CHANGELOG.md\"."),
+	header: z.string().describe("The header text for the changelog."),
+	tagPrefix: z.string().describe("Specify a prefix for the created tag. Defaults to \"v\"."),
+	preRelease: z.string().or(z.boolean()).optional().describe("Make a pre-release with optional label if given value is a string."),
+	currentVersion: z.string().optional().describe("If set, Fork-Version will use this version instead of trying to determine one."),
+	nextVersion: z.string().optional().describe("If set, Fork-Version will attempt to update to this version, instead of incrementing using \"conventional-commit\"."),
+	releaseAs: z.union([
+		z.literal("major"),
+		z.literal("minor"),
+		z.literal("patch")
+	]).optional().describe("Release as increments the version by the specified level. Overrides the default behaviour of \"conventional-commit\"."),
+	allowMultipleVersions: z.boolean().describe("Don't throw an error if multiple versions are found in the given files."),
+	commitAll: z.boolean().describe("Commit all changes, not just files updated by Fork-Version."),
+	changelogAll: z.boolean().describe("If this flag is set, all default commit types will be added to the changelog, not just `feat` and `fix`."),
+	debug: z.boolean().describe("Output debug information."),
+	dryRun: z.boolean().describe("No output will be written to disk or committed."),
+	silent: z.boolean().describe("Run without logging to the terminal."),
+	gitTagFallback: z.boolean().describe("If unable to find a version in the given files, fallback and attempt to use the latest git tag. Defaults to true."),
+	sign: z.boolean().describe("If true, git will sign the commit with the systems GPG key."),
+	verify: z.boolean().describe("If true, git will run user defined git hooks before committing."),
+	asJson: z.boolean().describe("Print inspected output as a parsable json string."),
+	skipBump: z.boolean().describe("Skip the bump step."),
+	skipChangelog: z.boolean().describe("Skip the changelog step."),
+	skipCommit: z.boolean().describe("Skip the commit step."),
+	skipTag: z.boolean().describe("Skip the tag step."),
+	detectedGitHost: z.string().optional().describe("The detected git host, such as GitHub, GitLab, Bitbucket, Azure Devops, or undefined if unknown or not detected."),
+	changelogPresetConfig: ChangelogPresetConfigSchema.partial().optional().describe("Override the default \"conventional-changelog-conventionalcommits\" preset configuration."),
+	releaseMessageSuffix: z.string().optional().describe("Add a suffix to the release commit message."),
+	commitParserOptions: z.looseObject({}).optional().describe("Options to pass to commits parser.")
+});
+//#endregion
+export { ChangelogPresetConfigSchema, ChangelogPresetConfigTypeSchema, ForkConfigSchema };