bumpp 8.0.0 → 8.1.0

package/dist/cli/index.mjs

@@ -5,7 +5,7 @@ import {
   isReleaseType,
   require_log_symbols,
   versionBump
-} from "../chunk-HM6FRF4P.mjs";
+} from "../chunk-DW6HTJ47.mjs";
 
 // src/cli/index.ts
 init_esm_shims();
@@ -13,8 +13,8 @@ var import_log_symbols = __toESM(require_log_symbols());
 
 // package.json
 var name = "bumpp";
-var version = "8.0.0";
-var description = "Automatically (or with prompts) bump your version number, commit changes, tag, and push to Git";
+var version = "8.1.0";
+var description = "Bump version, commit changes, tag, and push to Git";
 
 // src/cli/exit-code.ts
 init_esm_shims();

package/dist/index.d.ts

@@ -203,6 +203,105 @@ interface InterfaceOptions {
     [key: string]: unknown;
 }
 
+interface Interface {
+    input?: NodeJS.ReadableStream | NodeJS.ReadStream | false;
+    output?: NodeJS.WritableStream | NodeJS.WriteStream | false;
+    [key: string]: unknown;
+}
+/**
+ * A specific version release.
+ */
+interface VersionRelease {
+    type: 'version';
+    version: string;
+}
+/**
+ * Prompt the user for the release number.
+ */
+interface PromptRelease {
+    type: 'prompt';
+    preid: string;
+}
+/**
+ * A bump release, relative to the current version number.
+ */
+interface BumpRelease {
+    type: ReleaseType;
+    preid: string;
+}
+/**
+ * One of the possible Release types.
+ */
+declare type Release = VersionRelease | PromptRelease | BumpRelease;
+/**
+ * Normalized and sanitized options
+ */
+interface NormalizedOptions {
+    release: Release;
+    commit?: {
+        message: string;
+        noVerify: boolean;
+        all: boolean;
+    };
+    tag?: {
+        name: string;
+    };
+    push: boolean;
+    files: string[];
+    cwd: string;
+    interface: Interface;
+    ignoreScripts: boolean;
+    execute?: string;
+}
+
+interface OperationState {
+    release: ReleaseType | undefined;
+    oldVersionSource: string;
+    oldVersion: string;
+    newVersion: string;
+    commitMessage: string;
+    tagName: string;
+    updatedFiles: string[];
+    skippedFiles: string[];
+}
+interface UpdateOperationState extends Partial<OperationState> {
+    event?: ProgressEvent;
+    script?: NpmScript;
+}
+/**
+ * All of the inputs, outputs, and state of a single `versionBump()` call.
+ */
+declare class Operation {
+    /**
+     * The options for this operation.
+     */
+    options: NormalizedOptions;
+    /**
+     * The current state of the operation.
+     */
+    readonly state: Readonly<OperationState>;
+    /**
+     * The results of the operation.
+     */
+    get results(): VersionBumpResults;
+    /**
+     * The callback that's used to report the progress of the operation.
+     */
+    private readonly _progress?;
+    /**
+     * Private constructor.  Use the `Operation.start()` static method instead.
+     */
+    private constructor();
+    /**
+     * Starts a new `versionBump()` operation.
+     */
+    static start(input: VersionBumpOptions): Promise<Operation>;
+    /**
+     * Updates the operation state and results, and reports the updated progress to the user.
+     */
+    update({ event, script, ...newState }: UpdateOperationState): this;
+}
+
 /**
  * Prompts the user for a version number and updates package.json and package-lock.json.
  *
@@ -225,5 +324,9 @@ declare function versionBump(release: string): Promise<VersionBumpResults>;
  * Optionally also commits, tags, and pushes to git.
  */
 declare function versionBump(options: VersionBumpOptions): Promise<VersionBumpResults>;
+/**
+ * Bumps the version number in one or more files, prompting users if necessary.
+ */
+declare function versionBumpInfo(arg?: VersionBumpOptions | string): Promise<Operation>;
 
-export { InterfaceOptions, NpmScript, ProgressEvent, VersionBumpOptions, VersionBumpProgress, VersionBumpResults, versionBump as default, versionBump };
+export { InterfaceOptions, NpmScript, ProgressEvent, VersionBumpOptions, VersionBumpProgress, VersionBumpResults, versionBump as default, versionBump, versionBumpInfo };