fork-version 4.1.10 → 5.0.1

package/dist/index.d.ts

@@ -1,655 +1,21 @@
-import { z } from 'zod';
-import * as meow from 'meow';
-import { ReleaseType } from 'semver';
-
-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.$ZodLooseShape, z.core.$loose>>;
-}, 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";
-    };
-    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";
-    };
-}>;
-
-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;
-}
-/**
- * Creates parser options by merging user-provided options with default values.
- *
- * Additionally, if a user provides a string for a property that expects a RegExp value,
- * the function will attempt to parse it into a RegExp object.
- *
- * @param userOptions Optional user-provided options to override the defaults.
- * @return A complete set of parser options with defaults applied and user overrides where specified.
- */
-declare function createParserOptions(userOptions?: Partial<ParserOptions>): ParserOptions;
-
-type ForkConfig = z.infer<typeof ForkConfigSchema> & {
-    commitParserOptions?: Partial<ParserOptions>;
-};
-type Config = Partial<ForkConfig>;
-type CLIArguments = ReturnType<typeof getCliArguments>;
-interface ForkVersionCLIArgs {
-    input: CLIArguments["input"];
-    flags: Partial<CLIArguments["flags"]>;
-}
-
-interface LoggerConfig {
-    silent?: ForkConfig["silent"];
-    debug?: ForkConfig["debug"];
-}
-declare class Logger {
-    #private;
-    constructor(config: LoggerConfig);
-    log(message: string): void;
-    warn(message: string): void;
-    error(message: string): void;
-    debug(message: string, ...optionalParams: any[]): void;
-    skipping(message: string): 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;
-    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(pathOrName: 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 GitConfig {
-    path: ForkConfig["path"];
-    dryRun?: ForkConfig["dryRun"];
-}
-declare class Git {
-    #private;
-    constructor(config: GitConfig);
-    /**
-     * 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 most recent tag from the commit history, or `undefined` if no valid semver tags are found
-     *
-     * @example
-     * ```ts
-     * await git.getMostRecentTag("v"); // "1.2.3"
-     * ```
-     */
-    getMostRecentTag(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 inspect(config: ForkConfig, logger: Logger, fileManager: FileManager, git: Git): Promise<void>;
-
-interface CommitMerge {
-    id: string;
-    source: string;
-}
-interface CommitRevert {
-    hash: string;
-    subject: string;
-}
-interface CommitReference {
-    prefix: string;
-    issue: string;
-    action: string | null;
-    owner: string | null;
-    repository: string | null;
-}
-interface CommitNote {
-    title: string;
-    text: string;
-}
-interface Commit {
-    raw: string;
-    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;
-        merges: number;
-        reverts: 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[], latestTagVersion: string | undefined): Promise<CurrentVersion>;
-
-interface CommitsSinceTag {
-    latestTag: string | undefined;
-    latestTagVersion: 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: ForkConfig;
-    commits: CommitsSinceTag;
-    current: CurrentVersion;
-    next: NextVersion;
-}>;
-
-declare function validateConfig(config: ForkConfig): void;
-
-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;
-}
-
-/**
- * Filter out revert commits and their corresponding reverted commits,
- * this function expects the input to be sorted by date in descending order
- * from the most recent to the oldest commit.
- *
- * @example
- * ```ts
- * const commits: Commit[] = [...];
- * const filteredCommits = filterRevertedCommits(commits);
- * ```
- */
-declare function filterRevertedCommits(parsedCommits: Commit[]): Commit[];
-
-/**
- * [Fork-Version - Config Properties](https://github.com/eglavin/fork-version/blob/main/README.md#config-properties)
- */
-declare function defineConfig(config: Config): Config;
-
-declare function getUserConfig(cliArguments: ForkVersionCLIArgs): Promise<ForkConfig>;
-
-declare function updateChangelog(config: ForkConfig, logger: Logger, nextVersion: string): Promise<void>;
-
-declare function commitChanges(config: ForkConfig, logger: Logger, git: Git, files: FileState[], nextVersion: string): Promise<void>;
-
-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, inspect, main, tagChanges, updateChangelog, validateConfig };
+import { ParserOptions, createParserOptions } from "./commit-parser/options.js";
+import { ChangelogPresetConfig, ChangelogPresetConfigType, Config, ForkConfig } from "./config/types.js";
+import { Logger } from "./services/logger.js";
+import { FileManager, FileState, IFileManager, MissingPropertyException } from "./files/file-manager.js";
+import { Git } from "./services/git.js";
+import { inspect } from "./commands/inspect.js";
+import { main } from "./commands/main.js";
+import { validateConfig } from "./commands/validate-config.js";
+import { Commit, CommitMerge, CommitNote, CommitReference, CommitRevert } from "./commit-parser/types.js";
+import { CommitParser } from "./commit-parser/commit-parser.js";
+import { filterRevertedCommits } from "./commit-parser/filter-reverted-commits.js";
+import { ForkConfigSchema } from "./config/schema.js";
+import { defineConfig } from "./config/define-config.js";
+import { getUserConfig } from "./config/user-config.js";
+import { CommitsSinceTag, getCommitsSinceTag } from "./process/get-commits.js";
+import { CurrentVersion, getCurrentVersion } from "./process/get-current-version.js";
+import { NextVersion, 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";
+export { type ChangelogPresetConfig, type ChangelogPresetConfigType, 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, MissingPropertyException, type NextVersion, type ParserOptions, commitChanges, createParserOptions, defineConfig, filterRevertedCommits, getCommitsSinceTag, getCurrentVersion, getNextVersion, getUserConfig, inspect, main, tagChanges, updateChangelog, validateConfig };

package/dist/index.js

@@ -1,10 +1,19 @@
-export { CommitParser, FileManager, ForkConfigSchema, Git, Logger, commitChanges, createParserOptions, filterRevertedCommits, getCommitsSinceTag, getCurrentVersion, getNextVersion, getUserConfig, inspect, main, tagChanges, updateChangelog, validateConfig } from './chunk-L5UDUEHE.js';
-
-// src/config/define-config.ts
-function defineConfig(config) {
-  return config;
-}
-
-export { defineConfig };
-//# sourceMappingURL=index.js.map
-//# sourceMappingURL=index.js.map
+import { createParserOptions } from "./commit-parser/options.js";
+import { CommitParser } from "./commit-parser/commit-parser.js";
+import { filterRevertedCommits } from "./commit-parser/filter-reverted-commits.js";
+import { getCommitsSinceTag } from "./process/get-commits.js";
+import { getCurrentVersion } from "./process/get-current-version.js";
+import { inspect } from "./commands/inspect.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";
+import { main } from "./commands/main.js";
+import { validateConfig } from "./commands/validate-config.js";
+import { ForkConfigSchema } from "./config/schema.js";
+import { defineConfig } from "./config/define-config.js";
+import { Git } from "./services/git.js";
+import { getUserConfig } from "./config/user-config.js";
+import { FileManager, MissingPropertyException } from "./files/file-manager.js";
+import { Logger } from "./services/logger.js";
+export { CommitParser, FileManager, ForkConfigSchema, Git, Logger, MissingPropertyException, commitChanges, createParserOptions, defineConfig, filterRevertedCommits, getCommitsSinceTag, getCurrentVersion, getNextVersion, getUserConfig, inspect, main, tagChanges, updateChangelog, validateConfig };