fork-version 1.4.14 → 1.4.50

package/dist/index.d.cts

@@ -3,26 +3,18 @@ import { ReleaseType } from 'semver';
 
 declare const ForkConfigSchema: z.ZodObject<{
     /**
-     * The path where the changes should be calculated from.
+     * The path fork-version will run from.
      * @default
      * ```js
      * process.cwd()
      * ```
      */
-    changePath: z.ZodString;
+    path: z.ZodString;
     /**
-     * The name of the changelog file.
+     * Name of the changelog file.
      * @default "CHANGELOG.md"
      */
     changelog: z.ZodString;
-    /**
-     * Files to be updated.
-     * @default
-     * ```js
-     * ["bower.json", "manifest.json", "npm-shrinkwrap.json", "package-lock.json", "package.json"]
-     * ```
-     */
-    outFiles: z.ZodArray<z.ZodString, "many">;
     /**
      * The header to be used in the changelog.
      * @default
@@ -34,16 +26,44 @@ declare const ForkConfigSchema: z.ZodObject<{
      */
     header: z.ZodString;
     /**
-     * Specify a prefix for the git tag that will be taken into account during the comparison.
+     * Files to be updated.
+     * @default
+     * ```js
+     * ["bower.json", "manifest.json", "npm-shrinkwrap.json", "package-lock.json", "package.json"]
+     * ```
+     */
+    files: z.ZodArray<z.ZodString, "many">;
+    /**
+     * Specify a prefix for the git tag fork-version will create.
+     *
+     * For instance if your version tag is prefixed by "version/" instead of "v" you have to specify
+     * `tagPrefix: "version/"`.
+     *
+     * `tagPrefix` can also be used for a monorepo environment where you might want to deploy
+     * multiple package from the same repository. In this case you can specify a prefix for
+     * each package:
      *
-     * For instance if your version tag is prefixed by `version/` instead of `v` you would
-     * have to specify `tagPrefix: "version/"`.
-     * @default `v`
+     * | Value                    | Tag Created                   |
+     * |:-------------------------|:------------------------------|
+     * | ""                       | `1.2.3`                       |
+     * | "version/"               | `version/1.2.3`               |
+     * | "@eglavin/fork-version-" | `@eglavin/fork-version-1.2.3` |
+     *
+     * @example "", "version/", "@eglavin/fork-version-"
+     * @default "v"
      */
     tagPrefix: z.ZodString;
     /**
-     * Make a pre-release with optional label to specify a tag id.
-     * @example true, "alpha", "beta", "rc", etc.
+     * Make a pre-release with optional label, if value is a string it will be used as the
+     * pre-release tag.
+     *
+     * | Value     | Version         |
+     * |:----------|:----------------|
+     * | true      | "1.2.3-0"       |
+     * | "alpha"   | "1.2.3-alpha-0" |
+     * | "beta"    | "1.2.3-beta-0"  |
+     *
+     * @example true, "alpha", "beta", "rc"
      * @default undefined
      */
     preReleaseTag: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
@@ -52,17 +72,27 @@ declare const ForkConfigSchema: z.ZodObject<{
      * @default false
      */
     commitAll: z.ZodBoolean;
+    /**
+     * If set we'll log debug information.
+     * @default false
+     */
+    debug: z.ZodBoolean;
     /**
      * If true, no output will be written to disk or committed.
      * @default false
      */
     dryRun: z.ZodBoolean;
     /**
-     * If true and we cant find a version in an `outFiles`, we'll fallback and attempt
-     * to use the latest git tag for the current version.
+     * If true and we cant find a version in the list of `files`, we'll fallback
+     * and attempt to use the latest git tag to get the current version.
      * @default true
      */
     gitTagFallback: z.ZodBoolean;
+    /**
+     * If set, we'll gather information about the current version and exit.
+     * @default false
+     */
+    inspectVersion: z.ZodBoolean;
     /**
      * Should we sign the git commit using GPG?
      * @see {@link https://git-scm.com/docs/git-commit#Documentation/git-commit.txt--Sltkeyidgt GPG Sign Commits}
@@ -80,13 +110,14 @@ declare const ForkConfigSchema: z.ZodObject<{
      */
     verify: z.ZodBoolean;
     /**
-     * If set, we'll use this version number instead of trying to find it in an `outFiles`.
+     * If set, we'll use this version number instead of trying to find a version from the list of `files`.
      * @example "1.0.0"
      * @default undefined
      */
     currentVersion: z.ZodOptional<z.ZodString>;
     /**
-     * If set, we'll attempt to update the version number to this version.
+     * If set, we'll attempt to update the version number to this version, instead of incrementing
+     * using "conventional-commit".
      * @example "2.0.0"
      * @default undefined
      */
@@ -95,9 +126,6 @@ declare const ForkConfigSchema: z.ZodObject<{
      * Override the default conventional-changelog preset configuration.
      */
     changelogPresetConfig: z.ZodObject<{
-        /**
-         * An array of `type` objects representing the explicitly supported commit message types, and whether they should show up in generated `CHANGELOG`s.
-         */
         types: z.ZodOptional<z.ZodArray<z.ZodObject<{
             type: z.ZodString;
             section: z.ZodOptional<z.ZodString>;
@@ -111,29 +139,11 @@ declare const ForkConfigSchema: z.ZodObject<{
             section?: string | undefined;
             hidden?: boolean | undefined;
         }>, "many">>;
-        /**
-         * A URL representing a specific commit at a hash.
-         */
         commitUrlFormat: z.ZodOptional<z.ZodString>;
-        /**
-         * A URL representing the comparison between two git SHAs.
-         */
         compareUrlFormat: z.ZodOptional<z.ZodString>;
-        /**
-         * A URL representing the issue format (allowing a different URL format to be swapped in for Gitlab, Bitbucket, etc).
-         */
         issueUrlFormat: z.ZodOptional<z.ZodString>;
-        /**
-         * A URL representing the a user's profile URL on GitHub, Gitlab, etc. This URL is used for substituting @bcoe with https://github.com/bcoe in commit messages.
-         */
         userUrlFormat: z.ZodOptional<z.ZodString>;
-        /**
-         * A string to be used to format the auto-generated release commit message.
-         */
         releaseCommitMessageFormat: z.ZodOptional<z.ZodString>;
-        /**
-         * An array of prefixes used to detect references to issues
-         */
         issuePrefixes: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
     }, "strip", z.ZodTypeAny, {
         types?: {
@@ -160,34 +170,17 @@ declare const ForkConfigSchema: z.ZodObject<{
         releaseCommitMessageFormat?: string | undefined;
         issuePrefixes?: string[] | undefined;
     }>;
-    /**
-     * Log function, can be used to override the default `console.log` function
-     * to log to a file or another service.
-     * @default console.log
-     */
-    log: z.ZodFunction<z.ZodTuple<[z.ZodString], z.ZodUnknown>, z.ZodVoid>;
-    /**
-     * Error logger function, can be used to override the default `console.error`
-     * function to log to a file or another service.
-     * @default console.error
-     */
-    error: z.ZodFunction<z.ZodTuple<[z.ZodString], z.ZodUnknown>, z.ZodVoid>;
-    /**
-     * Debug logger function, by default this is a noop function, but can be replaced
-     * with a custom logger function or `console.info` to print output.
-     * @default  () => {}
-     */
-    debug: z.ZodFunction<z.ZodTuple<[z.ZodString], z.ZodUnknown>, z.ZodVoid>;
 }, "strip", z.ZodTypeAny, {
-    changePath: string;
+    path: string;
     changelog: string;
-    outFiles: string[];
-    error: (args_0: string, ...args_1: unknown[]) => void;
     header: string;
+    files: string[];
     tagPrefix: string;
     commitAll: boolean;
+    debug: boolean;
     dryRun: boolean;
     gitTagFallback: boolean;
+    inspectVersion: boolean;
     sign: boolean;
     silent: boolean;
     verify: boolean;
@@ -204,21 +197,20 @@ declare const ForkConfigSchema: z.ZodObject<{
         releaseCommitMessageFormat?: string | undefined;
         issuePrefixes?: string[] | undefined;
     };
-    log: (args_0: string, ...args_1: unknown[]) => void;
-    debug: (args_0: string, ...args_1: unknown[]) => void;
     preReleaseTag?: string | boolean | undefined;
     currentVersion?: string | undefined;
     nextVersion?: string | undefined;
 }, {
-    changePath: string;
+    path: string;
     changelog: string;
-    outFiles: string[];
-    error: (args_0: string, ...args_1: unknown[]) => void;
     header: string;
+    files: string[];
     tagPrefix: string;
     commitAll: boolean;
+    debug: boolean;
     dryRun: boolean;
     gitTagFallback: boolean;
+    inspectVersion: boolean;
     sign: boolean;
     silent: boolean;
     verify: boolean;
@@ -235,8 +227,6 @@ declare const ForkConfigSchema: z.ZodObject<{
         releaseCommitMessageFormat?: string | undefined;
         issuePrefixes?: string[] | undefined;
     };
-    log: (args_0: string, ...args_1: unknown[]) => void;
-    debug: (args_0: string, ...args_1: unknown[]) => void;
     preReleaseTag?: string | boolean | undefined;
     currentVersion?: string | undefined;
     nextVersion?: string | undefined;
@@ -244,52 +234,90 @@ declare const ForkConfigSchema: z.ZodObject<{
 type ForkConfig = z.infer<typeof ForkConfigSchema>;
 declare function defineConfig(config: Partial<ForkConfig>): Partial<ForkConfig>;
 
-type FileState = {
+declare function getUserConfig(): Promise<ForkConfig>;
+
+declare class Logger {
+    private config;
+    disableLogs: boolean;
+    constructor(config: Pick<ForkConfig, "silent" | "debug" | "inspectVersion">);
+    log(...messages: any[]): void;
+    warn(...messages: any[]): void;
+    error(...messages: any[]): void;
+    debug(...messages: any[]): void;
+}
+
+interface FileState {
     name: string;
     path: string;
-    type: "package-file" | ({} & string);
     version: string;
-    isPrivate: boolean;
-};
-type CurrentVersion = {
-    currentVersion: string;
+    [other: string]: unknown;
+}
+interface IFileManager {
+    read(fileName: string): FileState | undefined;
+    write(filePath: string, newVersion: string): void;
+}
+declare class FileManager implements IFileManager {
+    private config;
+    private logger;
+    private JSONPackage;
+    private PlainText;
+    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 path.
+     *
+     * @example
+     * ```ts
+     * fileManager.write("/path/to/package.json", "1.2.3");
+     * ```
+     */
+    write(filePath: string, newVersion: string): void;
+}
+
+interface CurrentVersion {
+    version: string;
     files: FileState[];
-};
-type NextVersion = {
-    nextVersion: string;
+}
+declare function getCurrentVersion(config: ForkConfig, logger: Logger, fileManager: IFileManager): Promise<CurrentVersion>;
+interface NextVersion {
+    version: string;
     level?: number;
     preMajor?: boolean;
     reason?: string;
     releaseType?: ReleaseType;
-};
-type BumpVersion = CurrentVersion & NextVersion;
-declare function bumpVersion(options: ForkConfig): Promise<BumpVersion>;
+}
+declare function getNextVersion(config: ForkConfig, logger: Logger, currentVersion: string): Promise<NextVersion>;
 
-type CreateChangelog = {
-    path: string;
-    exists: boolean;
-};
-type UpdateChangelog = {
-    changelog: CreateChangelog;
+interface UpdateChangelog {
+    changelogPath: string;
     oldContent: string;
     newContent: string;
-};
-declare function updateChangelog(options: ForkConfig, bumpResult: BumpVersion): Promise<UpdateChangelog>;
+}
+declare function updateChangelog(config: ForkConfig, logger: Logger, nextVersion: string): Promise<UpdateChangelog>;
 
-type CommitChanges = {
+interface CommitChanges {
     filesToCommit: string[];
     gitAddOutput?: string;
     gitCommitOutput?: string;
-};
-declare function commitChanges(options: ForkConfig, bumpResult: BumpVersion): Promise<CommitChanges>;
+}
+declare function commitChanges(config: ForkConfig, logger: Logger, files: FileState[], nextVersion: string): Promise<CommitChanges>;
 
-type TagChanges = {
+interface TagChanges {
     gitTagOutput: string;
-    currentBranchName: string;
-    hasPublicPackageFile: boolean;
-    pushMessage: string;
-    publishMessage: string;
-};
-declare function tagChanges(options: ForkConfig, bumpResult: BumpVersion): Promise<TagChanges>;
+}
+declare function tagChanges(config: ForkConfig, logger: Logger, nextVersion: string): Promise<TagChanges>;
 
-export { BumpVersion, ForkConfig, bumpVersion, commitChanges, defineConfig, tagChanges, updateChangelog };
+export { type CurrentVersion, FileManager, type FileState, type ForkConfig, ForkConfigSchema, type IFileManager, type NextVersion, commitChanges, defineConfig, getCurrentVersion, getNextVersion, getUserConfig, tagChanges, updateChangelog };