Refactor CLI scripts for improved readability and structure. Consolidate git diff flags into a constant and enhance error handling. Update docstrings for clarity.

Author: MichaelCurrin

src/cli/diffIndexGenerate.ts

@@ -1,16 +1,11 @@
 #!/usr/bin/env node
 /**
- * AutoCommitMsg CLI scirpt.
- *
- * Mirrors the behavior of `shell/acm.sh` in TypeScript.
+ * AutoCommitMsg CLI script.
  */
 import { execFileSync } from "child_process";
 import { generateMsg } from "../prepareCommitMsg";
 import { shouldShowHelp } from "./utils";
 
-/**
- * CLI usage help text.
- */
 const HELP_TEXT: string = `Usage: acm [--cached] [--help|-h]
 
 Check Git changes and generate a commit message.
@@ -19,6 +14,14 @@ Options:
   --cached        Use only staged changes (equivalent to git --cached).
   --help, -h      Show this help and exit.`;
 
+const DIFF_FLAGS = [
+  "diff-index",
+  "--name-status",
+  "--find-renames",
+  "--find-copies",
+  "--no-color",
+];
+
 /**
  * Run `git diff-index` and return its stdout as a string.
  *
@@ -28,18 +31,11 @@ Options:
  * @returns output Diff output from git.
  */
 function runGitDiff(useCached: boolean): string {
-  const flags: string[] = [
-    "diff-index",
-    "--name-status",
-    "--find-renames",
-    "--find-copies",
-    "--no-color",
-  ];
+  const flags: string[] = [...DIFF_FLAGS];
 
   if (useCached) {
     flags.push("--cached");
   }
-
   flags.push("HEAD");
 
   const output: string = execFileSync("git", flags, {
@@ -84,7 +80,7 @@ function main(argv: string[]): void {
 
 if (require.main === module) {
   try {
-  main(process.argv.slice(2));
+    main(process.argv.slice(2));
   } catch (err) {
     const message: string = err instanceof Error ? err.message : String(err);
     console.error(`Error: ${message}`);

src/cli/diffIndexGenerateCommit.ts

@@ -1,16 +1,11 @@
 #!/usr/bin/env node
 /**
  * Git commit AutoCommitMsg script.
- *
- * Wrapper around acm.ts to generate a message and commit it in edit mode.
  */
 import { execFileSync } from "child_process";
 import { generateCommitMessage } from "./diffIndexGenerate";
 import { shouldShowHelp } from "./utils";
 
-/**
- * CLI usage help text.
- */
 const HELP_TEXT: string = `Usage: gacm [--cached] [--help|-h]
 
 Check Git changes, generate a commit message, and run Git commit.
@@ -41,7 +36,7 @@ function main(argv: string[]): void {
 
 if (require.main === module) {
   try {
-  main(process.argv.slice(2));
+    main(process.argv.slice(2));
   } catch (err) {
     const message: string = err instanceof Error ? err.message : String(err);
     console.error(`Error: ${message}`);

src/cli/generate.ts

@@ -3,6 +3,7 @@
  * CLI module to generate a commit message using given input.
  *
  * This script does not interact with VS Code or Git, it only processes text.
+ * This works as a Git hook. See shell/README.md for hook usage.
  *
  * It simply receives text as an argument and prints output to `stdout` for use
  * in a hook flow. Or to `stderr`, in the case of a message not appropriate for
@@ -55,7 +56,7 @@ function main(args: string[]): void {
 
 const args = process.argv.slice(2);
 try {
-main(args);
+  main(args);
 } catch (err) {
   const message: string = err instanceof Error ? err.message : String(err);
   console.error(message);