git-stack-cli 1.15.0 → 2.0.0-beta

package/src/app/TextInput.tsx

@@ -19,7 +19,7 @@ export function TextInput(props: Props) {
     function sync_value_prop() {
       set_value(get_value(props));
     },
-    [props.value]
+    [props.value],
   );
 
   const [caret_visible, set_caret_visible] = React.useState(false);
@@ -69,12 +69,7 @@ export function TextInput(props: Props) {
   // console.debug("[TextInput]", { value });
 
   return (
-    <Ink.Box
-      borderStyle="single"
-      minHeight={1}
-      borderColor={colors.yellow}
-      borderDimColor
-    >
+    <Ink.Box borderStyle="single" minHeight={1} borderColor={colors.yellow} borderDimColor>
       <Ink.Text>{value || ""}</Ink.Text>
 
       <Ink.Text color={colors.yellow} dimColor inverse={caret_visible}>

package/src/app/VerboseDebugInfo.tsx

@@ -12,11 +12,7 @@ type Props = {
 };
 
 export function VerboseDebugInfo(props: Props) {
-  const fallback = (
-    <Ink.Text color={colors.yellow}>
-      Logging verbose debug information…
-    </Ink.Text>
-  );
+  const fallback = <Ink.Text color={colors.yellow}>Logging verbose debug information…</Ink.Text>;
 
   return (
     <Await fallback={fallback} function={run}>

package/src/app/YesNoPrompt.tsx

@@ -2,56 +2,67 @@ import * as React from "react";
 
 import * as Ink from "ink-cjs";
 
+import { FormatText } from "~/app/FormatText";
 import { Parens } from "~/app/Parens";
 import { colors } from "~/core/colors";
 
+type Handler = () => void;
+
 type Props = {
   message: React.ReactNode;
-  onYes(): void;
-  onNo(): void;
+  onYes: Handler;
+  onNo: Handler;
 };
 
 export function YesNoPrompt(props: Props) {
   const [answer, set_answer] = React.useState("");
 
+  const answered_ref = React.useRef(false);
+
   Ink.useInput((input) => {
-    const inputLower = input.toLowerCase();
+    // prevent answering multiple times
+    if (answered_ref.current) {
+      return;
+    }
 
-    set_answer(inputLower);
+    const input_lower = input.toLowerCase();
 
-    switch (inputLower) {
+    let handler: undefined | Handler;
+
+    switch (input_lower) {
       case "n":
-        return props.onNo();
+        handler = props.onNo;
+        break;
 
       case "y":
-        return props.onYes();
+        handler = props.onYes;
+        break;
+    }
+
+    // handler if valid answer (y or n)
+    if (handler) {
+      answered_ref.current = true;
+      set_answer(input_lower);
+      handler();
     }
   });
 
-  // prettier-ignore
-  const y = <Ink.Text bold color={colors.green}>Y</Ink.Text>;
-  const n = <Ink.Text color={colors.red}>n</Ink.Text>;
-
-  let choices;
-
-  switch (answer) {
-    case "y":
-      choices = y;
-      break;
-
-    case "n":
-      choices = n;
-      break;
-
-    default:
-      choices = (
-        <React.Fragment>
-          {y}
-          <Ink.Text>/</Ink.Text>
-          {n}
-        </React.Fragment>
-      );
-  }
+  const choices = (function get_choices() {
+    // prettier-ignore
+    const y = <Ink.Text bold color={colors.green}>Y</Ink.Text>;
+    const n = <Ink.Text color={colors.red}>n</Ink.Text>;
+
+    switch (answer) {
+      case "y":
+        return y;
+
+      case "n":
+        return n;
+
+      default:
+        return <FormatText message="{y}/{n}" values={{ y, n }} />;
+    }
+  })();
 
   return (
     <Ink.Box flexDirection="column">

package/src/command.ts

@@ -11,26 +11,22 @@ export async function command() {
     yargs(hideBin(process.argv))
       .usage("Usage: git stack [command] [options]")
 
-      .command("$0", "Sync commit ranges to Github", (yargs) =>
-        yargs.options(DefaultOptions)
-      )
+      .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("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)
+        (yargs) => yargs.strict(false),
       )
 
       .command(
         "rebase",
         "Update local branch via rebase with latest changes from origin master branch",
-        (yargs) => yargs
+        (yargs) => yargs,
       )
 
       .option("verbose", GlobalOptions.verbose)
@@ -43,12 +39,8 @@ export async function command() {
       // disallow unknown options
       .strict()
       .version(process.env.CLI_VERSION || "unknown")
-      .showHidden(
-        "show-hidden",
-        "Show hidden options via `git stack help --show-hidden`"
-      )
-      .help("help", "Show usage via `git stack help`")
-      .argv as unknown as Promise<Argv>
+      .showHidden("show-hidden", "Show hidden options via `git stack help --show-hidden`")
+      .help("help", "Show usage via `git stack help`").argv as unknown as Promise<Argv>
   );
 }
 
@@ -86,8 +78,7 @@ const DefaultOptions = {
   "verify": {
     type: "boolean",
     default: true,
-    description:
-      "Run git hooks such as pre-commit and pre-push, disable with --no-verify",
+    description: "Run git hooks such as pre-commit and pre-push, disable with --no-verify",
   },
 
   "update": {

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}`);
@@ -99,7 +90,11 @@ async function run() {
 
     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 {
@@ -120,9 +115,7 @@ async function run() {
     if (save_stash) {
       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

@@ -54,9 +54,7 @@ Rebase.run = async function run() {
     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;
@@ -83,7 +81,7 @@ Rebase.run = async function run() {
                 commit_message: <Brackets>{commit.subject_line}</Brackets>,
                 pr_status: <Parens>MERGED</Parens>,
               }}
-            />
+            />,
           );
         }
 
@@ -98,7 +96,7 @@ Rebase.run = async function run() {
             values={{
               commit_message: <Brackets>{commit.subject_line}</Brackets>,
             }}
-          />
+          />,
         );
       }
 
@@ -131,7 +129,7 @@ Rebase.run = async function run() {
           branch_name: <Brackets>{branch_name}</Brackets>,
           origin_branch: <Brackets>{`origin/${master_branch}`}</Brackets>,
         }}
-      />
+      />,
     );
 
     actions.unregister_abort_handler();
@@ -182,7 +180,7 @@ Rebase.run = async function run() {
     actions.output(
       <Ink.Text color={colors.yellow}>
         Restoring <Brackets>{branch_name}</Brackets>…
-      </Ink.Text>
+      </Ink.Text>,
     );
 
     restore_git();
@@ -190,7 +188,7 @@ Rebase.run = async function run() {
     actions.output(
       <Ink.Text color={colors.yellow}>
         Restored <Brackets>{branch_name}</Brackets>.
-      </Ink.Text>
+      </Ink.Text>,
     );
   }
 };

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

@@ -87,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;
 
@@ -112,13 +109,12 @@ 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`;
+  const GIT_SEQUENCE_EDITOR_SCRIPT = process.env.GIT_SEQUENCE_EDITOR_SCRIPT;
+
+  invariant(GIT_SEQUENCE_EDITOR_SCRIPT, "GIT_SEQUENCE_EDITOR_SCRIPT must exist");
 
   // write script to temporary path
   await fs.writeFile(tmp_git_sequence_editor_path, GIT_SEQUENCE_EDITOR_SCRIPT);
@@ -137,10 +133,10 @@ GitReviseTodo.execute = async function grt_execute(args: ExecuteArgs) {
     `revise --edit -i ${args.rebase_merge_base}`,
   ];
 
-  // ignore here is important to prevent scrollback clear
-  // change to pipe to see output temporarily
+  // `ignore` hdies output which helps prevent scrollback clear
+  // `pipe` helps see failures when git revise fails
   // https://github.com/magus/git-stack-cli/commit/f9f10e3ac3cd9a35ee75d3e0851a48391967a23f
-  await cli(command, { stdio: ["ignore", "ignore", "ignore"] });
+  await cli(command, { stdio: ["pipe", "pipe", "pipe"] });
 
   // cleanup tmp_git_sequence_editor_path
   await safe_rm(tmp_git_sequence_editor_path);

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);