fork-version 4.1.4 → 4.1.8

package/dist/index.d.ts

@@ -3,7 +3,7 @@ import * as meow from 'meow';
 import { ReleaseType } from 'semver';
 
 declare const ForkConfigSchema: z.ZodObject<{
-    command: z.ZodLiteral<"main" | "inspect-version" | "inspect-tag" | "validate-config">;
+    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>;
@@ -24,11 +24,13 @@ declare const ForkConfigSchema: z.ZodObject<{
     gitTagFallback: z.ZodBoolean;
     sign: z.ZodBoolean;
     verify: z.ZodBoolean;
+    asJson: z.ZodBoolean;
     skipBump: z.ZodBoolean;
     skipChangelog: z.ZodBoolean;
     skipCommit: z.ZodBoolean;
     skipTag: z.ZodBoolean;
-    changelogPresetConfig: z.ZodObject<{
+    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>;
@@ -41,8 +43,9 @@ declare const ForkConfigSchema: z.ZodObject<{
         userUrlFormat: z.ZodOptional<z.ZodString>;
         releaseCommitMessageFormat: z.ZodOptional<z.ZodString>;
         issuePrefixes: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    }, z.core.$strip>;
+    }, 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<{
@@ -116,6 +119,9 @@ declare function getCliArguments(): meow.Result<{
     verify: {
         type: "boolean";
     };
+    asJson: {
+        type: "boolean";
+    };
     skipBump: {
         type: "boolean";
     };
@@ -148,7 +154,72 @@ declare function getCliArguments(): meow.Result<{
     };
 }>;
 
-type ForkConfig = z.infer<typeof ForkConfigSchema>;
+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;
+
+type ForkConfig = z.infer<typeof ForkConfigSchema> & {
+    commitParserOptions?: Partial<ParserOptions>;
+};
 type Config = Partial<ForkConfig>;
 type CLIArguments = ReturnType<typeof getCliArguments>;
 interface ForkVersionCLIArgs {
@@ -156,10 +227,69 @@ interface ForkVersionCLIArgs {
     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;
-    private config;
-    constructor(config: Pick<ForkConfig, "path" | "dryRun">);
+    constructor(config: GitConfig);
     /**
      * Add file contents to the index
      *
@@ -261,7 +391,7 @@ declare class Git {
      */
     getTags(tagPrefix: string | undefined): Promise<string[]>;
     /**
-     * Returns the latest git tag based on commit date
+     * Returns the most recent tag from the commit history, or `undefined` if no valid semver tags are found
      *
      * @example
      * ```ts
@@ -269,25 +399,6 @@ declare class Git {
      * ```
      */
     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
      *
@@ -309,62 +420,7 @@ declare class Git {
     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">);
-    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;
-}
-
-declare function inspectVersion(config: ForkConfig, logger: Logger, fileManager: FileManager, git: Git): Promise<void>;
+declare function inspect(config: ForkConfig, logger: Logger, fileManager: FileManager, git: Git): Promise<void>;
 
 interface CommitMerge {
     id: string;
@@ -435,57 +491,17 @@ interface CurrentVersion {
     version: string;
     files: FileState[];
 }
-declare function getCurrentVersion(config: ForkConfig, logger: Logger, git: Git, fileManager: FileManager, filesToUpdate: string[]): Promise<CurrentVersion>;
+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: {
-        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;
-    };
+    config: ForkConfig;
     commits: CommitsSinceTag;
     current: CurrentVersion;
     next: NextVersion;
@@ -493,69 +509,6 @@ declare function main(config: ForkConfig, logger: Logger, fileManager: FileManag
 
 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[];
-    /**
-     * 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 class CommitParser {
     #private;
     constructor(userOptions?: Partial<ParserOptions>);
@@ -690,4 +643,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, inspectTag, inspectVersion, main, tagChanges, updateChangelog, validateConfig };
+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 };

package/dist/index.js

@@ -1,4 +1,4 @@
-export { CommitParser, FileManager, ForkConfigSchema, Git, Logger, commitChanges, createParserOptions, filterRevertedCommits, getCommitsSinceTag, getCurrentVersion, getNextVersion, getUserConfig, inspectTag, inspectVersion, main, tagChanges, updateChangelog, validateConfig } from './chunk-I76EAKJC.js';
+export { CommitParser, FileManager, ForkConfigSchema, Git, Logger, commitChanges, createParserOptions, filterRevertedCommits, getCommitsSinceTag, getCurrentVersion, getNextVersion, getUserConfig, inspect, main, tagChanges, updateChangelog, validateConfig } from './chunk-X4NB24VR.js';
 
 // src/config/define-config.ts
 function defineConfig(config) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fork-version",
-  "version": "4.1.4",
+  "version": "4.1.8",
   "license": "MIT",
   "description": "Fork-Version automates version control tasks such as determining, updating, and committing versions, files, and changelogs, simplifying the process when adhering to the conventional commit standard.",
   "keywords": [