git-stack-cli 1.14.0 → 1.15.1

package/src/commands/Fixup.tsx

@@ -22,31 +22,23 @@ async function run() {
 
   if (!relative_number) {
     actions.output(
-      <Ink.Text color={colors.red}>
-        ❗️ Usage: git fixup {"<relative-commit-number>"}
-      </Ink.Text>
+      <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(
-      "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"
+      "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"
+      "    1\te329794d5f881cbf0fc3f26d2108cf6f3fdebabe enable drop_error_subtask test param",
     );
     actions.output(
-      "    2\t57f43b596e5c6b97bc47e2a591f82ccc81651156 test drop_error_subtask baseline"
-    );
-    actions.output(
-      "    3\t838e878d483c6a2d5393063fc59baf2407225c6d ErrorSubtask test baseline"
+      "    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`");
 
@@ -71,8 +63,7 @@ async function run() {
   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;
+  const commit_sha = (await cli(`git rev-parse HEAD~${adjusted_number}`)).stdout;
 
   actions.output(
     <FormatText
@@ -82,7 +73,7 @@ async function run() {
         commit_sha: <Parens>{commit_sha}</Parens>,
         relative_number: relative_number,
       }}
-    />
+    />,
   );
 
   await cli(`git commit --fixup ${commit_sha}`);
@@ -97,9 +88,13 @@ async function run() {
   if (diff_cmd.code) {
     save_stash = true;
 
-    await cli("git stash -q");
+    await cli("git stash --include-untracked");
 
-    actions.output(<Ink.Text>📦 Changes saved to stash</Ink.Text>);
+    actions.output(
+      <Ink.Text color={colors.yellow}>
+        <FormatText message="📦 Changes saved to stash" />
+      </Ink.Text>,
+    );
   }
 
   try {
@@ -118,11 +113,9 @@ async function run() {
     await cli("git reset --soft HEAD~1");
   } finally {
     if (save_stash) {
-      await cli("git stash pop -q");
+      await cli("git stash pop");
 
-      actions.output(
-        <Ink.Text color={colors.green}>✅ Changes restored from stash</Ink.Text>
-      );
+      actions.output(<Ink.Text color={colors.green}>✅ Changes restored from stash</Ink.Text>);
     }
   }
 }

package/src/commands/Log.tsx

@@ -50,13 +50,9 @@ async function run(args: Args) {
   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(" ");
+  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(" ");

package/src/commands/Rebase.tsx

@@ -16,35 +16,15 @@ import { invariant } from "~/core/invariant";
 import { short_id } from "~/core/short_id";
 
 export function Rebase() {
-  const abort_handler = React.useRef(() => {});
-
-  React.useEffect(function listen_sigint() {
-    process.once("SIGINT", sigint_handler);
-
-    return function cleanup() {
-      process.removeListener("SIGINT", sigint_handler);
-    };
-
-    function sigint_handler() {
-      abort_handler.current();
-    }
-  }, []);
-
   return (
     <Await
       fallback={<Ink.Text color={colors.yellow}>Rebasing commits…</Ink.Text>}
-      function={async function () {
-        await Rebase.run({ abort_handler });
-      }}
+      function={Rebase.run}
     />
   );
 }
 
-type Args = {
-  abort_handler: React.MutableRefObject<() => void>;
-};
-
-Rebase.run = async function run(args: Args) {
+Rebase.run = async function run() {
   const state = Store.getState();
   const actions = state.actions;
   const branch_name = state.branch_name;
@@ -57,11 +37,12 @@ Rebase.run = async function run(args: Args) {
   invariant(commit_range, "commit_range must exist");
   invariant(repo_root, "repo_root must exist");
 
-  // always listen for SIGINT event and restore git state
-  args.abort_handler.current = async function sigint_handler() {
+  // immediately register abort_handler in case of ctrl+c exit
+  actions.register_abort_handler(async function abort_rebase() {
     actions.output(<Ink.Text color={colors.red}>🚨 Abort</Ink.Text>);
-    handle_exit(19);
-  };
+    handle_exit();
+    return 19;
+  });
 
   const temp_branch_name = `${branch_name}_${short_id()}`;
 
@@ -73,9 +54,7 @@ Rebase.run = async function run(args: Args) {
     await cli(`pwd`);
 
     // update local master to match remote
-    await cli(
-      `git fetch --no-tags -v origin ${master_branch}:${master_branch}`
-    );
+    await cli(`git fetch --no-tags -v origin ${master_branch}:${master_branch}`);
 
     const master_sha = (await cli(`git rev-parse ${master_branch}`)).stdout;
     const rebase_merge_base = master_sha;
@@ -102,7 +81,7 @@ Rebase.run = async function run(args: Args) {
                 commit_message: <Brackets>{commit.subject_line}</Brackets>,
                 pr_status: <Parens>MERGED</Parens>,
               }}
-            />
+            />,
           );
         }
 
@@ -117,7 +96,7 @@ Rebase.run = async function run(args: Args) {
             values={{
               commit_message: <Brackets>{commit.subject_line}</Brackets>,
             }}
-          />
+          />,
         );
       }
 
@@ -150,9 +129,11 @@ Rebase.run = async function run(args: Args) {
           branch_name: <Brackets>{branch_name}</Brackets>,
           origin_branch: <Brackets>{`origin/${master_branch}`}</Brackets>,
         }}
-      />
+      />,
     );
 
+    actions.unregister_abort_handler();
+
     actions.set((state) => {
       state.commit_range = next_commit_range;
       state.step = "status";
@@ -166,7 +147,8 @@ Rebase.run = async function run(args: Args) {
       }
     }
 
-    handle_exit(20);
+    handle_exit();
+    actions.exit(20);
   }
 
   // cleanup git operations if cancelled during manual rebase
@@ -194,11 +176,11 @@ Rebase.run = async function run(args: Args) {
     cli.sync(`pwd`, spawn_options);
   }
 
-  function handle_exit(code: number) {
+  function handle_exit() {
     actions.output(
       <Ink.Text color={colors.yellow}>
         Restoring <Brackets>{branch_name}</Brackets>…
-      </Ink.Text>
+      </Ink.Text>,
     );
 
     restore_git();
@@ -206,9 +188,7 @@ Rebase.run = async function run(args: Args) {
     actions.output(
       <Ink.Text color={colors.yellow}>
         Restored <Brackets>{branch_name}</Brackets>.
-      </Ink.Text>
+      </Ink.Text>,
     );
-
-    actions.exit(code);
   }
 };

package/src/components/ErrorBoundary.tsx

@@ -0,0 +1,79 @@
+/* eslint-disable no-console */
+import * as React from "react";
+
+import * as Ink from "ink-cjs";
+
+import { FormatText } from "~/app/FormatText";
+import { Store } from "~/app/Store";
+import { colors } from "~/core/colors";
+
+type Props = {
+  children: React.ReactNode;
+};
+
+type State = {
+  error: null | Error;
+  component_stack: string;
+};
+
+export class ErrorBoundary extends React.Component<Props, State> {
+  constructor(props: Props) {
+    super(props);
+
+    this.state = {
+      error: null,
+      component_stack: "",
+    };
+  }
+
+  static getDerivedStateFromError(error: Error) {
+    return { error };
+  }
+
+  override componentDidCatch(_error: Error, error_info: React.ErrorInfo) {
+    let component_stack = error_info.componentStack;
+
+    if (component_stack) {
+      // remove first line of component_stack
+      component_stack = component_stack.split("\n").slice(1).join("\n");
+      this.setState({ component_stack });
+    }
+  }
+
+  override render() {
+    if (!this.state.error) {
+      return this.props.children;
+    }
+
+    const message = this.state.error.message;
+
+    return (
+      <Ink.Box flexDirection="column" gap={0}>
+        <Ink.Text color={colors.red}>
+          <FormatText
+            message="🚨 Unhandled error {message}"
+            values={{
+              message: <Ink.Text color={colors.gray}>{message}</Ink.Text>,
+            }}
+          />
+        </Ink.Text>
+
+        {this._render_verbose()}
+      </Ink.Box>
+    );
+  }
+
+  _render_verbose() {
+    const store_state = Store.getState();
+
+    if (store_state.argv.verbose) {
+      return <Ink.Text color={colors.gray}>{this.state.component_stack}</Ink.Text>;
+    }
+
+    return (
+      <Ink.Text color={colors.gray}>
+        <FormatText message="Try again with `--verbose` to see more information." />
+      </Ink.Text>
+    );
+  }
+}

package/src/components/ExitingGate.tsx

@@ -0,0 +1,27 @@
+import * as React from "react";
+
+import * as Ink from "ink-cjs";
+
+import { FormatText } from "~/app/FormatText";
+import { Store } from "~/app/Store";
+import { colors } from "~/core/colors";
+
+type Props = {
+  children: React.ReactNode;
+};
+
+export function ExitingGate(props: Props) {
+  const is_exiting = Store.useState((state) => state.is_exiting);
+
+  if (!is_exiting) {
+    return props.children;
+  }
+
+  return (
+    <Ink.Box flexDirection="column">
+      <Ink.Text color={colors.red}>
+        <FormatText message="🚨 Exiting…" />
+      </Ink.Text>
+    </Ink.Box>
+  );
+}

package/src/core/CommitMetadata.ts

@@ -167,7 +167,7 @@ export async function range(commit_group_map?: CommitGroupMap) {
 async function get_commit_list() {
   const master_branch = Store.getState().master_branch;
   const log_result = await cli(
-    `git log ${master_branch}..HEAD --oneline --format=%H --color=never`
+    `git log ${master_branch}..HEAD --oneline --format=%H --color=never`,
   );
 
   if (!log_result.stdout) {

package/src/core/GitReviseTodo.test.ts

@@ -35,7 +35,7 @@ test("git-revise-todo from commit range with single new commit", () => {
       "",
       "git-stack-id: E63ytp5dj",
       "git-stack-title: lemon color",
-    ].join("\n")
+    ].join("\n"),
   );
 });
 
@@ -53,7 +53,7 @@ test("git-revise-todo from commit range with single new commit in new group", ()
       "",
       "git-stack-id: 6Ak-qn+5Z",
       "git-stack-title: new group",
-    ].join("\n")
+    ].join("\n"),
   );
 });
 
@@ -71,7 +71,7 @@ test("git-revise-todo handles double quotes in commit message", () => {
       "",
       "git-stack-id: 6Ak-qn+5Z",
       'git-stack-title: [new] invalid \\"by me\\" quotes',
-    ].join("\n")
+    ].join("\n"),
   );
 });
 

package/src/core/GitReviseTodo.ts

@@ -5,6 +5,7 @@ import path from "node:path";
 import * as Metadata from "~/core/Metadata";
 import { cli } from "~/core/cli";
 import { invariant } from "~/core/invariant";
+import { safe_rm } from "~/core/safe_rm";
 
 import type * as CommitMetadata from "~/core/CommitMetadata";
 
@@ -86,10 +87,7 @@ GitReviseTodo.todo = function todo(args: CommitListArgs) {
 
     const metadata = { id, title };
 
-    const unsafe_message_with_id = Metadata.write(
-      commit.full_message,
-      metadata
-    );
+    const unsafe_message_with_id = Metadata.write(commit.full_message, metadata);
 
     let message_with_id = unsafe_message_with_id;
 
@@ -111,10 +109,7 @@ GitReviseTodo.todo = function todo(args: CommitListArgs) {
 
 GitReviseTodo.execute = async function grt_execute(args: ExecuteArgs) {
   // generate temporary directory and drop sequence editor script
-  const tmp_git_sequence_editor_path = path.join(
-    os.tmpdir(),
-    "git-sequence-editor.sh"
-  );
+  const tmp_git_sequence_editor_path = path.join(os.tmpdir(), "git-sequence-editor.sh");
 
   // replaced at build time with literal contents of `scripts/git-sequence-editor.sh`
   const GIT_SEQUENCE_EDITOR_SCRIPT = `process.env.GIT_SEQUENCE_EDITOR_SCRIPT`;
@@ -140,6 +135,9 @@ GitReviseTodo.execute = async function grt_execute(args: ExecuteArgs) {
   // change to pipe to see output temporarily
   // https://github.com/magus/git-stack-cli/commit/f9f10e3ac3cd9a35ee75d3e0851a48391967a23f
   await cli(command, { stdio: ["ignore", "ignore", "ignore"] });
+
+  // cleanup tmp_git_sequence_editor_path
+  await safe_rm(tmp_git_sequence_editor_path);
 };
 
 type ExecuteArgs = {

package/src/core/Metadata.test.ts

@@ -48,7 +48,7 @@ test("write handles bulleted lists", () => {
       "",
       "git-stack-id: abcd1234",
       "git-stack-title: banana",
-    ].join("\n")
+    ].join("\n"),
   );
 });
 
@@ -94,7 +94,7 @@ test("write handles bulleted lists", () => {
       "",
       "git-stack-id: fix-slash-branch",
       "git-stack-title: fix slash branch",
-    ].join("\n")
+    ].join("\n"),
   );
 });
 
@@ -133,7 +133,7 @@ test("write handles double quotes", () => {
       "",
       "git-stack-id: abc123",
       'git-stack-title: Revert \\"[abc / 123] subject (#1234)\\"',
-    ].join("\n")
+    ].join("\n"),
   );
 });
 
@@ -156,6 +156,6 @@ test("removes metadata", () => {
       "- keyboard modality escape key",
       "- centralize settings",
       "- move logic inside if branch",
-    ].join("\n")
+    ].join("\n"),
   );
 });

package/src/core/StackSummaryTable.ts

@@ -122,7 +122,7 @@ const TEMPLATE = {
 const RE = {
   // https://regex101.com/r/kqB9Ft/1
   stack_table_legacy: new RegExp(
-    TEMPLATE.stack_table_legacy("\\s+(?<rows>(?:- [^\r^\n]*(?:[\r\n]+)?)+)")
+    TEMPLATE.stack_table_legacy("\\s+(?<rows>(?:- [^\r^\n]*(?:[\r\n]+)?)+)"),
   ),
 
   stack_table_link: new RegExp(
@@ -131,7 +131,7 @@ const RE = {
       .replace("]", "\\]")
       .replace("(", "\\(")
       .replace(")", "\\)")
-      .replace("ROWS", "\\s+(?<rows>(?:- [^\r^\n]*(?:[\r\n]+)?)+)")
+      .replace("ROWS", "\\s+(?<rows>(?:- [^\r^\n]*(?:[\r\n]+)?)+)"),
   ),
 
   row: new RegExp(
@@ -139,7 +139,7 @@ const RE = {
       icon: "(?<icon>.+)",
       num: "(?<num>\\d+)",
       pr_url: "(?<pr_url>.+)",
-    })
+    }),
   ),
 
   pr_url: /^https:\/\/.*$/,

package/src/core/chalk.ts

@@ -19,11 +19,7 @@ function create_color_proxy(base: typeof chalk): ColorProxy {
 
         case "bracket":
           return (str: string) =>
-            [
-              target.bold.whiteBright("["),
-              str,
-              target.bold.whiteBright("]"),
-            ].join("");
+            [target.bold.whiteBright("["), str, target.bold.whiteBright("]")].join("");
 
         case "url":
           return target.bold.underline.blueBright;

package/src/core/cli.ts

@@ -22,7 +22,7 @@ let i = 0;
 
 export async function cli(
   unsafe_command: string | Array<string | number>,
-  unsafe_options?: Options
+  unsafe_options?: Options,
 ): Promise<Return> {
   const options = Object.assign({}, unsafe_options);
 
@@ -97,7 +97,7 @@ export async function cli(
 
 cli.sync = function cli_sync(
   unsafe_command: string | Array<string | number>,
-  unsafe_options?: Options
+  unsafe_options?: Options,
 ): Return {
   const options = Object.assign({}, unsafe_options);
 

package/src/core/github.tsx

@@ -24,7 +24,7 @@ export async function pr_list(): Promise<Array<PullRequest>> {
   invariant(repo_path, "repo_path must exist");
 
   const result_pr_list = await gh_json<Array<PullRequest>>(
-    `pr list --repo ${repo_path} --author ${username} --state open ${JSON_FIELDS}`
+    `pr list --repo ${repo_path} --author ${username} --state open ${JSON_FIELDS}`,
   );
 
   if (result_pr_list instanceof Error) {
@@ -42,7 +42,7 @@ export async function pr_list(): Promise<Array<PullRequest>> {
         <Brackets>{repo_path}</Brackets>
         <Ink.Text>{" authored by "}</Ink.Text>
         <Brackets>{username}</Brackets>
-      </Ink.Text>
+      </Ink.Text>,
     );
   }
 
@@ -77,7 +77,7 @@ export async function pr_status(branch: string): Promise<null | PullRequest> {
           </Ink.Text>
           <Ink.Text> </Ink.Text>
           <Ink.Text dimColor>{branch}</Ink.Text>
-        </Ink.Text>
+        </Ink.Text>,
       );
     }
 
@@ -94,13 +94,11 @@ export async function pr_status(branch: string): Promise<null | PullRequest> {
         </Ink.Text>
         <Ink.Text> </Ink.Text>
         <Ink.Text dimColor>{branch}</Ink.Text>
-      </Ink.Text>
+      </Ink.Text>,
     );
   }
 
-  const pr = await gh_json<PullRequest>(
-    `pr view ${branch} --repo ${repo_path} ${JSON_FIELDS}`
-  );
+  const pr = await gh_json<PullRequest>(`pr view ${branch} --repo ${repo_path} ${JSON_FIELDS}`);
 
   if (pr instanceof Error) {
     return null;
@@ -161,8 +159,10 @@ type EditPullRequestArgs = {
 export async function pr_edit(args: EditPullRequestArgs) {
   const command_parts = [`gh pr edit ${args.branch} --base ${args.base}`];
 
+  let body_file: string | undefined;
+
   if (args.body) {
-    const body_file = await write_body_file(args);
+    body_file = await write_body_file(args);
     command_parts.push(`--body-file="${body_file}"`);
   }
 
@@ -171,6 +171,11 @@ export async function pr_edit(args: EditPullRequestArgs) {
   if (cli_result.code !== 0) {
     handle_error(cli_result.output);
   }
+
+  // cleanup body_file
+  if (body_file) {
+    await safe_rm(body_file);
+  }
 }
 
 type DraftPullRequestArgs = {
@@ -183,9 +188,7 @@ export async function pr_draft(args: DraftPullRequestArgs) {
   // https://docs.github.com/en/graphql/reference/mutations#convertpullrequesttodraft
   // https://docs.github.com/en/graphql/reference/mutations#markpullrequestreadyforreview
 
-  const mutation_name = args.draft
-    ? "convertPullRequestToDraft"
-    : "markPullRequestReadyForReview";
+  const mutation_name = args.draft ? "convertPullRequestToDraft" : "markPullRequestReadyForReview";
 
   let query = `
     mutation($id: ID!) {
@@ -208,9 +211,7 @@ export async function pr_draft(args: DraftPullRequestArgs) {
   const cache_pr = state.pr[args.branch];
   invariant(cache_pr, "cache_pr must exist");
 
-  const command_parts = [
-    `gh api graphql -F id="${cache_pr.id}" -f query='${query}'`,
-  ];
+  const command_parts = [`gh api graphql -F id="${cache_pr.id}" -f query='${query}'`];
 
   const command = command_parts.join(" ");
 

package/src/core/pretty_json.ts

@@ -0,0 +1,7 @@
+export namespace pretty_json {
+  export type JSONValue = null | number | string | boolean | { [key: string]: JSONValue };
+}
+
+export function pretty_json<T extends pretty_json.JSONValue>(input: T): string {
+  return JSON.stringify(input, null, 2);
+}

package/src/github/gh.auth_status.test.ts

@@ -3,17 +3,13 @@ import { test, expect } from "bun:test";
 import * as gh from "./gh";
 
 test("logged in as", () => {
-  const username = gh.auth_status(
-    "  ✓ Logged in to github.com as magus (keyring)\n"
-  );
+  const username = gh.auth_status("  ✓ Logged in to github.com as magus (keyring)\n");
 
   expect(username).toBe("magus");
 });
 
 test("logged in without as", () => {
-  const username = gh.auth_status(
-    "✓ Logged in to github.com account xoxohorses (keyring)"
-  );
+  const username = gh.auth_status("✓ Logged in to github.com account xoxohorses (keyring)");
 
   expect(username).toBe("xoxohorses");
 });