feat(skip version scripts): add argument to skip if specified

feature to skip specified version scripts from running by default with a new argument

Author: sidtagirisa

src/cli/index.ts

@@ -43,7 +43,7 @@ export async function main(args: string[]): Promise<void> {
   }
 }
 
-function progress({ event, script, updatedFiles, skippedFiles, newVersion }: VersionBumpProgress): void {
+function progress({ event, script, updatedFiles, skippedFiles, newVersion, skippedScripts }: VersionBumpProgress): void {
   switch (event) {
     case ProgressEvent.FileUpdated:
       console.log(success, `Updated ${updatedFiles.pop()} to ${newVersion}`);
@@ -53,6 +53,10 @@ function progress({ event, script, updatedFiles, skippedFiles, newVersion }: Ver
       console.log(info, `${skippedFiles.pop()} did not need to be updated`);
       break;
 
+    case ProgressEvent.ScriptSkipped:
+      console.log(success, `Script skipped ${skippedScripts.pop()}`);
+      break;
+
     case ProgressEvent.GitCommit:
       console.log(success, "Git commit");
       break;

src/cli/parse-args.ts

@@ -31,6 +31,7 @@ export function parseArgs(argv: string[]): ParsedArgs {
         { name: "quiet", alias: "q", type: Boolean },
         { name: "version", alias: "v", type: Boolean },
         { name: "help", alias: "h", type: Boolean },
+        { name: "skip-version-scripts", type: String, multiple: true, defaultValue: []},
         { name: "files", type: String, multiple: true, defaultOption: true },
       ],
       { argv }
@@ -48,6 +49,7 @@ export function parseArgs(argv: string[]): ParsedArgs {
         all: args.all as boolean,
         noVerify: args["no-verify"] as boolean,
         files: args.files as string[],
+        skipVersionScripts: args["skip-version-scripts"] as string[],
       }
     };
 

src/normalize-options.ts

@@ -55,6 +55,7 @@ export interface NormalizedOptions {
   files: string[];
   cwd: string;
   interface: Interface;
+  skipVersionScripts: string[];
 }
 
 /**
@@ -131,7 +132,9 @@ export async function normalizeOptions(raw: VersionBumpOptions): Promise<Normali
     throw new Error("Cannot prompt for the version number because input or output has been disabled.");
   }
 
-  return { release, commit, tag, push, files, cwd, interface: ui };
+  let skipVersionScripts = raw.skipVersionScripts as string[];
+
+  return { release, commit, tag, push, files, cwd, interface: ui, skipVersionScripts };
 }
 
 /**

src/operation.ts

@@ -15,6 +15,7 @@ interface OperationState {
   tagName: string;
   updatedFiles: string[];
   skippedFiles: string[];
+  skippedScripts: string[];
 }
 
 interface UpdateOperationState extends Partial<OperationState> {
@@ -43,6 +44,7 @@ export class Operation {
     tagName: "",
     updatedFiles: [],
     skippedFiles: [],
+    skippedScripts: [],
   };
 
   /**
@@ -60,6 +62,7 @@ export class Operation {
       tag: options.tag ? state.tagName : false,
       updatedFiles: state.updatedFiles.slice(),
       skippedFiles: state.skippedFiles.slice(),
+      skippedScripts: state.skippedScripts.slice(),
     };
   }
 

src/run-npm-script.ts

@@ -13,8 +13,14 @@ export async function runNpmScript(script: NpmScript, operation: Operation): Pro
   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 });
+    if (shouldSkipScript(script, operation.options.skipVersionScripts)) {
+      operation.update({ event: ProgressEvent.ScriptSkipped, skippedScripts: operation.state.skippedScripts.concat(script) });
+    }
+    else {
+      await ezSpawn.async("npm", ["run", script, "--silent"], { stdio: "inherit" });
+      operation.update({ event: ProgressEvent.NpmScript, script });
+    }
+
   }
 
   return operation;
@@ -32,3 +38,10 @@ function hasScript(manifest: Manifest, script: NpmScript): boolean {
 
   return false;
 }
+
+/**
+ * Determines whether the specified script should be skipped.
+ */
+function shouldSkipScript(script: NpmScript, skipVersionScripts: string[]): boolean {
+  return skipVersionScripts.includes(script);
+}

src/types/version-bump-options.ts

@@ -92,6 +92,14 @@ export interface VersionBumpOptions {
    */
   interface?: boolean | InterfaceOptions;
 
+  /**
+   * The version scripts to be skipped
+   * Options can be any or all of the following separated with space:
+   * preversion, version and postversion
+   * Defaults to []
+   */
+  skipVersionScripts?: string[];
+
   /**
    * A callback that is provides information about the progress of the `versionBump()` function.
    */

src/types/version-bump-progress.ts

@@ -10,6 +10,7 @@ export const enum ProgressEvent {
   GitTag = "git tag",
   GitPush = "git push",
   NpmScript = "npm script",
+  ScriptSkipped = "script skipped",
 }
 
 /**

src/types/version-bump-results.ts

@@ -42,4 +42,9 @@ export interface VersionBumpResults {
    * The files that were not updated because they did not contain the old version number.
    */
   skippedFiles: string[];
+
+  /**
+   * The version scripts which were skipped because they were explicitly specified to be skipped.
+   */
+  skippedScripts: string[];
 }