git-stack-cli 2.9.9 → 2.11.0

package/package.json

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

package/src/command.ts

@@ -180,7 +180,7 @@ const DefaultOptions = {
 const FixupOptions = {
   commit: {
     type: "number",
-    default: 1,
+    default: 0,
     description: [
       "Relative number of commit to amend staged changes.",
       "Most recent is 1, next is 2, etc.",

package/src/commands/Fixup.tsx

@@ -3,11 +3,13 @@ import * as React from "react";
 import * as Ink from "ink-cjs";
 
 import { Await } from "~/app/Await";
+import { Command } from "~/app/Command";
 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";
+import { is_finite_value } from "~/core/is_finite_value";
 
 export function Fixup() {
   return (
@@ -25,27 +27,48 @@ async function run() {
 
   const relative_number = argv.commit;
 
-  if (!relative_number) {
+  if (!is_finite_value(relative_number)) {
     actions.output(
-      <Ink.Text color={colors.red}>❗️ Usage: git fixup {"<relative-commit-number>"}</Ink.Text>,
+      <Ink.Box flexDirection="column">
+        <Ink.Text color={colors.red}>❗️ Usage: git fixup {"<relative-commit-number>"}</Ink.Text>
+        <Ink.Text color={colors.gray}>
+          Automates the process of adding staged changes to a previous commit.
+        </Ink.Text>
+        <FormatText
+          wrapper={<Ink.Text color={colors.gray} />}
+          message="You can use {git_stack_log} to get the relative commit number."
+          values={{ git_stack_log: <Command>git stack log</Command> }}
+        />
+        <Ink.Box height={1} />
+        <FormatText
+          message="    {prompt} git stack log"
+          values={{ prompt: <Ink.Text color={colors.green}>❯</Ink.Text> }}
+        />
+        <FormatText
+          message="    0 * {sha}  18 hours ago    noah      homebrew-git-stack 2.9.9"
+          values={{ sha: <Ink.Text color={colors.green}>e329794</Ink.Text> }}
+        />
+        <FormatText
+          message="    1 * {sha}  18 hours ago    noah      2.9.9"
+          values={{ sha: <Ink.Text color={colors.green}>c7e4065</Ink.Text> }}
+        />
+        <FormatText
+          message="    2 * {sha}  18 hours ago    noah      command: --label + github add labels"
+          values={{ sha: <Ink.Text color={colors.green}>f82ac73</Ink.Text> }}
+        />
+        <Ink.Box height={1} />
+        <FormatText
+          wrapper={<Ink.Text color={colors.gray} />}
+          message="To target {sha} above, use {command}"
+          values={{
+            sha: <Ink.Text color={colors.green}>838e878</Ink.Text>,
+            command: <Command>git stack fixup 2</Command>,
+          }}
+        />
+      </Ink.Box>,
     );
+
     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);
   }
@@ -64,11 +87,8 @@ async function run() {
     // );
   }
 
-  // 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;
+  const commit_sha = (await cli(`git rev-parse HEAD~${relative_number}`)).stdout;
 
   actions.output(
     <FormatText
@@ -104,7 +124,7 @@ async function run() {
 
   try {
     // rebase target needs to account for new commit created above
-    const rebase_target = Number(relative_number) + 1;
+    const rebase_target = Number(relative_number) + 2;
 
     await cli(`git rebase -i --autosquash HEAD~${rebase_target}`, {
       env: {

package/src/commands/Log.tsx

@@ -65,7 +65,7 @@ async function run(args: Args) {
   const command = [
     `git log --pretty=format:"${format}" -n20 --graph --color ${rest_args}`,
     `cut -c 1-"${truncation_width}"`,
-    `nl -w3 -s' '`,
+    `nl -v0 -w3 -s' '`,
   ].join(" | ");
 
   const result = await cli(command);

package/src/commands/Rebase.tsx

@@ -6,6 +6,7 @@ import * as Ink from "ink-cjs";
 
 import { Await } from "~/app/Await";
 import { Brackets } from "~/app/Brackets";
+import { Command } from "~/app/Command";
 import { FormatText } from "~/app/FormatText";
 import { Status } from "~/app/Status";
 import { Store } from "~/app/Store";
@@ -41,8 +42,12 @@ Rebase.run = async function run(props: Props) {
   invariant(commit_range, "commit_range must exist");
   invariant(repo_root, "repo_root must exist");
 
+  const abort_controller = new AbortController();
+  const signal = abort_controller.signal;
+
   // immediately register abort_handler in case of ctrl+c exit
   actions.register_abort_handler(async function abort_rebase() {
+    abort_controller.abort();
     actions.output(<Ink.Text color={colors.red}>🚨 Abort</Ink.Text>);
     handle_exit();
     return 19;
@@ -59,7 +64,7 @@ Rebase.run = async function run(props: Props) {
     await cli(`pwd`);
 
     // fetch origin master branch for latest sha
-    await cli(`git fetch --no-tags -v origin ${master_branch_name}`);
+    await cli(`git fetch --no-tags -v origin ${master_branch_name}`, { signal });
 
     if (branch_name === master_branch_name) {
       await rebase_master();
@@ -69,12 +74,41 @@ Rebase.run = async function run(props: Props) {
 
     actions.unregister_abort_handler();
   } catch (err) {
+    actions.unregister_abort_handler();
     actions.error("Unable to rebase.");
 
     if (err instanceof Error) {
       actions.error(err.message);
     }
 
+    actions.output(
+      <Ink.Box flexDirection="column">
+        <Ink.Box height={1} />
+        <Ink.Text>⚠️ WARNING</Ink.Text>
+        <FormatText
+          message="You are in a temporary branch {branch_name} based on {original_branch}"
+          values={{
+            branch_name: <Brackets>{temp_branch_name}</Brackets>,
+            original_branch: <Brackets>{branch_name}</Brackets>,
+          }}
+        />
+        <FormatText
+          message="Fix merge conflicts then run {cp_continue} to proceed"
+          values={{
+            cp_continue: <Command>git cherry-pick --continue</Command>,
+          }}
+        />
+        <FormatText
+          message="To go back to the original branch run {checkout_original}"
+          values={{
+            checkout_original: (
+              <Command>git cherry-pick --abort && git checkout -f {branch_name}</Command>
+            ),
+          }}
+        />
+      </Ink.Box>,
+    );
+
     actions.exit(8);
   }
 
@@ -105,7 +139,7 @@ Rebase.run = async function run(props: Props) {
   }
 
   async function rebase_master() {
-    await cli(`git switch -C "${master_branch_name}" "${master_branch}"`);
+    await cli(`git switch -C "${master_branch_name}" "${master_branch}"`, { signal });
   }
 
   async function rebase_branch() {
@@ -115,7 +149,7 @@ Rebase.run = async function run(props: Props) {
     const rebase_merge_base = master_sha;
 
     // create temporary branch based on merge base
-    await cli(`git checkout -b ${temp_branch_name} ${rebase_merge_base}`);
+    await cli(`git checkout -b ${temp_branch_name} ${rebase_merge_base}`, { signal });
 
     const picked_commit_list = [];
 
@@ -157,17 +191,17 @@ Rebase.run = async function run(props: Props) {
 
     if (picked_commit_list.length > 0) {
       // ensure clean base to avoid conflicts when applying patch
-      await cli(`git clean -fd`);
+      await cli(`git clean -fd`, { signal });
 
       // create list of sha for cherry-pick
       const sha_list = picked_commit_list.map((commit) => commit.sha).join(" ");
 
-      await cli(`git cherry-pick --keep-redundant-commits ${sha_list}`);
+      await cli(`git cherry-pick --keep-redundant-commits ${sha_list}`, { signal });
     }
 
     // after all commits have been cherry-picked move the pointer
     // of original branch to the newly created temporary branch
-    await cli(`git branch -f ${branch_name} ${temp_branch_name}`);
+    await cli(`git branch -f ${branch_name} ${temp_branch_name}`, { signal });
 
     actions.debug("start restore_git()");
     restore_git();

package/src/core/cli.ts

@@ -38,7 +38,15 @@ export async function cli(
   }
 
   return new Promise((resolve, reject) => {
-    const childProcess = child.spawn("sh", ["-c", command], options);
+    let childProcess: child.ChildProcess;
+    try {
+      childProcess = child.spawn("sh", ["-c", command], options);
+    } catch (err) {
+      reject(err);
+      return;
+    }
+
+    let settled = false;
 
     let stdout = "";
     let stderr = "";
@@ -71,7 +79,11 @@ export async function cli(
     });
 
     childProcess.on("close", (unsafe_code) => {
-      const duration = timer.duration();
+      if (settled) {
+        return;
+      }
+
+      settled = true;
 
       const result = {
         command,
@@ -79,11 +91,12 @@ export async function cli(
         stdout: stdout.trimEnd(),
         stderr: stderr.trimEnd(),
         output: output.trimEnd(),
-        duration,
+        duration: timer.duration(),
       };
 
       state.actions.debug_pending_end(id);
       state.actions.debug(log.end(result));
+
       if (!options.quiet) {
         state.actions.debug(log.output(result));
       }
@@ -97,6 +110,24 @@ export async function cli(
     });
 
     childProcess.on("error", (err) => {
+      if (settled) {
+        return;
+      }
+
+      settled = true;
+
+      const result = {
+        command,
+        code: -1,
+        stdout: stdout.trimEnd(),
+        stderr: stderr.trimEnd(),
+        output: output.trimEnd(),
+        duration: timer.duration(),
+      };
+
+      state.actions.debug_pending_end(id);
+      state.actions.debug(log.abort({ result, err }));
+
       reject(err);
     });
   });
@@ -173,6 +204,12 @@ const log = {
     return `${command} (exit_code=${code} duration=${duration})`;
   },
 
+  abort({ result, err }: { result: Return; err?: unknown }) {
+    const { command, duration } = result;
+    const err_message = err instanceof Error ? err.message : String(err);
+    return `[error] ${command} err=${err_message} (duration=${duration})`;
+  },
+
   error(result: Return) {
     const lines = [result.output, this.non_zero_exit(result)];
     return lines.join("\n");