update CLI scripts

Author: MichaelCurrin

src/cli/diffIndexGenerate.ts

@@ -11,8 +11,8 @@ const HELP_TEXT: string = `Usage: acm [--cached] [--help|-h]
 Check Git changes and generate a commit message.
 
 Options:
-  --cached        Use only staged changes (equivalent to git --cached).
-    If the flag is omitted, then the standard \`git status\` logic is followed:
+  --cached        Use only staged changes (equivalent to \`git --cached\`).
+                  If the flag is omitted, then the standard \`git commit\` logic is followed:
     look for staged changes and use them, otherwise use unstaged changes.
   --help, -h      Show this help and exit.`;
 

src/cli/diffIndexGenerateCommit.ts

@@ -11,8 +11,8 @@ const HELP_TEXT: string = `Usage: gacm [--cached] [--help|-h]
 Check Git changes, generate a commit message, and run Git commit.
 
 Options:
-  --cached        Use only staged changes (equivalent to git --cached).
-    If the flag is omitted, then the standard \`git status\` logic is followed:
+  --cached        Use only staged changes (equivalent to \`git --cached\`).
+                  If the flag is omitted, then the standard \`git commit\` logic is followed:
     look for staged changes and use them, otherwise use unstaged changes.
   --help, -h      Show this help and exit.`;
 
@@ -32,6 +32,7 @@ function main(argv: string[]): void {
 
   const msg: string = generateCommitMessage(useCached);
 
+  // FIXME: there is a bug when using changes that are not staged and without --cached flag, so the message is unquoted.
   const commitArgs: string[] = ["commit", "--edit", "-m", msg, ...passthrough];
   execFileSync("git", commitArgs, { stdio: "inherit" });
 }

src/cli/generate.ts

@@ -16,7 +16,7 @@ const HELP_TEXT: string = `Usage: auto_commit_msg_generate DIFF_INDEX_OUTPUT
 Generate a commit message from given input.
 
 Arguments:
-  DIFF_INDEX_OUTPUT   Text output from 'git diff-index --name-status HEAD'.
+  DIFF_INDEX_OUTPUT   Text output from command like 'git diff-index --name-status HEAD'.
 
 Options:
   --help, -h            Show this help and exit.`;