Added support for npm "preversion", "version", and "postversion" scripts

Author: JamesMessinger

src/cli/index.ts

@@ -44,7 +44,7 @@ export async function main(args: string[]): Promise<void> {
   }
 }
 
-function progress({ event, updatedFiles, skippedFiles, newVersion }: VersionBumpProgress): void {
+function progress({ event, script, updatedFiles, skippedFiles, newVersion }: VersionBumpProgress): void {
   // tslint:disable-next-line: switch-default
   switch (event) {
     case ProgressEvent.FileUpdated:
@@ -66,6 +66,10 @@ function progress({ event, updatedFiles, skippedFiles, newVersion }: VersionBump
     case ProgressEvent.GitPush:
       console.log(success, "Git push");
       break;
+
+    case ProgressEvent.NpmScript:
+      console.log(success, `Npm run ${script}`);
+      break;
   }
 }
 

src/operation.ts

@@ -1,7 +1,7 @@
 import { NormalizedOptions, normalizeOptions } from "./normalize-options";
 import { ReleaseType } from "./release-type";
 import { VersionBumpOptions } from "./types/version-bump-options";
-import { ProgressEvent, VersionBumpProgress } from "./types/version-bump-progress";
+import { NpmScript, ProgressEvent, VersionBumpProgress } from "./types/version-bump-progress";
 import { VersionBumpResults } from "./types/version-bump-results";
 
 type ProgressCallback = (progress: VersionBumpProgress) => void;
@@ -19,6 +19,7 @@ interface OperationState {
 
 interface UpdateOperationState extends Partial<OperationState> {
   event?: ProgressEvent;
+  script?: NpmScript;
 }
 
 /**
@@ -89,13 +90,13 @@ export class Operation {
   /**
    * Updates the operation state and results, and reports the updated progress to the user.
    */
-  public update({ event, ...newState }: UpdateOperationState): this {
+  public update({ event, script, ...newState }: UpdateOperationState): this {
     // Update the operation state
     Object.assign(this.state, newState);
 
     if (event && this._progress) {
       // Report the progress to the user
-      this._progress({ event, ...this.results });
+      this._progress({ event, script, ...this.results });
     }
 
     return this;

src/run-npm-script.ts

@@ -0,0 +1,34 @@
+import * as ezSpawn from "ez-spawn";
+import { readJsonFile } from "./fs";
+import { isManifest, Manifest } from "./manifest";
+import { Operation } from "./operation";
+import { NpmScript, ProgressEvent } from "./types/version-bump-progress";
+
+/**
+ * Runs the specified NPM script in the package.json file.
+ */
+export async function runNpmScript(script: NpmScript, operation: Operation): Promise<Operation> {
+  let { cwd } = operation.options;
+
+  let { data: manifest } = await readJsonFile("package.json", cwd);
+
+  if (isManifest(manifest) && hasScript(manifest, script)) {
+    await ezSpawn.async("npm", ["run", script, "--silent"], { stdio: "inherit" });
+    operation.update({ event: ProgressEvent.NpmScript, script });
+  }
+
+  return operation;
+}
+
+/**
+ * Determines whether the specified NPM script exists in the given manifest.
+ */
+function hasScript(manifest: Manifest, script: NpmScript): boolean {
+  let scripts = manifest.scripts as Record<NpmScript, string> | undefined;
+
+  if (scripts && typeof scripts === "object") {
+    return Boolean(scripts[script]);
+  }
+
+  return false;
+}

src/types/version-bump-progress.ts

@@ -9,11 +9,24 @@ export const enum ProgressEvent {
   GitCommit = "git commit",
   GitTag = "git tag",
   GitPush = "git push",
+  NpmScript = "npm script",
+}
+
+/**
+ * The NPM version scripts
+ *
+ * @see https://docs.npmjs.com/cli/version.html
+ */
+export const enum NpmScript {
+  PreVersion = "preversion",
+  Version = "version",
+  PostVersion = "postversion",
 }
 
 /**
  * Information about the progress of the `versionBump()` function.
  */
 export interface VersionBumpProgress extends VersionBumpResults {
   event: ProgressEvent;
+  script?: NpmScript;
 }

src/version-bump.ts

@@ -2,7 +2,9 @@ import { getNewVersion } from "./get-new-version";
 import { getOldVersion } from "./get-old-version";
 import { gitCommit, gitPush, gitTag } from "./git";
 import { Operation } from "./operation";
+import { runNpmScript } from "./run-npm-script";
 import { VersionBumpOptions } from "./types/version-bump-options";
+import { NpmScript } from "./types/version-bump-progress";
 import { VersionBumpResults } from "./types/version-bump-results";
 import { updateFiles } from "./update-files";
 
@@ -46,12 +48,23 @@ export async function versionBump(arg: VersionBumpOptions | string = {}): Promis
   await getOldVersion(operation);
   await getNewVersion(operation);
 
+  // Run npm preversion script, if any
+  await runNpmScript(NpmScript.PreVersion, operation);
+
   // Update the version number in all files
   await updateFiles(operation);
 
-  // Git commit, tag, push (if enabled)
+  // Run npm version script, if any
+  await runNpmScript(NpmScript.Version, operation);
+
+  // Git commit and tag, if enabled
   await gitCommit(operation);
   await gitTag(operation);
+
+  // Run npm postversion script, if any
+  await runNpmScript(NpmScript.PostVersion, operation);
+
+  // Push the git commit and tag, if enabled
   await gitPush(operation);
 
   return operation.results;