fix: change to ignore scripts boolean instead of skip version scripts array.

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, skippedScripts }: VersionBumpProgress): void {
+function progress({ event, script, updatedFiles, skippedFiles, newVersion }: VersionBumpProgress): void {
   switch (event) {
     case ProgressEvent.FileUpdated:
       console.log(success, `Updated ${updatedFiles.pop()} to ${newVersion}`);
@@ -53,10 +53,6 @@ function progress({ event, script, updatedFiles, skippedFiles, newVersion, skipp
       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,7 +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: "ignore-scripts", type: Boolean },
         { name: "files", type: String, multiple: true, defaultOption: true },
       ],
       { argv }
@@ -49,7 +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[],
+        ignoreScripts: args["ignore-scripts"] as boolean,
       }
     };
 

src/normalize-options.ts

@@ -55,7 +55,7 @@ export interface NormalizedOptions {
   files: string[];
   cwd: string;
   interface: Interface;
-  skipVersionScripts: string[];
+  ignoreScripts: boolean;
 }
 
 /**
@@ -132,9 +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.");
   }
 
-  let skipVersionScripts = raw.skipVersionScripts as string[];
+  let ignoreScripts = raw.ignoreScripts as boolean;
 
-  return { release, commit, tag, push, files, cwd, interface: ui, skipVersionScripts };
+  return { release, commit, tag, push, files, cwd, interface: ui, ignoreScripts };
 }
 
 /**

src/operation.ts

@@ -15,7 +15,6 @@ interface OperationState {
   tagName: string;
   updatedFiles: string[];
   skippedFiles: string[];
-  skippedScripts: string[];
 }
 
 interface UpdateOperationState extends Partial<OperationState> {
@@ -44,7 +43,6 @@ export class Operation {
     tagName: "",
     updatedFiles: [],
     skippedFiles: [],
-    skippedScripts: [],
   };
 
   /**

src/run-npm-script.ts

@@ -13,14 +13,10 @@ export async function runNpmScript(script: NpmScript, operation: Operation): Pro
   let { data: manifest } = await readJsonFile("package.json", cwd);
 
   if (isManifest(manifest) && hasScript(manifest, script)) {
-    if (shouldSkipScript(script, operation.options.skipVersionScripts)) {
-      operation.update({ event: ProgressEvent.ScriptSkipped, skippedScripts: operation.state.skippedScripts.concat(script) });
-    }
-    else {
+    if (!operation.options.ignoreScripts) {
       await ezSpawn.async("npm", ["run", script, "--silent"], { stdio: "inherit" });
       operation.update({ event: ProgressEvent.NpmScript, script });
     }
-
   }
 
   return operation;
@@ -38,10 +34,3 @@ 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

@@ -93,12 +93,11 @@ 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 []
+   * Indicates whether to ignore version scripts.
+   *
+   * Defaults to `false`.
    */
-  skipVersionScripts?: string[];
+  ignoreScripts?: boolean;
 
   /**
    * A callback that is provides information about the progress of the `versionBump()` function.

src/types/version-bump-progress.ts

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

src/types/version-bump-results.ts

@@ -42,9 +42,4 @@ 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[];
 }

test/specs/api.spec.js

@@ -27,8 +27,7 @@ describe("versionBup() API", () => {
       commit: false,
       tag: false,
       updatedFiles: ["package.json"],
-      skippedFiles: [],
-      skippedScripts: []
+      skippedFiles: []
     });
 
     // The package.json file should have been updated
@@ -54,8 +53,7 @@ describe("versionBup() API", () => {
       commit: false,
       tag: false,
       updatedFiles: ["package.json"],
-      skippedFiles: [],
-      skippedScripts: []
+      skippedFiles: []
     });
 
     // The package.json file should have been updated
@@ -99,8 +97,7 @@ describe("versionBup() API", () => {
         "README.md",
         "subdir/deep/changelog.md"
       ],
-      skippedFiles: [],
-      skippedScripts: []
+      skippedFiles: []
     });
 
     // The CWD should not have changed