fix(version): enable changing commit message when using amend (lerna#3954)

Author: amorscher

libs/commands/version/src/index.ts

@@ -117,6 +117,7 @@ class VersionCommand extends Command {
     signoffGitCommit?: boolean;
     signGitTag?: boolean;
     forceGitTag?: boolean;
+    overrideMessage?: boolean;
   };
   savePrefix?: string;
   currentBranch?: string;
@@ -175,12 +176,14 @@ class VersionCommand extends Command {
       forceGitTag,
       tagVersionPrefix = "v",
       premajorVersionBump = "default",
+      message,
     } = this.options;
 
     this.gitRemote = gitRemote;
     this.tagPrefix = tagVersionPrefix;
     this.commitAndTag = gitTagVersion;
     this.pushToRemote = gitTagVersion && amend !== true && push;
+    const overrideMessage: boolean = amend && !!message;
     this.premajorVersionBump = premajorVersionBump;
     // never automatically push to remote when amending a commit
 
@@ -204,6 +207,7 @@ class VersionCommand extends Command {
       signoffGitCommit,
       signGitTag,
       forceGitTag,
+      overrideMessage,
     };
 
     // https://docs.npmjs.com/misc/config#save-prefix

libs/commands/version/src/lib/git-commit.ts

@@ -7,14 +7,15 @@ const childProcess = require("@lerna/child-process");
 
 export interface GitCommitOptions {
   amend?: boolean;
+  overrideMessage?: boolean;
   commitHooks?: boolean;
   signGitCommit?: boolean;
   signoffGitCommit?: boolean;
 }
 
 export function gitCommit(
   message: string,
-  { amend, commitHooks, signGitCommit, signoffGitCommit }: GitCommitOptions,
+  { amend, commitHooks, signGitCommit, signoffGitCommit, overrideMessage }: GitCommitOptions,
   opts: ExecOptions
 ) {
   log.silly("gitCommit", message);
@@ -32,13 +33,20 @@ export function gitCommit(
     args.push("--signoff");
   }
 
+  const shouldChangeMessage = amend ? amend && overrideMessage : true;
   if (amend) {
-    args.push("--amend", "--no-edit");
-  } else if (message.indexOf(EOL) > -1) {
-    // Use tempfile to allow multi\nline strings.
-    args.push("-F", tempWrite.sync(message, "lerna-commit.txt"));
+    args.push("--amend");
+  }
+
+  if (shouldChangeMessage) {
+    if (message.indexOf(EOL) > -1) {
+      // Use tempfile to allow multi\nline strings.
+      args.push("-F", tempWrite.sync(message, "lerna-commit.txt"));
+    } else {
+      args.push("-m", message);
+    }
   } else {
-    args.push("-m", message);
+    args.push("--no-edit");
   }
 
   // TODO: refactor to address type issues

libs/commands/version/src/lib/version-command.spec.ts

@@ -636,12 +636,13 @@ Changes:
       expect(checkWorkingTree).not.toHaveBeenCalled();
     });
 
-    it("ignores custom messages", async () => {
+    it("considers custom messages", async () => {
       const testDir = await initFixture("normal", "preserved");
-      await lernaVersion(testDir)("-m", "ignored", "--amend");
+      await lernaVersion(testDir)("-m", "custom", "--amend");
 
       const message = await getCommitMessage(testDir);
-      expect(message).toBe("preserved");
+
+      expect(message).toBe("custom");
     });
   });