feat: add .ts files for .sh logic and remove unnecessary cli.ts

Author: MichaelCurrin

src/bin/diffIndexGenerate.ts

@@ -0,0 +1,87 @@
+#!/usr/bin/env node
+/**
+ * AutoCommitMsg CLI scirpt.
+ *
+ * Mirrors the behavior of `shell/acm.sh` in TypeScript.
+ */
+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.
+
+Options:
+  --cached        Use only staged changes (equivalent to git --cached).
+  --help, -h      Show this help and exit.`;
+
+/**
+ * Run `git diff-index` and return its stdout as a string.
+ *
+ * TODO: Use _diffIndex instead after refactoring for flags.
+ * @param useCached When true, include only staged changes using `--cached`.
+ *
+ * @returns output Diff output from git.
+ */
+function runGitDiff(useCached: boolean): string {
+    const flags: string[] = [
+        "diff-index",
+        "--name-status",
+        "--find-renames",
+        "--find-copies",
+        "--no-color",
+    ];
+
+    if (useCached) {
+        flags.push("--cached");
+    }
+
+    flags.push("HEAD");
+
+    const output: string = execFileSync("git", flags, {
+        encoding: "utf8",
+        stdio: ["ignore", "pipe", "pipe"],
+    });
+
+    return output.trim();
+}
+
+/**
+ * Generate a commit message from the current repository diff.
+ *
+ * @param useCached When true, include only staged changes using `--cached`.
+ * @returns Generated commit message text.
+ */
+export function generateCommitMessage(useCached: boolean): string {
+    const diffOutput: string = runGitDiff(useCached);
+    if (!diffOutput) {
+        throw new Error("No file changes found");
+    }
+
+    const lines: string[] = diffOutput.split("\n");
+    return generateMsg(lines);
+}
+
+/**
+ * Command-line entry-point.
+ *
+ * Accepts an optional `--cached` flag to use staged changes only.
+ * Prints the generated commit message to stdout.
+ */
+function main(argv: string[]): void {
+    if (shouldShowHelp(argv)) {
+        console.log(HELP_TEXT);
+        return;
+    }
+    const useCached: boolean = argv.includes("--cached");
+    const msg: string = generateCommitMessage(useCached);
+    console.log(msg);
+}
+
+if (require.main === module) {
+    main(process.argv.slice(2));
+}

src/bin/diffIndexGenerateCommit.ts

@@ -0,0 +1,42 @@
+#!/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.
+
+Options:
+  --cached        Use only staged changes (equivalent to git --cached).
+  --help, -h      Show this help and exit.`;
+
+/**
+ * Command-line entry-point.
+ */
+function main(argv: string[]): void {
+    if (shouldShowHelp(argv)) {
+        console.log(HELP_TEXT);
+        return;
+    }
+
+    const useCached: boolean = argv.includes("--cached");
+    const passthrough: string[] = argv.filter((arg: string) => arg !== "--cached");
+
+    const msg: string = generateCommitMessage(useCached);
+
+    const commitArgs: string[] = ["commit", "--edit", "-m", msg, ...passthrough];
+    execFileSync("git", commitArgs, { stdio: "inherit" });
+}
+
+if (require.main === module) {
+    main(process.argv.slice(2));
+}

src/bin/generate.ts

@@ -0,0 +1,56 @@
+#!/usr/bin/env node
+/**
+ * CLI module to generate a commit message using given input.
+ *
+ * This script does not interact with VS Code or Git, it only processes text.
+ *
+ * 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
+ * a commit message.
+ */
+import { generateMsg } from "../prepareCommitMsg";
+
+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'.
+
+Options:
+  --help, -h            Show this help and exit.`;
+
+
+/**
+ * Command-line entry-point.
+ *
+ * Returns a suitable generated commit message as text.
+ */
+import { shouldShowHelp } from "./utils";
+
+/**
+ * Entry-point for the CLI. Handles help flag and input validation.
+ */
+function main(args: string[]): void {
+  if (shouldShowHelp(args)) {
+    console.log(HELP_TEXT);
+    return;
+  }
+  const linesArg = args[0];
+
+  if (typeof linesArg === "undefined") {
+    throw new Error("Exactly one argument is required - text output from diff-index command.");
+  }
+
+  const lines = linesArg.split("\n");
+
+  if (!lines.length) {
+    throw new Error("No file changes found");
+  }
+
+  const msg = generateMsg(lines);
+  console.log(msg);
+}
+
+const args = process.argv.slice(2);
+main(args);

src/bin/utils.ts

@@ -0,0 +1,14 @@
+/**
+ * CLI utilities shared by bin commands.
+ */
+
+/**
+ * Determine whether help should be displayed.
+ *
+ * @param argv Command-line arguments passed to the CLI.
+ *
+ * @returns boolean True when `--help` or `-h` is present.
+ */
+export function shouldShowHelp(argv: string[]): boolean {
+    return argv.includes("--help") || argv.includes("-h");
+}