git-stack-cli 1.13.2 → 1.15.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "git-stack-cli",
-  "version": "1.13.2",
+  "version": "1.15.0",
   "description": "",
   "author": "magus",
   "license": "MIT",

package/src/app/App.tsx

@@ -8,6 +8,7 @@ import { DetectInitialPR } from "~/app/DetectInitialPR";
 import { DirtyCheck } from "~/app/DirtyCheck";
 import { GatherMetadata } from "~/app/GatherMetadata";
 import { GithubApiError } from "~/app/GithubApiError";
+import { HandleCtrlCSigint } from "~/app/HandleCtrlCSigint";
 import { LocalCommitStatus } from "~/app/LocalCommitStatus";
 import { Main } from "~/app/Main";
 import { Output } from "~/app/Output";
@@ -65,6 +66,8 @@ export function App() {
           </DependencyCheck>
         </VerboseDebugInfo>
       </AutoUpdate>
+
+      <HandleCtrlCSigint />
     </Providers>
   );
 }

package/src/app/Debug.tsx

@@ -8,6 +8,7 @@ import * as Ink from "ink-cjs";
 import { Store } from "~/app/Store";
 import { colors } from "~/core/colors";
 import * as json from "~/core/json";
+import { pretty_json } from "~/core/pretty_json";
 import { safe_rm } from "~/core/safe_rm";
 
 export function Debug() {
@@ -41,7 +42,7 @@ export function Debug() {
         await safe_rm(output_file);
 
         const serialized = json.serialize(state);
-        const content = JSON.stringify(serialized, null, 2);
+        const content = pretty_json(serialized);
         await fs.writeFile(output_file, content);
       }
     },

package/src/app/DirtyCheck.tsx

@@ -15,7 +15,7 @@ type Props = {
 };
 
 type State = {
-  status: "init" | "prompt" | "done";
+  status: "init" | "prompt" | "stash" | "done";
 };
 
 function reducer(state: State, patch: Partial<State>) {
@@ -35,34 +35,42 @@ export function DirtyCheck(props: Props) {
 
     case "prompt":
       return (
-        <YesNoPrompt
-          message={
-            <Ink.Box flexDirection="column">
-              <FormatText
-                wrapper={<Ink.Text color={colors.yellow} />}
-                message="{git} repo has uncommitted changes."
-                values={{
-                  git: <Command>git</Command>,
-                  git_stack: <Command>git stack</Command>,
-                }}
-              />
+        <Ink.Box flexDirection="column">
+          <FormatText
+            wrapper={<Ink.Text color={colors.yellow} />}
+            message="⚠️ Uncommitted changes detected. {git_stack} needs a clean working tree."
+            values={{
+              git: <Command>git</Command>,
+              git_stack: <Command>git stack</Command>,
+            }}
+          />
+
+          <YesNoPrompt
+            message={
               <FormatText
                 wrapper={<Ink.Text color={colors.yellow} />}
-                message="Changes may be lost during {git_stack}, are you sure you want to proceed?"
+                message="{git_stash} changes to proceed?"
                 values={{
-                  git: <Command>git</Command>,
-                  git_stack: <Command>git stack</Command>,
+                  git_stash: <Command>git stash</Command>,
                 }}
               />
-            </Ink.Box>
-          }
-          onYes={async () => {
-            patch({ status: "done" });
-          }}
-          onNo={async () => {
-            actions.exit(0);
-          }}
-        />
+            }
+            onYes={async () => {
+              await cli("git stash --include-untracked");
+
+              actions.output(<Ink.Text>📦 Changes saved to stash</Ink.Text>);
+
+              actions.set((state) => {
+                state.is_dirty_check_stash = true;
+              });
+
+              patch({ status: "done" });
+            }}
+            onNo={async () => {
+              actions.exit(0);
+            }}
+          />
+        </Ink.Box>
       );
 
     default:
@@ -84,8 +92,11 @@ export function DirtyCheck(props: Props) {
     try {
       const git_dirty = (await cli(`git status --porcelain`)).stdout;
 
-      const status = git_dirty ? "prompt" : "done";
-      patch({ status });
+      if (!git_dirty) {
+        patch({ status: "done" });
+      } else {
+        patch({ status: "prompt" });
+      }
     } catch (err) {
       actions.error("Must be run from within a git repository.");
 

package/src/app/Exit.tsx

@@ -1,6 +1,11 @@
 import * as React from "react";
 
+import * as Ink from "ink-cjs";
+
 import { Store } from "~/app/Store";
+import { cli } from "~/core/cli";
+import { colors } from "~/core/colors";
+import { sleep } from "~/core/sleep";
 
 type Props = {
   clear: boolean;
@@ -8,17 +13,49 @@ type Props = {
 };
 
 export function Exit(props: Props) {
-  const actions = Store.useActions();
-
   React.useEffect(() => {
-    if (props.clear) {
-      actions.clear();
-    }
+    // immediately handle exit on mount
+    handle_exit().catch((err) => {
+      // eslint-disable-next-line no-console
+      console.error(err);
+    });
+
+    async function handle_exit() {
+      const state = Store.getState();
+      const actions = state.actions;
+
+      actions.debug(`[Exit] handle_exit ${JSON.stringify(props)}`);
+
+      let exit_code = props.code;
 
-    actions.unmount();
+      // run abort_handler if it exists
+      if (state.abort_handler) {
+        exit_code = await state.abort_handler();
+      }
 
-    process.exitCode = props.code;
-    process.exit();
+      // restore git stash if necessary
+      if (state.is_dirty_check_stash) {
+        await cli("git stash pop");
+        actions.output(
+          <Ink.Text color={colors.green}>
+            ✅ Changes restored from stash
+          </Ink.Text>
+        );
+      }
+
+      // ensure output has a chance to render
+      await sleep(1);
+
+      // finally handle the actual app and process exit
+      if (props.clear) {
+        actions.clear();
+      }
+
+      actions.unmount();
+
+      process.exitCode = exit_code;
+      process.exit();
+    }
   }, [props.clear, props.code]);
 
   return null;

package/src/app/HandleCtrlCSigint.tsx

@@ -0,0 +1,47 @@
+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";
+import { sleep } from "~/core/sleep";
+
+export function HandleCtrlCSigint() {
+  const actions = Store.useActions();
+
+  const [exiting, set_exiting] = React.useState(false);
+
+  Ink.useInput((input, key) => {
+    handle_input().catch((err) => {
+      // eslint-disable-next-line no-console
+      console.error(err);
+    });
+
+    async function handle_input() {
+      if (input === "c" && key.ctrl) {
+        actions.clear();
+
+        actions.output(
+          <Ink.Text color={colors.red}>
+            <FormatText message="🚨 Ctrl+C detected" />
+          </Ink.Text>
+        );
+
+        set_exiting(true);
+        await sleep(1);
+        actions.exit(235);
+      }
+    }
+  });
+
+  if (exiting) {
+    return (
+      <Ink.Text color={colors.red}>
+        <FormatText message="🚨 Exiting…" />
+      </Ink.Text>
+    );
+  }
+
+  return null;
+}

package/src/app/ManualRebase.tsx

@@ -15,35 +15,15 @@ import { invariant } from "~/core/invariant";
 import { short_id } from "~/core/short_id";
 
 export function ManualRebase() {
-  const abort_handler = React.useRef(() => {});
-
-  React.useEffect(function listen_sigint() {
-    process.once("SIGINT", sigint_handler);
-
-    return function cleanup() {
-      process.removeListener("SIGINT", sigint_handler);
-    };
-
-    async function sigint_handler() {
-      abort_handler.current();
-    }
-  }, []);
-
   return (
     <Await
       fallback={<Ink.Text color={colors.yellow}>Rebasing commits…</Ink.Text>}
-      function={async function () {
-        await run({ abort_handler });
-      }}
+      function={run}
     />
   );
 }
 
-type Args = {
-  abort_handler: React.MutableRefObject<() => void>;
-};
-
-async function run(args: Args) {
+async function run() {
   const state = Store.getState();
   const actions = state.actions;
   const argv = state.argv;
@@ -57,11 +37,12 @@ async function run(args: Args) {
   invariant(commit_map, "commit_map must exist");
   invariant(repo_root, "repo_root must exist");
 
-  // always listen for SIGINT event and restore git state
-  args.abort_handler.current = function sigint_handler() {
+  // immediately register abort_handler in case of ctrl+c exit
+  actions.register_abort_handler(async function abort_manual_rebase() {
     actions.output(<Ink.Text color={colors.red}>🚨 Abort</Ink.Text>);
-    handle_exit(15);
-  };
+    handle_exit();
+    return 15;
+  });
 
   const temp_branch_name = `${branch_name}_${short_id()}`;
 
@@ -137,6 +118,8 @@ async function run(args: Args) {
 
     restore_git();
 
+    actions.unregister_abort_handler();
+
     if (argv.sync) {
       actions.set((state) => {
         state.step = "sync-github";
@@ -157,7 +140,8 @@ async function run(args: Args) {
       actions.error("Try again with `--verbose` to see more information.");
     }
 
-    handle_exit(16);
+    handle_exit();
+    actions.exit(16);
   }
 
   // cleanup git operations if cancelled during manual rebase
@@ -185,7 +169,7 @@ 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>…
@@ -199,7 +183,5 @@ async function run(args: Args) {
         Restored <Brackets>{branch_name}</Brackets>.
       </Ink.Text>
     );
-
-    actions.exit(code);
   }
 }

package/src/app/SelectCommitRanges.tsx

@@ -387,8 +387,21 @@ function SelectCommitRangesInternal(props: Props) {
     </Ink.Box>
   );
 
+  function get_group_id() {
+    let branch_prefix = "";
+
+    // branch prefix via cli flag or env var
+    // cli flag takes precedence since it is more explicit
+    if (argv["branch-prefix"]) {
+      branch_prefix = argv["branch-prefix"];
+    } else if (process.env.GIT_STACK_BRANCH_PREFIX) {
+      branch_prefix = process.env.GIT_STACK_BRANCH_PREFIX;
+    }
+
+    return `${branch_prefix}${gs_short_id()}`;
+  }
   function submit_group_input(title: string) {
-    const id = gs_short_id();
+    const id = get_group_id();
 
     actions.output(
       <FormatText

package/src/app/Store.tsx

@@ -7,6 +7,7 @@ import { immer } from "zustand/middleware/immer";
 import { Exit } from "~/app/Exit";
 import { LogTimestamp } from "~/app/LogTimestamp";
 import { colors } from "~/core/colors";
+import { pretty_json } from "~/core/pretty_json";
 
 import type { Instance as InkInstance } from "ink-cjs";
 import type { Argv } from "~/command";
@@ -29,6 +30,9 @@ type SyncGithubState = {
   rebase_group_index: number;
 };
 
+// async function that returns exit code
+type AbortHandler = () => Promise<number>;
+
 export type State = {
   // set immediately in `index.tsx` so no `null` scenario
   process_argv: Array<string>;
@@ -47,6 +51,8 @@ export type State = {
   pr_templates: Array<string>;
   pr_template_body: null | string;
   sync_github: null | SyncGithubState;
+  is_dirty_check_stash: boolean;
+  abort_handler: null | AbortHandler;
 
   step:
     | "github-api-error"
@@ -71,7 +77,7 @@ export type State = {
     clear(): void;
     unmount(): void;
     newline(): void;
-    json(value: object): void;
+    json(value: pretty_json.JSONValue): void;
     error(message: string): void;
     output(node: React.ReactNode): void;
     debug(node: React.ReactNode, id?: string): void;
@@ -79,6 +85,8 @@ export type State = {
     isDebug(): boolean;
 
     reset_pr(): void;
+    register_abort_handler(abort_handler: AbortHandler): void;
+    unregister_abort_handler(): void;
 
     set(setter: Setter): void;
   };
@@ -113,6 +121,8 @@ const BaseStore = createStore<State>()(
     pr_templates: [],
     pr_template_body: null,
     sync_github: null,
+    is_dirty_check_stash: false,
+    abort_handler: null,
 
     step: "loading",
 
@@ -146,7 +156,7 @@ const BaseStore = createStore<State>()(
 
       json(value) {
         set((state) => {
-          const node = JSON.stringify(value, null, 2);
+          const node = pretty_json(value);
           state.mutate.output(state, { node });
         });
       },
@@ -189,6 +199,18 @@ const BaseStore = createStore<State>()(
         });
       },
 
+      register_abort_handler(abort_handler) {
+        set((state) => {
+          state.abort_handler = abort_handler;
+        });
+      },
+
+      unregister_abort_handler() {
+        set((state) => {
+          state.abort_handler = null;
+        });
+      },
+
       set(setter) {
         set((state) => {
           setter(state);

package/src/app/SyncGithub.tsx

@@ -14,35 +14,15 @@ import { invariant } from "~/core/invariant";
 import type * as CommitMetadata from "~/core/CommitMetadata";
 
 export function SyncGithub() {
-  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}>Syncing…</Ink.Text>}
-      function={async function () {
-        await run({ abort_handler });
-      }}
+      function={run}
     />
   );
 }
 
-type Args = {
-  abort_handler: React.MutableRefObject<() => void>;
-};
-
-async function run(args: Args) {
+async function run() {
   const state = Store.getState();
   const actions = state.actions;
   const argv = state.argv;
@@ -60,11 +40,12 @@ async function run(args: Args) {
   const commit_range = sync_github.commit_range;
   const rebase_group_index = sync_github.rebase_group_index;
 
-  // always listen for SIGINT event and restore pr state
-  args.abort_handler.current = function sigint_handler() {
+  // immediately register abort_handler in case of ctrl+c exit
+  actions.register_abort_handler(async function abort_sync_github() {
     actions.output(<Ink.Text color={colors.red}>🚨 Abort</Ink.Text>);
-    handle_exit(17);
-  };
+    handle_exit();
+    return 17;
+  });
 
   let DEFAULT_PR_BODY = "";
   if (state.pr_template_body) {
@@ -151,6 +132,8 @@ async function run(args: Args) {
 
     await Promise.all(update_pr_body_tasks);
 
+    actions.unregister_abort_handler();
+
     actions.set((state) => {
       state.step = "post-rebase-status";
     });
@@ -164,7 +147,8 @@ async function run(args: Args) {
       actions.error("Try again with `--verbose` to see more information.");
     }
 
-    await handle_exit(18);
+    handle_exit();
+    actions.exit(18);
   }
 
   function get_push_group_list() {
@@ -305,7 +289,7 @@ async function run(args: Args) {
     }
   }
 
-  function handle_exit(code: number) {
+  function handle_exit() {
     actions.output(
       <Ink.Text color={colors.yellow}>Restoring PR state…</Ink.Text>
     );
@@ -329,8 +313,6 @@ async function run(args: Args) {
     actions.output(
       <Ink.Text color={colors.yellow}>Restored PR state.</Ink.Text>
     );
-
-    actions.exit(code);
   }
 }
 

package/src/command.ts

@@ -111,11 +111,10 @@ const DefaultOptions = {
     description: "Open all PRs as drafts",
   },
 
-  "write-state-json": {
-    hidden: true,
-    type: "boolean",
-    default: false,
-    description: "Write state to local json file for debugging",
+  "branch-prefix": {
+    type: "string",
+    default: "",
+    description: "Prefix for generated branch names, e.g. dev/magus/",
   },
 
   "template": {
@@ -125,6 +124,13 @@ const DefaultOptions = {
       "Use automatic Github PR template, e.g. .github/pull_request_template.md, disable with --no-template",
   },
 
+  "write-state-json": {
+    hidden: true,
+    type: "boolean",
+    default: false,
+    description: "Write state to local json file for debugging",
+  },
+
   "mock-metadata": {
     hidden: true,
     type: "boolean",

package/src/commands/Fixup.tsx

@@ -97,7 +97,7 @@ 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>);
   }
@@ -118,7 +118,7 @@ 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>

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()}`;
 
@@ -153,6 +134,8 @@ Rebase.run = async function run(args: Args) {
       />
     );
 
+    actions.unregister_abort_handler();
+
     actions.set((state) => {
       state.commit_range = next_commit_range;
       state.step = "status";
@@ -166,7 +149,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,7 +178,7 @@ 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>…
@@ -208,7 +192,5 @@ Rebase.run = async function run(args: Args) {
         Restored <Brackets>{branch_name}</Brackets>.
       </Ink.Text>
     );
-
-    actions.exit(code);
   }
 };