Added a progress callback option

Author: JamesMessinger

src/index.ts

@@ -5,6 +5,7 @@ import { versionBump } from "./version-bump";
 export { ReleaseType } from "./release-type";
 export * from "./version-bump-options";
 export * from "./version-bump-results";
+export * from "./version-bump-progress";
 
 // Export `versionBump` as a named export and the default export
 export { versionBump };

src/version-bump-options.ts

@@ -1,3 +1,4 @@
+import { VersionBumpProgress } from "./version-bump-progress";
 
 /**
  * Options for the `versionBump()` function.
@@ -90,6 +91,11 @@ export interface VersionBumpOptions {
    * Defaults to `true`.
    */
   interface?: boolean | InterfaceOptions;
+
+  /**
+   * A callback that is provides information about the progress of the `versionBump()` function.
+   */
+  progress?(progress: VersionBumpProgress): void;
 }
 
 /**

src/version-bump-progress.ts

@@ -0,0 +1,18 @@
+import { VersionBumpResults } from "./version-bump-results";
+
+/**
+ * Progress events that indicate the progress of the `versionBump()` function.
+ */
+export const enum ProgressEvent {
+  FileUpdated = "file updated",
+  GitCommit = "git commit",
+  GitTag = "git tag",
+  GitPush = "git push",
+}
+
+/**
+ * Information about the progress of the `versionBump()` function.
+ */
+export interface VersionBumpProgress extends VersionBumpResults {
+  event: ProgressEvent;
+}