git-stack-cli 1.8.3 → 1.9.0

package/src/command.ts

@@ -1,103 +1,33 @@
 import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
 
-export type Argv = Awaited<ReturnType<typeof command>> & {
-  ["rebase"]: keyof typeof Rebase;
-};
+import type { Options, InferredOptionTypes, Arguments } from "yargs";
+
+export type Argv = Arguments & TGlobalOptions & TFixupOptions & TDefaultOptions;
 
 export async function command() {
   // https://yargs.js.org/docs/#api-reference-optionkey-opt
   return (
     yargs(hideBin(process.argv))
-      .usage("Usage: git stack [options]")
-
-      .option("force", {
-        type: "boolean",
-        alias: ["f"],
-        default: false,
-        description: "Force sync even if no changes are detected",
-      })
-
-      .option("check", {
-        type: "boolean",
-        alias: ["c"],
-        default: false,
-        description: "Print status table and exit without syncing",
-      })
-
-      .option("sync", {
-        type: "boolean",
-        alias: ["s"],
-        default: true,
-        description: "Sync commit ranges to Github, disable with --no-sync",
-      })
-
-      .option("verify", {
-        type: "boolean",
-        default: true,
-        description:
-          "Run git hooks such as pre-commit and pre-push, disable with --no-verify",
-      })
-
-      .option("rebase", {
-        type: "string",
-        choices: [Rebase["git-revise"], Rebase["cherry-pick"]],
-        default: Rebase["git-revise"],
-        description: [
-          "Strategy used for syncing branches",
-          `${Rebase["git-revise"]}: perform faster in-memory rebase`,
-          `${Rebase["cherry-pick"]}: use disk and incrementally rebase each commit`,
-        ].join(" | "),
-      })
-
-      .option("verbose", {
-        type: "boolean",
-        alias: ["v"],
-        default: false,
-        description: "Print more detailed logs for debugging internals",
-      })
-
-      .option("update", {
-        type: "boolean",
-        alias: ["u", "upgrade"],
-        default: false,
-        description: "Check and install the latest version",
-      })
-
-      .option("branch", {
-        type: "string",
-        alias: ["b"],
-        description:
-          'Set the master branch name, defaults to "master" (or "main" if "master" is not found)',
-      })
-
-      .option("draft", {
-        type: "boolean",
-        alias: ["d"],
-        default: false,
-        description: "Open all PRs as drafts",
-      })
-
-      .option("write-state-json", {
-        hidden: true,
-        type: "boolean",
-        default: false,
-        description: "Write state to local json file for debugging",
-      })
-
-      .option("template", {
-        type: "boolean",
-        default: true,
-        description:
-          "Use automatic Github PR template, e.g. .github/pull_request_template.md, disable with --no-template",
-      })
-
-      .option("mock-metadata", {
-        hidden: true,
-        type: "boolean",
-        default: false,
-        description: "Mock local store metadata for testing",
-      })
+      .usage("Usage: git stack [command] [options]")
+
+      .command("$0", "Sync commit ranges to Github", (yargs) =>
+        yargs.options(DefaultOptions)
+      )
+
+      .command(
+        "fixup [commit]",
+        "Amend staged changes to a specific commit in history",
+        (yargs) => yargs.positional("commit", FixupOptions.commit)
+      )
+
+      .command(
+        "log [args...]",
+        "Print an abbreviated log with numbered commits, useful for git stack fixup",
+        (yargs) => yargs.strict(false)
+      )
+
+      .option("verbose", GlobalOptions.verbose)
 
       // yargs default wraps to 80 columns
       // passing null will wrap to terminal width
@@ -111,7 +41,8 @@ export async function command() {
         "show-hidden",
         "Show hidden options via `git stack help --show-hidden`"
       )
-      .help("help", "Show usage via `git stack help`").argv
+      .help("help", "Show usage via `git stack help`")
+      .argv as unknown as Promise<Argv>
   );
 }
 
@@ -119,3 +50,112 @@ const Rebase = Object.freeze({
   "git-revise": "git-revise",
   "cherry-pick": "cherry-pick",
 });
+
+const GlobalOptions = {
+  verbose: {
+    type: "boolean",
+    alias: ["v"],
+    default: false,
+    description: "Print more detailed logs for debugging internals",
+  },
+} satisfies YargsOptions;
+
+const DefaultOptions = {
+  "force": {
+    type: "boolean",
+    alias: ["f"],
+    default: false,
+    description: "Force sync even if no changes are detected",
+  },
+
+  "check": {
+    type: "boolean",
+    alias: ["c"],
+    default: false,
+    description: "Print status table and exit without syncing",
+  },
+
+  "sync": {
+    type: "boolean",
+    alias: ["s"],
+    default: true,
+    description: "Sync commit ranges to Github, disable with --no-sync",
+  },
+
+  "verify": {
+    type: "boolean",
+    default: true,
+    description:
+      "Run git hooks such as pre-commit and pre-push, disable with --no-verify",
+  },
+
+  "rebase": {
+    type: "string",
+    choices: [Rebase["git-revise"], Rebase["cherry-pick"]],
+    default: Rebase["git-revise"],
+    description: [
+      "Strategy used for syncing branches",
+      `${Rebase["git-revise"]}: perform faster in-memory rebase`,
+      `${Rebase["cherry-pick"]}: use disk and incrementally rebase each commit`,
+    ].join(" | "),
+  },
+
+  "update": {
+    type: "boolean",
+    alias: ["u", "upgrade"],
+    default: false,
+    description: "Check and install the latest version",
+  },
+
+  "branch": {
+    type: "string",
+    alias: ["b"],
+    description:
+      'Set the master branch name, defaults to "master" (or "main" if "master" is not found)',
+  },
+
+  "draft": {
+    type: "boolean",
+    alias: ["d"],
+    default: false,
+    description: "Open all PRs as drafts",
+  },
+
+  "write-state-json": {
+    hidden: true,
+    type: "boolean",
+    default: false,
+    description: "Write state to local json file for debugging",
+  },
+
+  "template": {
+    type: "boolean",
+    default: true,
+    description:
+      "Use automatic Github PR template, e.g. .github/pull_request_template.md, disable with --no-template",
+  },
+
+  "mock-metadata": {
+    hidden: true,
+    type: "boolean",
+    default: false,
+    description: "Mock local store metadata for testing",
+  },
+} satisfies YargsOptions;
+
+const FixupOptions = {
+  commit: {
+    type: "number",
+    default: 1,
+    description: [
+      "Relative number of commit to amend staged changes.",
+      "Most recent is 1, next is 2, etc.",
+    ].join("\n"),
+  },
+} satisfies YargsOptions;
+
+type YargsOptions = { [key: string]: Options };
+
+type TGlobalOptions = InferredOptionTypes<typeof GlobalOptions>;
+type TFixupOptions = InferredOptionTypes<typeof FixupOptions>;
+type TDefaultOptions = InferredOptionTypes<typeof DefaultOptions>;

package/src/commands/Fixup.tsx

@@ -0,0 +1,121 @@
+import * as React from "react";
+
+import * as Ink from "ink-cjs";
+
+import { Await } from "~/app/Await";
+import { FormatText } from "~/app/FormatText";
+import { Parens } from "~/app/Parens";
+import { Store } from "~/app/Store";
+import { cli } from "~/core/cli";
+import { colors } from "~/core/colors";
+
+export function Fixup() {
+  return <Await fallback={null} function={run} />;
+}
+
+async function run() {
+  const state = Store.getState();
+  const actions = state.actions;
+  const argv = state.argv;
+
+  const relative_number = argv.commit;
+
+  if (!relative_number) {
+    actions.output(
+      <Ink.Text color={colors.red}>
+        ❗️ Usage: git fixup {"<relative-commit-number>"}
+      </Ink.Text>
+    );
+    actions.output("");
+    actions.output(
+      "This script automates the process of adding staged changes as a fixup commit"
+    );
+    actions.output(
+      "and the subsequent git rebase to flatten the commits based on relative commit number"
+    );
+    actions.output(
+      "You can use a `git log` like below to get the relative commit number"
+    );
+    actions.output("");
+    actions.output("    ❯ git stack log");
+    actions.output(
+      "    1\te329794d5f881cbf0fc3f26d2108cf6f3fdebabe enable drop_error_subtask test param"
+    );
+    actions.output(
+      "    2\t57f43b596e5c6b97bc47e2a591f82ccc81651156 test drop_error_subtask baseline"
+    );
+    actions.output(
+      "    3\t838e878d483c6a2d5393063fc59baf2407225c6d ErrorSubtask test baseline"
+    );
+    actions.output("");
+    actions.output("To target `838e87` above, you would call `fixup 3`");
+
+    actions.exit(0);
+  }
+
+  const diff_staged_cmd = await cli("git diff --cached --quiet", {
+    ignoreExitCode: true,
+  });
+
+  if (!diff_staged_cmd.code) {
+    actions.error("🚨 Stage changes before calling fixup");
+    actions.exit(1);
+    // actions.output(
+    //   <Ink.Text color={colors.red}>
+    //     ❗️ Usage: git fixup {"<relative-commit-number>"}
+    //   </Ink.Text>
+    // );
+  }
+
+  // Calculate commit SHA based on the relative commit number
+  const adjusted_number = Number(relative_number) - 1;
+
+  // get the commit SHA of the target commit
+  const commit_sha = (await cli(`git rev-parse HEAD~${adjusted_number}`))
+    .stdout;
+
+  await cli(`git commit --fixup ${commit_sha}`);
+
+  // check if stash required
+  let save_stash = false;
+
+  const diff_cmd = await cli("git diff-index --quiet HEAD --", {
+    ignoreExitCode: true,
+  });
+
+  if (diff_cmd.code) {
+    save_stash = true;
+
+    await cli("git stash -q");
+
+    actions.output(<Ink.Text>📦 Changes saved to stash</Ink.Text>);
+  }
+
+  // rebase target needs to account for new commit created above
+  const rebase_target = Number(relative_number) + 1;
+  await cli(`git rebase -i --autosquash HEAD~${rebase_target}`, {
+    env: {
+      PATH: process.env.PATH,
+      GIT_EDITOR: "true",
+    },
+  });
+
+  actions.output(
+    <FormatText
+      wrapper={<Ink.Text color={colors.yellow} />}
+      message="🛠️ fixup {relative_number} {commit_sha}"
+      values={{
+        commit_sha: <Parens>{commit_sha}</Parens>,
+        relative_number: relative_number,
+      }}
+    />
+  );
+
+  if (save_stash) {
+    await cli("git stash pop -q");
+
+    actions.output(
+      <Ink.Text color={colors.green}>✅ Changes restored from stash</Ink.Text>
+    );
+  }
+}

package/src/commands/Log.tsx

@@ -0,0 +1,72 @@
+import * as React from "react";
+
+import * as Ink from "ink-cjs";
+
+import { Await } from "~/app/Await";
+import { Store } from "~/app/Store";
+import { cli } from "~/core/cli";
+import { invariant } from "~/core/invariant";
+
+export function Log() {
+  const { stdout } = Ink.useStdout();
+  const available_width = stdout.columns || 80;
+
+  return <Await fallback={null} function={() => run({ available_width })} />;
+}
+
+type Args = {
+  available_width: number;
+};
+
+async function run(args: Args) {
+  const state = Store.getState();
+  const actions = state.actions;
+  const process_argv = state.process_argv;
+
+  invariant(actions, "actions must exist");
+
+  // estimate the number of color characters per line
+  // assuming an average of 5 color changes per line and 5 characters per color code
+  const color_buffer = 12 * 5;
+  const truncation_width = args.available_width + color_buffer;
+
+  // get the number of characters in the short sha for this repo
+  const short_sha = (await cli(`git log -1 --format=%h`)).stdout.trim();
+  const short_sha_length = short_sha.length + 1;
+
+  // SHA hash - At least 9 characters wide, truncated
+  const sha_format = `%C(green)%<(${short_sha_length},trunc)%h`;
+
+  // relative commit date - 15 characters wide, truncated
+  const date_format = `%C(white)%<(15,trunc)%cr`;
+
+  // author's abbreviated name - 12 characters wide, truncated
+  const author_format = `%C(white)%<(8,trunc)%al`;
+
+  // decorative information like branch heads or tags
+  const decoration_format = `%C(auto)%d`;
+
+  // commit subject - 80 characters wide, truncated
+  const subject_format = `%<(60,trunc)%s`;
+
+  // combine all the above formats into one
+  const format = [
+    sha_format,
+    date_format,
+    author_format,
+    decoration_format,
+    subject_format,
+  ].join(" ");
+
+  // view the SHA, description and history graph of last 20 commits
+  const rest_args = process_argv.slice(3).join(" ");
+  const command = [
+    `git log --pretty=format:"${format}" -n20 --graph --color ${rest_args}`,
+    `cut -c 1-"${truncation_width}"`,
+    `nl -w3 -s' '`,
+  ].join(" | ");
+
+  const result = await cli(command);
+
+  actions.output(result.stdout);
+}

package/src/core/CommitMetadata.ts

@@ -2,6 +2,7 @@ import { Store } from "~/app/Store";
 import * as Metadata from "~/core/Metadata";
 import { cli } from "~/core/cli";
 import * as github from "~/core/github";
+import { invariant } from "~/core/invariant";
 
 export type CommitMetadata = Awaited<ReturnType<typeof commit>>;
 export type CommitRange = Awaited<ReturnType<typeof range>>;
@@ -166,6 +167,10 @@ export async function range(commit_group_map?: CommitGroupMap) {
 
 async function get_commit_list() {
   const master_branch = Store.getState().master_branch;
+  const branch_name = Store.getState().branch_name;
+
+  invariant(branch_name, "branch_name must exist");
+
   const log_result = await cli(
     `git log ${master_branch}..HEAD --oneline --format=%H --color=never`
   );
@@ -178,12 +183,30 @@ async function get_commit_list() {
 
   const commit_metadata_list = [];
 
+  let has_metadata = false;
+
   for (let i = 0; i < sha_list.length; i++) {
     const sha = sha_list[i];
     const commit_metadata = await commit(sha);
+
+    if (commit_metadata.branch_id) {
+      has_metadata = true;
+    }
+
     commit_metadata_list.push(commit_metadata);
   }
 
+  if (!has_metadata) {
+    // check for pr with matching branch name to initialize group
+    const pr_result = await github.pr_status(branch_name);
+    if (pr_result) {
+      for (const commit_metadata of commit_metadata_list) {
+        commit_metadata.branch_id = branch_name;
+        commit_metadata.title = pr_result.title;
+      }
+    }
+  }
+
   return commit_metadata_list;
 }