Separated the files property into updatedFiles and skippedFiles. Added a "file skipped" event.

Author: JamesMessinger

src/cli/index.ts

@@ -1,5 +1,5 @@
 // tslint:disable: no-console
-import { success } from "log-symbols";
+import { info, success } from "log-symbols";
 import { manifest } from "../manifest";
 import { ProgressEvent, VersionBumpProgress } from "../types/version-bump-progress";
 import { versionBump } from "../version-bump";
@@ -44,11 +44,15 @@ export async function main(args: string[]): Promise<void> {
   }
 }
 
-function progress({ event, files, newVersion }: VersionBumpProgress): void {
+function progress({ event, updatedFiles, skippedFiles, newVersion }: VersionBumpProgress): void {
   // tslint:disable-next-line: switch-default
   switch (event) {
     case ProgressEvent.FileUpdated:
-      console.log(success, `Updated ${files.pop()} to ${newVersion}`);
+      console.log(success, `Updated ${updatedFiles.pop()} to ${newVersion}`);
+      break;
+
+    case ProgressEvent.FileSkipped:
+      console.log(info, `${skippedFiles.pop()} did not need to be updated`);
       break;
 
     case ProgressEvent.GitCommit:

src/git.ts

@@ -11,7 +11,7 @@ export async function gitCommit(operation: Operation): Promise<Operation> {
   }
 
   let { all, noVerify, message } = operation.options.commit;
-  let { files, newVersion } = operation.state;
+  let { updatedFiles, newVersion } = operation.state;
   let args = [];
 
   if (all) {
@@ -30,7 +30,7 @@ export async function gitCommit(operation: Operation): Promise<Operation> {
 
   // Append the file names last, as variadic arguments
   if (!all) {
-    args = args.concat(files);
+    args = args.concat(updatedFiles);
   }
 
   await ezSpawn.async("git", ["commit", ...args]);

src/operation.ts

@@ -13,7 +13,8 @@ interface OperationState {
   newVersion: string;
   commitMessage: string;
   tagName: string;
-  files: string[];
+  updatedFiles: string[];
+  skippedFiles: string[];
 }
 
 interface UpdateOperationState extends Partial<OperationState> {
@@ -39,7 +40,8 @@ export class Operation {
     newVersion: "",
     commitMessage: "",
     tagName: "",
-    files: [],
+    updatedFiles: [],
+    skippedFiles: [],
   };
 
   /**
@@ -55,7 +57,8 @@ export class Operation {
       newVersion: state.newVersion,
       commit: options.commit ? state.commitMessage : false,
       tag: options.tag ? state.tagName : false,
-      files: state.files.slice(),
+      updatedFiles: state.updatedFiles.slice(),
+      skippedFiles: state.skippedFiles.slice(),
     };
   }
 
@@ -86,21 +89,13 @@ export class Operation {
   /**
    * Updates the operation state and results, and reports the updated progress to the user.
    */
-  public update(state: UpdateOperationState): this {
-    if (state.files) {
-      // Concatenate the two `files` arrays, rather than overwriting
-      state.files = this.state.files.concat(state.files);
-    }
-
+  public update({ event, ...newState }: UpdateOperationState): this {
     // Update the operation state
-    Object.assign(this.state, state);
+    Object.assign(this.state, newState);
 
-    if (state.event && this._progress) {
+    if (event && this._progress) {
       // Report the progress to the user
-      this._progress({
-        event: state.event,
-        ...this.results
-      });
+      this._progress({ event, ...this.results });
     }
 
     return this;

src/types/version-bump-progress.ts

@@ -5,6 +5,7 @@ import { VersionBumpResults } from "./version-bump-results";
  */
 export const enum ProgressEvent {
   FileUpdated = "file updated",
+  FileSkipped = "file skipped",
   GitCommit = "git commit",
   GitTag = "git tag",
   GitPush = "git push",

src/types/version-bump-results.ts

@@ -34,7 +34,12 @@ export interface VersionBumpResults {
   tag: string | false;
 
   /**
-   * The files that were updated.
+   * The files that were actually modified.
    */
-  files: string[];
+  updatedFiles: string[];
+
+  /**
+   * The files that were not updated because they did not contain the old version number.
+   */
+  skippedFiles: string[];
 }

src/update-files.ts

@@ -16,7 +16,13 @@ export async function updateFiles(operation: Operation): Promise<Operation> {
     if (modified) {
       operation.update({
         event: ProgressEvent.FileUpdated,
-        files: [relPath],
+        updatedFiles: operation.state.updatedFiles.concat(relPath),
+      });
+    }
+    else {
+      operation.update({
+        event: ProgressEvent.FileSkipped,
+        skippedFiles: operation.state.skippedFiles.concat(relPath),
       });
     }
   }

test/specs/api.spec.js

@@ -26,7 +26,8 @@ describe("versionBup() API", () => {
       newVersion: "2.34.567",
       commit: false,
       tag: false,
-      files: ["package.json"],
+      updatedFiles: ["package.json"],
+      skippedFiles: [],
     });
 
     // The package.json file should have been updated
@@ -51,7 +52,8 @@ describe("versionBup() API", () => {
       newVersion: "1.1.0",
       commit: false,
       tag: false,
-      files: ["package.json"],
+      updatedFiles: ["package.json"],
+      skippedFiles: [],
     });
 
     // The package.json file should have been updated
@@ -81,7 +83,7 @@ describe("versionBup() API", () => {
       files: [
         "random-file.json",
         "**/*.md",
-      ]
+      ],
     });
 
     expect(results).to.deep.equal({
@@ -90,11 +92,12 @@ describe("versionBup() API", () => {
       newVersion: "1.1.0-test.1",
       commit: "A test of the upcoming v1.1.0-test.1",
       tag: "1.1.0-test.1",
-      files: [
+      updatedFiles: [
         "random-file.json",
         "README.md",
         "subdir/deep/changelog.md"
       ],
+      skippedFiles: [],
     });
 
     // The CWD should not have changed