fork-version 3.0.2 → 3.1.4

package/dist/index.d.ts

@@ -1,71 +1,10 @@
 import { z } from 'zod';
+import * as meow from 'meow';
 import { ReleaseType } from 'semver';
 
-interface ParserOptions {
-    /**
-     * Pattern to match commit subjects
-     * - Expected capture groups: `type` `title`
-     * - Optional capture groups: `scope`, `breakingChange`
-     */
-    subjectPattern: RegExp | undefined;
-    /**
-     * Pattern to match merge commits
-     * - Expected capture groups: `id`, `source`
-     */
-    mergePattern: RegExp | undefined;
-    /**
-     * Pattern to match revert commits
-     * - Expected capture groups: `subject`, `hash`
-     */
-    revertPattern: RegExp | undefined;
-    /**
-     * Pattern to match commented out lines which will be trimmed
-     */
-    commentPattern: RegExp | undefined;
-    /**
-     * Pattern to match mentions
-     * - Expected capture groups: `username`
-     */
-    mentionPattern: RegExp | undefined;
-    /**
-     * List of action labels to match reference sections
-     * @default
-     * ["close", "closes", "closed", "fix", "fixes", "fixed", "resolve", "resolves", "resolved"]
-     */
-    referenceActions?: string[];
-    /**
-     * Pattern to match reference sections
-     * - Expected capture groups: `action`, `reference`
-     */
-    referenceActionPattern: RegExp | undefined;
-    /**
-     * List of issue prefixes to match issue ids
-     * @default
-     * ["#"]
-     */
-    issuePrefixes?: string[];
-    /**
-     * Pattern to match issue references
-     * - Expected capture groups: `repository`, `prefix`, `issue`
-     */
-    issuePattern: RegExp | undefined;
-    /**
-     * List of keywords to match note titles
-     * @default
-     * ["BREAKING CHANGE", "BREAKING-CHANGE"]
-     */
-    noteKeywords?: string[];
-    /**
-     * Pattern to match note sections
-     * - Expected capture groups: `title`
-     * - Optional capture groups: `text`
-     */
-    notePattern: RegExp | undefined;
-}
-declare function createParserOptions(userOptions?: Partial<ParserOptions>): ParserOptions;
-
 declare const ForkConfigSchema: z.ZodObject<{
-    inspectVersion: z.ZodBoolean;
+    command: z.ZodLiteral<"main" | "inspect-version" | "inspect-tag" | "validate-config">;
+    inspectVersion: z.ZodOptional<z.ZodBoolean>;
     files: z.ZodArray<z.ZodString>;
     glob: z.ZodOptional<z.ZodString>;
     path: z.ZodString;
@@ -106,19 +45,332 @@ declare const ForkConfigSchema: z.ZodObject<{
     releaseMessageSuffix: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 
+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";
+    };
+    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";
+    };
+}>;
+
 type ForkConfig = z.infer<typeof ForkConfigSchema>;
 type Config = Partial<ForkConfig>;
+type CLIArguments = ReturnType<typeof getCliArguments>;
+interface ForkVersionCLIArgs {
+    input: CLIArguments["input"];
+    flags: Partial<CLIArguments["flags"]>;
+}
+
+declare class Git {
+    #private;
+    private config;
+    constructor(config: Pick<ForkConfig, "path" | "dryRun">);
+    /**
+     * Add file contents to the index
+     *
+     * [git-add Documentation](https://git-scm.com/docs/git-add)
+     *
+     * @example
+     * ```ts
+     * await git.add("CHANGELOG.md");
+     * ```
+     */
+    add(...args: (string | undefined)[]): Promise<string>;
+    /**
+     * Record changes to the repository
+     *
+     * [git-commit Documentation](https://git-scm.com/docs/git-commit)
+     *
+     * @example
+     * ```ts
+     * await git.commit("--message", "chore(release): 1.2.3");
+     * ```
+     */
+    commit(...args: (string | undefined)[]): Promise<string>;
+    /**
+     * Create, list, delete or verify a tag object
+     *
+     * [git-tag Documentation](https://git-scm.com/docs/git-tag)
+     *
+     * @example
+     * ```ts
+     * await git.tag("--annotate", "v1.2.3", "--message", "chore(release): 1.2.3");
+     * ```
+     */
+    tag(...args: (string | undefined)[]): Promise<string>;
+    /**
+     * Show commit logs
+     *
+     * - [git-log Documentation](https://git-scm.com/docs/git-log)
+     * - [pretty-formats Documentation](https://git-scm.com/docs/pretty-formats)
+     *
+     * @example
+     * ```ts
+     * await git.log("--oneline");
+     * ```
+     */
+    log(...args: (string | undefined)[]): Promise<string>;
+    /**
+     * Check if a file is ignored by git
+     *
+     * [git-check-ignore Documentation](https://git-scm.com/docs/git-check-ignore)
+     *
+     * @example
+     * ```ts
+     * await git.isIgnored("src/my-file.txt");
+     * ```
+     */
+    isIgnored(file: string): Promise<boolean>;
+    /**
+     * Get the name of the current branch
+     *
+     * [git-rev-parse Documentation](https://git-scm.com/docs/git-rev-parse)
+     *
+     * @example
+     * ```ts
+     * await git.getBranchName(); // "main"
+     * ```
+     */
+    getBranchName(): Promise<string>;
+    /**
+     * Get the URL of the remote repository
+     *
+     * [git-config Documentation](https://git-scm.com/docs/git-config)
+     *
+     * @example
+     * ```ts
+     * await git.getRemoteUrl(); // "https://github.com/eglavin/fork-version"
+     * ```
+     */
+    getRemoteUrl(): Promise<string>;
+    /**
+     * `getTags` returns valid semver version tags in order of the commit history
+     *
+     * Using `git log` to get the commit history, we then parse the tags from the
+     * commit details which is expected to be in the following format:
+     * ```txt
+     * commit 3841b1d05750d42197fe958e3d8e06df378a842d (HEAD -> main, tag: v1.0.2, tag: v1.0.1, tag: v1.0.0)
+     * Author: Username <username@example.com>
+     * Date:   Sat Nov 9 15:00:00 2024 +0000
+     *
+     *     chore(release): v1.0.0
+     * ```
+     *
+     * - [Functionality extracted from the conventional-changelog - git-semver-tags project](https://github.com/conventional-changelog/conventional-changelog/blob/fac8045242099c016f5f3905e54e02b7d466bd7b/packages/git-semver-tags/index.js)
+     * - [conventional-changelog git-semver-tags MIT Licence](https://github.com/conventional-changelog/conventional-changelog/blob/fac8045242099c016f5f3905e54e02b7d466bd7b/packages/git-semver-tags/LICENSE.md)
+     *
+     * @example
+     * ```ts
+     * await git.getTags("v"); // ["v1.0.2", "v1.0.1", "v1.0.0"]
+     * ```
+     */
+    getTags(tagPrefix: string | undefined): Promise<string[]>;
+    /**
+     * Returns the latest git tag based on commit date
+     *
+     * @example
+     * ```ts
+     * await git.getMostRecentTag("v"); // "1.2.3"
+     * ```
+     */
+    getMostRecentTag(tagPrefix: string | undefined): Promise<string | undefined>;
+    /**
+     * Get cleaned semver tags, with any tag prefix's removed
+     *
+     * @example
+     * ```ts
+     * await git.getCleanedTags("v"); // ["1.2.3", "1.2.2", "1.2.1"]
+     * ```
+     */
+    getCleanedTags(tagPrefix: string | undefined): Promise<string[]>;
+    /**
+     * Get the highest semver version from git tags. This will return the highest
+     * semver version found for the given tag prefix, regardless of the commit date.
+     *
+     * @example
+     * ```ts
+     * await git.getHighestSemverVersionFromTags("v"); // "1.2.3"
+     * ```
+     */
+    getHighestSemverVersionFromTags(tagPrefix: string | undefined): Promise<string | undefined>;
+    /**
+     * Get commit history in a parsable format
+     *
+     * An array of strings with commit details is returned in the following format:
+     * ```txt
+     * subject
+     * body
+     * hash
+     * committer date
+     * committer name
+     * committer email
+     * ```
+     *
+     * @example
+     * ```ts
+     * await git.getCommits("v1.0.0", "HEAD", "src/utils");
+     * ```
+     */
+    getCommits(from?: string, to?: string, ...paths: string[]): Promise<string[]>;
+}
+
+declare function inspectTag(config: ForkConfig, git: Git): Promise<void>;
 
 declare class Logger {
     private config;
     disableLogs: boolean;
-    constructor(config: Pick<ForkConfig, "silent" | "debug" | "inspectVersion">);
+    constructor(config: Pick<ForkConfig, "silent" | "debug">);
     log(...messages: any[]): void;
     warn(...messages: any[]): void;
     error(...messages: any[]): void;
     debug(...messages: any[]): void;
 }
 
+interface FileState {
+    name: string;
+    path: string;
+    version: string;
+    [other: string]: unknown;
+}
+interface IFileManager {
+    read(fileName: string): FileState | undefined;
+    write(fileState: FileState, newVersion: string): void;
+    isSupportedFile(fileName: string): boolean;
+}
+declare class FileManager {
+    private config;
+    private logger;
+    private JSONPackage;
+    private YAMLPackage;
+    private PlainText;
+    private MSBuildProject;
+    private ARMBicep;
+    constructor(config: ForkConfig, logger: Logger);
+    /**
+     * Get the state from the given file name.
+     *
+     * @example
+     * ```ts
+     * fileManager.read("package.json");
+     * ```
+     *
+     * @returns
+     * ```json
+     * { "name": "package.json", "path": "/path/to/package.json", "version": "1.2.3", "isPrivate": true }
+     * ```
+     */
+    read(fileName: string): FileState | undefined;
+    /**
+     * Write the new version to the given file.
+     *
+     * @example
+     * ```ts
+     * fileManager.write(
+     *   { name: "package.json", path: "/path/to/package.json", version: "1.2.2" },
+     *   "1.2.3"
+     * );
+     * ```
+     */
+    write(fileState: FileState, newVersion: string): void;
+}
+
+declare function inspectVersion(config: ForkConfig, logger: Logger, fileManager: FileManager, git: Git): Promise<void>;
+
 interface CommitMerge {
     id: string;
     source: string;
@@ -143,30 +395,169 @@ interface Commit {
     subject: string;
     body: string;
     hash: string;
+    refNames: string;
+    /**
+     * Committer date in ISO 8601 format
+     * @example
+     * "2024-12-22T17:36:50Z"
+     */
+    date: string;
+    /**
+     * Committer name (respects .mailmap)
+     */
+    name: string;
+    /**
+     * Committer email (respects .mailmap)
+     */
+    email: string;
+    type: string;
+    scope: string;
+    breakingChange: string;
+    title: string;
+    merge: CommitMerge | null;
+    revert: CommitRevert | null;
+    mentions: string[];
+    references: CommitReference[];
+    notes: CommitNote[];
+    tags: string[];
+}
+
+interface NextVersion {
+    version: string;
+    releaseType?: ReleaseType;
+    preMajor?: boolean;
+    changes?: {
+        major: number;
+        minor: number;
+        patch: number;
+    };
+}
+declare function getNextVersion(config: ForkConfig, logger: Logger, commits: Commit[], currentVersion: string): Promise<NextVersion>;
+
+interface CurrentVersion {
+    version: string;
+    files: FileState[];
+}
+declare function getCurrentVersion(config: ForkConfig, logger: Logger, git: Git, fileManager: FileManager, filesToUpdate: string[]): Promise<CurrentVersion>;
+
+interface CommitsSinceTag {
+    latestTag: string | undefined;
+    commits: Commit[];
+}
+declare function getCommitsSinceTag(config: ForkConfig, logger: Logger, git: Git): Promise<CommitsSinceTag>;
+
+declare function main(config: ForkConfig, logger: Logger, fileManager: FileManager, git: Git): Promise<{
+    config: {
+        command: "main" | "inspect-version" | "inspect-tag" | "validate-config";
+        files: string[];
+        path: string;
+        changelog: string;
+        header: string;
+        tagPrefix: string;
+        allowMultipleVersions: boolean;
+        commitAll: boolean;
+        changelogAll: boolean;
+        debug: boolean;
+        dryRun: boolean;
+        silent: boolean;
+        gitTagFallback: boolean;
+        sign: boolean;
+        verify: boolean;
+        skipBump: boolean;
+        skipChangelog: boolean;
+        skipCommit: boolean;
+        skipTag: boolean;
+        changelogPresetConfig: {
+            types?: {
+                type: string;
+                scope?: string | undefined;
+                section?: string | undefined;
+                hidden?: boolean | undefined;
+            }[] | undefined;
+            commitUrlFormat?: string | undefined;
+            compareUrlFormat?: string | undefined;
+            issueUrlFormat?: string | undefined;
+            userUrlFormat?: string | undefined;
+            releaseCommitMessageFormat?: string | undefined;
+            issuePrefixes?: string[] | undefined;
+        };
+        inspectVersion?: boolean | undefined;
+        glob?: string | undefined;
+        preRelease?: string | boolean | undefined;
+        currentVersion?: string | undefined;
+        nextVersion?: string | undefined;
+        releaseAs?: "major" | "minor" | "patch" | undefined;
+        releaseMessageSuffix?: string | undefined;
+    };
+    commits: CommitsSinceTag;
+    current: CurrentVersion;
+    next: NextVersion;
+}>;
+
+declare function validateConfig(config: ForkConfig): void;
+
+interface ParserOptions {
+    /**
+     * Pattern to match commit subjects
+     * - Expected capture groups: `type` `title`
+     * - Optional capture groups: `scope`, `breakingChange`
+     */
+    subjectPattern: RegExp | undefined;
+    /**
+     * Pattern to match merge commits
+     * - Expected capture groups: `id`, `source`
+     */
+    mergePattern: RegExp | undefined;
+    /**
+     * Pattern to match revert commits
+     * - Expected capture groups: `subject`, `hash`
+     */
+    revertPattern: RegExp | undefined;
+    /**
+     * Pattern to match commented out lines which will be trimmed
+     */
+    commentPattern: RegExp | undefined;
+    /**
+     * Pattern to match mentions
+     * - Expected capture groups: `username`
+     */
+    mentionPattern: RegExp | undefined;
+    /**
+     * List of action labels to match reference sections
+     * @default
+     * ["close", "closes", "closed", "fix", "fixes", "fixed", "resolve", "resolves", "resolved"]
+     */
+    referenceActions?: string[];
+    /**
+     * Pattern to match reference sections
+     * - Expected capture groups: `action`, `reference`
+     */
+    referenceActionPattern: RegExp | undefined;
+    /**
+     * List of issue prefixes to match issue ids
+     * @default
+     * ["#"]
+     */
+    issuePrefixes?: string[];
     /**
-     * Committer date in ISO 8601 format
-     * @example
-     * "2024-12-22T17:36:50Z"
+     * Pattern to match issue references
+     * - Expected capture groups: `repository`, `prefix`, `issue`
      */
-    date: string;
+    issuePattern: RegExp | undefined;
     /**
-     * Committer name (respects .mailmap)
+     * List of keywords to match note titles
+     * @default
+     * ["BREAKING CHANGE", "BREAKING-CHANGE"]
      */
-    name: string;
+    noteKeywords?: string[];
     /**
-     * Committer email (respects .mailmap)
+     * Pattern to match note sections
+     * - Expected capture groups: `title`
+     * - Optional capture groups: `text`
      */
-    email: string;
-    type: string;
-    scope: string;
-    breakingChange: string;
-    title: string;
-    merge: CommitMerge | null;
-    revert: CommitRevert | null;
-    mentions: string[];
-    references: CommitReference[];
-    notes: CommitNote[];
+    notePattern: RegExp | undefined;
 }
+declare function createParserOptions(userOptions?: Partial<ParserOptions>): ParserOptions;
 
 declare class CommitParser {
     #private;
@@ -294,266 +685,7 @@ declare function filterRevertedCommits(parsedCommits: Commit[]): Commit[];
  */
 declare function defineConfig(config: Config): Config;
 
-declare function getCliArguments(): {
-    inspectVersion: boolean | undefined;
-    files: string[] | undefined;
-    glob: string | undefined;
-    path: string | undefined;
-    changelog: string | undefined;
-    header: string | undefined;
-    tagPrefix: string | undefined;
-    preRelease: boolean | undefined;
-    preReleaseTag: string | undefined;
-    currentVersion: string | undefined;
-    nextVersion: string | undefined;
-    releaseAs: string | undefined;
-    allowMultipleVersions: boolean | undefined;
-    commitAll: boolean | undefined;
-    changelogAll: boolean | undefined;
-    debug: boolean | undefined;
-    dryRun: boolean | undefined;
-    silent: boolean | undefined;
-    gitTagFallback: boolean | undefined;
-    sign: boolean | undefined;
-    verify: boolean | undefined;
-    skipBump: boolean | undefined;
-    skipChangelog: boolean | undefined;
-    skipCommit: boolean | undefined;
-    skipTag: boolean | undefined;
-    commitUrlFormat: string | undefined;
-    compareUrlFormat: string | undefined;
-    issueUrlFormat: string | undefined;
-    userUrlFormat: string | undefined;
-    releaseCommitMessageFormat: string | undefined;
-    releaseMessageSuffix: string | undefined;
-} & Record<string, unknown>;
-
-declare function getUserConfig(cliArguments: Partial<ReturnType<typeof getCliArguments>>): Promise<ForkConfig>;
-
-declare class Git {
-    #private;
-    private config;
-    constructor(config: Pick<ForkConfig, "path" | "dryRun">);
-    /**
-     * Add file contents to the index
-     *
-     * [git-add Documentation](https://git-scm.com/docs/git-add)
-     *
-     * @example
-     * ```ts
-     * await git.add("CHANGELOG.md");
-     * ```
-     */
-    add(...args: (string | undefined)[]): Promise<string>;
-    /**
-     * Record changes to the repository
-     *
-     * [git-commit Documentation](https://git-scm.com/docs/git-commit)
-     *
-     * @example
-     * ```ts
-     * await git.commit("--message", "chore(release): 1.2.3");
-     * ```
-     */
-    commit(...args: (string | undefined)[]): Promise<string>;
-    /**
-     * Create, list, delete or verify a tag object
-     *
-     * [git-tag Documentation](https://git-scm.com/docs/git-tag)
-     *
-     * @example
-     * ```ts
-     * await git.tag("--annotate", "v1.2.3", "--message", "chore(release): 1.2.3");
-     * ```
-     */
-    tag(...args: (string | undefined)[]): Promise<string>;
-    /**
-     * Show commit logs
-     *
-     * - [git-log Documentation](https://git-scm.com/docs/git-log)
-     * - [pretty-formats Documentation](https://git-scm.com/docs/pretty-formats)
-     *
-     * @example
-     * ```ts
-     * await git.log("--oneline");
-     * ```
-     */
-    log(...args: (string | undefined)[]): Promise<string>;
-    /**
-     * Check if a file is ignored by git
-     *
-     * [git-check-ignore Documentation](https://git-scm.com/docs/git-check-ignore)
-     *
-     * @example
-     * ```ts
-     * await git.isIgnored("src/my-file.txt");
-     * ```
-     */
-    isIgnored(file: string): Promise<boolean>;
-    /**
-     * Get the name of the current branch
-     *
-     * [git-rev-parse Documentation](https://git-scm.com/docs/git-rev-parse)
-     *
-     * @example
-     * ```ts
-     * await git.getBranchName(); // "main"
-     * ```
-     */
-    getBranchName(): Promise<string>;
-    /**
-     * Get the URL of the remote repository
-     *
-     * [git-config Documentation](https://git-scm.com/docs/git-config)
-     *
-     * @example
-     * ```ts
-     * await git.getRemoteUrl(); // "https://github.com/eglavin/fork-version"
-     * ```
-     */
-    getRemoteUrl(): Promise<string>;
-    /**
-     * `getTags` returns valid semver version tags in order of the commit history
-     *
-     * Using `git log` to get the commit history, we then parse the tags from the
-     * commit details which is expected to be in the following format:
-     * ```txt
-     * commit 3841b1d05750d42197fe958e3d8e06df378a842d (HEAD -> main, tag: v1.0.2, tag: v1.0.1, tag: v1.0.0)
-     * Author: Username <username@example.com>
-     * Date:   Sat Nov 9 15:00:00 2024 +0000
-     *
-     *     chore(release): v1.0.0
-     * ```
-     *
-     * - [Functionality extracted from the conventional-changelog - git-semver-tags project](https://github.com/conventional-changelog/conventional-changelog/blob/fac8045242099c016f5f3905e54e02b7d466bd7b/packages/git-semver-tags/index.js)
-     * - [conventional-changelog git-semver-tags MIT Licence](https://github.com/conventional-changelog/conventional-changelog/blob/fac8045242099c016f5f3905e54e02b7d466bd7b/packages/git-semver-tags/LICENSE.md)
-     *
-     * @example
-     * ```ts
-     * await git.getTags("v"); // ["v1.0.2", "v1.0.1", "v1.0.0"]
-     * ```
-     */
-    getTags(tagPrefix: string | undefined): Promise<string[]>;
-    /**
-     * Returns the latest git tag based on commit date
-     *
-     * @example
-     * ```ts
-     * await git.getMostRecentTag("v"); // "1.2.3"
-     * ```
-     */
-    getMostRecentTag(tagPrefix: string | undefined): Promise<string | undefined>;
-    /**
-     * Get cleaned semver tags, with any tag prefix's removed
-     *
-     * @example
-     * ```ts
-     * await git.getCleanedTags("v"); // ["1.2.3", "1.2.2", "1.2.1"]
-     * ```
-     */
-    getCleanedTags(tagPrefix: string | undefined): Promise<string[]>;
-    /**
-     * Get the highest semver version from git tags. This will return the highest
-     * semver version found for the given tag prefix, regardless of the commit date.
-     *
-     * @example
-     * ```ts
-     * await git.getHighestSemverVersionFromTags("v"); // "1.2.3"
-     * ```
-     */
-    getHighestSemverVersionFromTags(tagPrefix: string | undefined): Promise<string | undefined>;
-    /**
-     * Get commit history in a parsable format
-     *
-     * An array of strings with commit details is returned in the following format:
-     * ```txt
-     * subject
-     * body
-     * hash
-     * committer date
-     * committer name
-     * committer email
-     * ```
-     *
-     * @example
-     * ```ts
-     * await git.getCommits("v1.0.0", "HEAD", "src/utils");
-     * ```
-     */
-    getCommits(from?: string, to?: string, ...paths: string[]): Promise<string[]>;
-}
-
-interface CommitsSinceTag {
-    latestTag: string | undefined;
-    commits: Commit[];
-}
-declare function getCommitsSinceTag(config: ForkConfig, logger: Logger, git: Git): Promise<CommitsSinceTag>;
-
-interface FileState {
-    name: string;
-    path: string;
-    version: string;
-    [other: string]: unknown;
-}
-interface IFileManager {
-    read(fileName: string): FileState | undefined;
-    write(fileState: FileState, newVersion: string): void;
-    isSupportedFile(fileName: string): boolean;
-}
-declare class FileManager {
-    private config;
-    private logger;
-    private JSONPackage;
-    private YAMLPackage;
-    private PlainText;
-    private MSBuildProject;
-    private ARMBicep;
-    constructor(config: ForkConfig, logger: Logger);
-    /**
-     * Get the state from the given file name.
-     *
-     * @example
-     * ```ts
-     * fileManager.read("package.json");
-     * ```
-     *
-     * @returns
-     * ```json
-     * { "name": "package.json", "path": "/path/to/package.json", "version": "1.2.3", "isPrivate": true }
-     * ```
-     */
-    read(fileName: string): FileState | undefined;
-    /**
-     * Write the new version to the given file.
-     *
-     * @example
-     * ```ts
-     * fileManager.write(
-     *   { name: "package.json", path: "/path/to/package.json", version: "1.2.2" },
-     *   "1.2.3"
-     * );
-     * ```
-     */
-    write(fileState: FileState, newVersion: string): void;
-}
-
-interface CurrentVersion {
-    version: string;
-    files: FileState[];
-}
-declare function getCurrentVersion(config: ForkConfig, logger: Logger, git: Git, fileManager: FileManager, filesToUpdate: string[]): Promise<CurrentVersion>;
-
-interface NextVersion {
-    version: string;
-    releaseType?: ReleaseType;
-    preMajor?: boolean;
-    changes?: {
-        major: number;
-        minor: number;
-        patch: number;
-    };
-}
-declare function getNextVersion(config: ForkConfig, logger: Logger, commits: Commit[], currentVersion: string): Promise<NextVersion>;
+declare function getUserConfig(cliArguments: ForkVersionCLIArgs): Promise<ForkConfig>;
 
 declare function updateChangelog(config: ForkConfig, logger: Logger, nextVersion: string): Promise<void>;
 
@@ -561,4 +693,4 @@ declare function commitChanges(config: ForkConfig, logger: Logger, git: Git, fil
 
 declare function tagChanges(config: ForkConfig, logger: Logger, git: Git, nextVersion: string): Promise<void>;
 
-export { type Commit, type CommitMerge, type CommitNote, CommitParser, type CommitReference, type CommitRevert, type CommitsSinceTag, type Config, type CurrentVersion, FileManager, type FileState, type ForkConfig, ForkConfigSchema, Git, type IFileManager, Logger, type NextVersion, type ParserOptions, commitChanges, createParserOptions, defineConfig, filterRevertedCommits, getCommitsSinceTag, getCurrentVersion, getNextVersion, getUserConfig, tagChanges, updateChangelog };
+export { type Commit, type CommitMerge, type CommitNote, CommitParser, type CommitReference, type CommitRevert, type CommitsSinceTag, type Config, type CurrentVersion, FileManager, type FileState, type ForkConfig, ForkConfigSchema, Git, type IFileManager, Logger, type NextVersion, type ParserOptions, commitChanges, createParserOptions, defineConfig, filterRevertedCommits, getCommitsSinceTag, getCurrentVersion, getNextVersion, getUserConfig, inspectTag, inspectVersion, main, tagChanges, updateChangelog, validateConfig };