feat: update src

Author: MichaelCurrin

src/autofill.ts

@@ -13,7 +13,7 @@ Try saving your files or stage any new (untracked) files.\
 `;
 
 /**
- * Generate and fill a commit message in the Git extenside sidebar.
+ * Generate and fill a commit message in the Git extension sidebar.
  *
  * Steps:
  *

src/cli.ts

@@ -0,0 +1,91 @@
+#!/usr/bin/env node
+/**
+ * AutoCommitMsg CLI script.
+ */
+import { execFileSync } from "child_process";
+import { generateMsg } from "../prepareCommitMsg";
+import { shouldShowHelp } from "./utils";
+
+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:
+    look for staged changes and use them, otherwise use unstaged changes.
+  --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.
+ *
+ * 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_FLAGS];
+
+  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) {
+  try {
+    main(process.argv.slice(2));
+  } catch (err) {
+    const message: string = err instanceof Error ? err.message : String(err);
+    console.error(`Error: ${message}`);
+    process.exit(1);
+  }
+}

src/cli/diffIndexGenerate.ts

@@ -0,0 +1,47 @@
+#!/usr/bin/env node
+/**
+ * Git commit AutoCommitMsg script.
+ */
+import { execFileSync } from "child_process";
+import { generateCommitMessage } from "./diffIndexGenerate";
+import { shouldShowHelp } from "./utils";
+
+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:
+    look for staged changes and use them, otherwise use unstaged changes.
+  --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) {
+  try {
+    main(process.argv.slice(2));
+  } catch (err) {
+    const message: string = err instanceof Error ? err.message : String(err);
+    console.error(`Error: ${message}`);
+    process.exit(1);
+  }
+}

src/cli/diffIndexGenerateCommit.ts

@@ -0,0 +1,64 @@
+#!/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.
+ * 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
+ * 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);
+try {
+  main(args);
+} catch (err) {
+  const message: string = err instanceof Error ? err.message : String(err);
+  console.error(message);
+  process.exit(1);
+}

src/cli/generate.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");
+}

src/cli/utils.ts

@@ -17,7 +17,7 @@ const GIT_STATUS_SPLIT = " -> ";
  * Parse a line which was produced by the `git status --short` command.
  */
 export function parseStatus(line: string): FileChange {
-  if (line.length <= 4) {
+  if (line.length < 4) {
     throw new Error(
       `Input string must be at least 4 characters. Got: '${line}'`,
     );
@@ -54,7 +54,7 @@ export function parseStatus(line: string): FileChange {
  * than `undefined`).
  */
 export function parseDiffIndex(line: string): FileChange {
-  if (line.length <= 4) {
+  if (line.length < 4) {
     const errorMsg = `Invalid input. Input string must be at least 4 characters. Got: '${line}'`;
     console.error(errorMsg);
     throw new Error(errorMsg);

src/git/parseOutput.ts

@@ -4,7 +4,7 @@
 import * as assert from "assert";
 import { lookupDiffIndexAction, moveOrRenameMsg } from "../../generate/action";
 
-describe("Desribe a file using a single path", function () {
+describe("Describe a file using a single path", function () {
   describe("#lookupDiffIndexAction", function () {
     it("can describe an updated file", function () {
       assert.strictEqual(lookupDiffIndexAction("M"), "update");
@@ -32,7 +32,7 @@ describe("Desribe a file using a single path", function () {
   });
 });
 
-describe("Desribe a file using two paths", function () {
+describe("Describe a file using two paths", function () {
   describe("#moveOrRenameFile", function () {
     it("can describe a renamed file", function () {
       assert.strictEqual(
@@ -73,7 +73,7 @@ describe("Desribe a file using two paths", function () {
       );
     });
 
-    it("can describe a remamed and moved file", function () {
+    it("can describe a renamed and moved file", function () {
       assert.strictEqual(
         moveOrRenameMsg("foo.txt", "fizz/bar.txt"),
         "move and rename foo.txt to fizz/bar.txt",

src/test/generate/action.test.ts

@@ -3,11 +3,11 @@
  */
 import * as assert from "assert";
 import {
-  countFilesDesc,
   _countByAction,
   _formatAll,
   _formatOne,
   _moveOrRenameFromChange,
+  countFilesDesc,
 } from "../../generate/count";
 import { FileChange } from "../../git/parseOutput.d";
 
@@ -257,7 +257,7 @@ describe("Aggregate counts of files as numeric data", function () {
       });
     });
 
-    describe("give correct actionsand counts for files with different actions", function () {
+    describe("give correct actions and counts for files with different actions", function () {
       it("should handle one created and one updated file", function () {
         const changes: FileChange[] = [
           {
@@ -457,7 +457,7 @@ describe("Convert action and counts to a readable commit message", function () {
       });
     });
 
-    describe("multiples files", function () {
+    describe("multiple files", function () {
       it("should handle one created file and one updated file", function () {
         const actionCounts = {
           create: { fileCount: 1 },

src/test/generate/count.test.ts

@@ -119,7 +119,7 @@ describe("Path handling", function () {
       assert.strictEqual(result, "foo and bar");
     });
 
-    it('returns three items joined with commands and an an "and"', function () {
+    it('returns three items joined with commas and an "and"', function () {
       const result = _join(["foo", "bar", "bazz"]);
       assert.strictEqual(result, "foo, bar and bazz");
     });