git-stack-cli 1.9.0 → 1.11.0

package/src/command.ts

@@ -27,6 +27,12 @@ export async function command() {
         (yargs) => yargs.strict(false)
       )
 
+      .command(
+        "rebase",
+        "Update local branch via rebase with latest changes from origin master branch",
+        (yargs) => yargs
+      )
+
       .option("verbose", GlobalOptions.verbose)
 
       // yargs default wraps to 80 columns

package/src/commands/Rebase.tsx

@@ -0,0 +1,204 @@
+import * as React from "react";
+
+import fs from "node:fs";
+
+import * as Ink from "ink-cjs";
+
+import { Await } from "~/app/Await";
+import { Brackets } from "~/app/Brackets";
+import { FormatText } from "~/app/FormatText";
+import { Parens } from "~/app/Parens";
+import { Store } from "~/app/Store";
+import * as CommitMetadata from "~/core/CommitMetadata";
+import { cli } from "~/core/cli";
+import { colors } from "~/core/colors";
+import { invariant } from "~/core/invariant";
+import { short_id } from "~/core/short_id";
+
+export function Rebase() {
+  return (
+    <Await
+      function={Rebase.run}
+      fallback={<Ink.Text color={colors.yellow}>Rebasing commits…</Ink.Text>}
+    />
+  );
+}
+
+Rebase.run = async function run() {
+  const state = Store.getState();
+  const actions = state.actions;
+  const branch_name = state.branch_name;
+  const commit_range = state.commit_range;
+  const master_branch = state.master_branch;
+  const cwd = state.cwd;
+  const repo_root = state.repo_root;
+
+  invariant(branch_name, "branch_name must exist");
+  invariant(commit_range, "commit_range must exist");
+  invariant(repo_root, "repo_root must exist");
+
+  // always listen for SIGINT event and restore git state
+  process.once("SIGINT", handle_exit);
+
+  const temp_branch_name = `${branch_name}_${short_id()}`;
+
+  try {
+    // actions.debug(`commit_range=${JSON.stringify(commit_range, null, 2)}`);
+
+    // must perform rebase from repo root for applying git patch
+    process.chdir(repo_root);
+    await cli(`pwd`);
+
+    // update local master to match remote
+    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;
+
+    // create temporary branch based on merge base
+    await cli(`git checkout -b ${temp_branch_name} ${rebase_merge_base}`);
+
+    const picked_commit_list = [];
+
+    for (let i = 0; i < commit_range.commit_list.length; i++) {
+      const commit = commit_range.commit_list[i];
+      const commit_pr = commit_range.pr_lookup[commit.branch_id || ""];
+
+      // drop commits that are in groups of merged PRs
+      const merged_pr = commit_pr?.state === "MERGED";
+
+      if (merged_pr) {
+        if (actions.isDebug()) {
+          actions.output(
+            <FormatText
+              wrapper={<Ink.Text color={colors.yellow} wrap="truncate-end" />}
+              message="Dropping {commit_message} {pr_status}"
+              values={{
+                commit_message: <Brackets>{commit.subject_line}</Brackets>,
+                pr_status: <Parens>MERGED</Parens>,
+              }}
+            />
+          );
+        }
+
+        continue;
+      }
+
+      if (actions.isDebug()) {
+        actions.output(
+          <FormatText
+            wrapper={<Ink.Text color={colors.yellow} wrap="truncate-end" />}
+            message="Picking {commit_message}"
+            values={{
+              commit_message: <Brackets>{commit.subject_line}</Brackets>,
+            }}
+          />
+        );
+      }
+
+      picked_commit_list.push(commit);
+    }
+
+    if (picked_commit_list.length > 0) {
+      // ensure clean base to avoid conflicts when applying patch
+      await cli(`git clean -fd`);
+
+      // 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}`);
+    }
+
+    // after all commits have been cherry-picked and amended
+    // move the branch pointer to the newly created temporary branch
+    // now we are locally in sync with github and on the original branch
+    await cli(`git branch -f ${branch_name} ${temp_branch_name}`);
+
+    restore_git();
+
+    const next_commit_range = await CommitMetadata.range();
+
+    actions.output(
+      <FormatText
+        wrapper={<Ink.Text color={colors.green} />}
+        message="✅ {branch_name} in sync with {origin_branch}"
+        values={{
+          branch_name: <Brackets>{branch_name}</Brackets>,
+          origin_branch: <Brackets>{`origin/${master_branch}`}</Brackets>,
+        }}
+      />
+    );
+
+    actions.set((state) => {
+      state.commit_range = next_commit_range;
+      state.step = "status";
+    });
+  } catch (err) {
+    actions.error("Unable to rebase.");
+
+    if (err instanceof Error) {
+      if (actions.isDebug()) {
+        actions.error(err.message);
+      }
+    }
+
+    handle_exit();
+  }
+
+  // cleanup git operations if cancelled during manual rebase
+  function restore_git() {
+    // signint handler MUST run synchronously
+    // trying to use `await cli(...)` here will silently fail since
+    // all children processes receive the SIGINT signal
+    const spawn_options = { ignoreExitCode: true };
+
+    // always clean up any patch files
+    cli.sync(`rm ${PATCH_FILE}`, spawn_options);
+
+    // always hard reset and clean to allow subsequent checkout
+    // if there are files checkout will fail and cascade fail subsequent commands
+    cli.sync(`git reset --hard`, spawn_options);
+    cli.sync(`git clean -df`, spawn_options);
+
+    // always put self back in original branch
+    cli.sync(`git checkout ${branch_name}`, spawn_options);
+
+    // ...and cleanup temporary branch
+    cli.sync(`git branch -D ${temp_branch_name}`, spawn_options);
+
+    if (commit_range) {
+      // ...and cleanup pr group branches
+      for (const group of commit_range.group_list) {
+        cli.sync(`git branch -D ${group.id}`, spawn_options);
+      }
+    }
+
+    // restore back to original dir
+    if (fs.existsSync(cwd)) {
+      process.chdir(cwd);
+    }
+    cli.sync(`pwd`, spawn_options);
+  }
+
+  function handle_exit() {
+    actions.output(
+      <Ink.Text color={colors.yellow}>
+        Restoring <Brackets>{branch_name}</Brackets>…
+      </Ink.Text>
+    );
+
+    restore_git();
+
+    actions.output(
+      <Ink.Text color={colors.yellow}>
+        Restored <Brackets>{branch_name}</Brackets>.
+      </Ink.Text>
+    );
+
+    actions.exit(6);
+  }
+};
+
+const PATCH_FILE = "git-stack-cli-patch.patch";

package/src/core/CommitMetadata.ts

@@ -2,7 +2,6 @@ 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>>;
@@ -18,7 +17,7 @@ type CommitGroup = {
   commits: Array<CommitMetadata>;
 };
 
-type SimpleGroup = { id: string; title: string };
+export type SimpleGroup = { id: string; title: string };
 type CommitGroupMap = { [sha: string]: SimpleGroup };
 
 export async function range(commit_group_map?: CommitGroupMap) {
@@ -167,10 +166,6 @@ 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`
   );
@@ -183,30 +178,12 @@ 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;
 }
 

package/src/core/GitReviseTodo.test.ts

@@ -67,7 +67,7 @@ test("git-revise-todo handles double quotes in commit message", () => {
     [
       //force line break
       "++ pick f143d03c723c",
-      '[new] invalid \\\\"by me\\\\" quotes',
+      '[new] invalid \\"by me\\" quotes',
       "",
       "git-stack-id: 6Ak-qn+5Z",
       'git-stack-title: [new] invalid \\"by me\\" quotes',
@@ -115,7 +115,7 @@ const SINGLE_COMMIT_EXISTING_GROUP: CommitMetadata.CommitRange = {
           full_message: "banana color\n\ngit-stack-id: AAWsYx1UU",
           subject_line: "banana color",
           branch_id: "AAWsYx1UU",
-          title: null,
+          title: "banana",
         },
       ],
     },
@@ -186,28 +186,28 @@ const SINGLE_COMMIT_EXISTING_GROUP: CommitMetadata.CommitRange = {
           full_message: "lemon color\n\ngit-stack-id: E63ytp5dj",
           subject_line: "lemon color",
           branch_id: "E63ytp5dj",
-          title: null,
+          title: "lemon color",
         },
         {
           sha: "d36d63499425bb46a1e62c2c9df1a4332b13004f",
           full_message: "cantaloupe color\n\ngit-stack-id: E63ytp5dj",
           subject_line: "cantaloupe color",
           branch_id: "E63ytp5dj",
-          title: null,
+          title: "lemon color",
         },
         {
           sha: "4f98dd3e67d03b79d7a12480c7d1c2fcbd186ac5",
           full_message: "banana sweet\n\ngit-stack-id: E63ytp5dj",
           subject_line: "banana sweet",
           branch_id: "E63ytp5dj",
-          title: null,
+          title: "lemon color",
         },
         {
           sha: "f143d03c723c9f5231a81c1e12098511611898cb",
           full_message: "apple sweet",
           subject_line: "apple sweet",
-          branch_id: null,
-          title: null,
+          branch_id: "E63ytp5dj",
+          title: "lemon color",
         },
       ],
     },
@@ -218,35 +218,35 @@ const SINGLE_COMMIT_EXISTING_GROUP: CommitMetadata.CommitRange = {
       full_message: "banana color\n\ngit-stack-id: AAWsYx1UU",
       subject_line: "banana color",
       branch_id: "AAWsYx1UU",
-      title: null,
+      title: "banana",
     },
     {
       sha: "3cb22661ecff6c872e96ce9c40b31c824938cab7",
       full_message: "lemon color\n\ngit-stack-id: E63ytp5dj",
       subject_line: "lemon color",
       branch_id: "E63ytp5dj",
-      title: null,
+      title: "lemon color",
     },
     {
       sha: "d36d63499425bb46a1e62c2c9df1a4332b13004f",
       full_message: "cantaloupe color\n\ngit-stack-id: E63ytp5dj",
       subject_line: "cantaloupe color",
       branch_id: "E63ytp5dj",
-      title: null,
+      title: "lemon color",
     },
     {
       sha: "4f98dd3e67d03b79d7a12480c7d1c2fcbd186ac5",
       full_message: "banana sweet\n\ngit-stack-id: E63ytp5dj",
       subject_line: "banana sweet",
       branch_id: "E63ytp5dj",
-      title: null,
+      title: "lemon color",
     },
     {
       sha: "f143d03c723c9f5231a81c1e12098511611898cb",
       full_message: "apple sweet",
       subject_line: "apple sweet",
-      branch_id: null,
-      title: null,
+      branch_id: "6Ak-qn+5Z",
+      title: "new group",
     },
   ],
   pr_lookup: {
@@ -376,7 +376,7 @@ const SINGLE_COMMIT_NEW_GROUP: CommitMetadata.CommitRange = {
           full_message: "banana color\n\ngit-stack-id: AAWsYx1UU",
           subject_line: "banana color",
           branch_id: "AAWsYx1UU",
-          title: null,
+          title: "banana",
         },
       ],
     },
@@ -447,21 +447,21 @@ const SINGLE_COMMIT_NEW_GROUP: CommitMetadata.CommitRange = {
           full_message: "lemon color\n\ngit-stack-id: E63ytp5dj",
           subject_line: "lemon color",
           branch_id: "E63ytp5dj",
-          title: null,
+          title: "lemon color",
         },
         {
           sha: "d36d63499425bb46a1e62c2c9df1a4332b13004f",
           full_message: "cantaloupe color\n\ngit-stack-id: E63ytp5dj",
           subject_line: "cantaloupe color",
           branch_id: "E63ytp5dj",
-          title: null,
+          title: "lemon color",
         },
         {
           sha: "4f98dd3e67d03b79d7a12480c7d1c2fcbd186ac5",
           full_message: "banana sweet\n\ngit-stack-id: E63ytp5dj",
           subject_line: "banana sweet",
           branch_id: "E63ytp5dj",
-          title: null,
+          title: "lemon color",
         },
       ],
     },
@@ -476,8 +476,8 @@ const SINGLE_COMMIT_NEW_GROUP: CommitMetadata.CommitRange = {
           sha: "f143d03c723c9f5231a81c1e12098511611898cb",
           full_message: "apple sweet",
           subject_line: "apple sweet",
-          branch_id: null,
-          title: null,
+          branch_id: "6Ak-qn+5Z",
+          title: "new group",
         },
       ],
     },
@@ -488,35 +488,35 @@ const SINGLE_COMMIT_NEW_GROUP: CommitMetadata.CommitRange = {
       full_message: "banana color\n\ngit-stack-id: AAWsYx1UU",
       subject_line: "banana color",
       branch_id: "AAWsYx1UU",
-      title: null,
+      title: "banana",
     },
     {
       sha: "3cb22661ecff6c872e96ce9c40b31c824938cab7",
       full_message: "lemon color\n\ngit-stack-id: E63ytp5dj",
       subject_line: "lemon color",
       branch_id: "E63ytp5dj",
-      title: null,
+      title: "lemon color",
     },
     {
       sha: "d36d63499425bb46a1e62c2c9df1a4332b13004f",
       full_message: "cantaloupe color\n\ngit-stack-id: E63ytp5dj",
       subject_line: "cantaloupe color",
       branch_id: "E63ytp5dj",
-      title: null,
+      title: "lemon color",
     },
     {
       sha: "4f98dd3e67d03b79d7a12480c7d1c2fcbd186ac5",
       full_message: "banana sweet\n\ngit-stack-id: E63ytp5dj",
       subject_line: "banana sweet",
       branch_id: "E63ytp5dj",
-      title: null,
+      title: "lemon color",
     },
     {
       sha: "f143d03c723c9f5231a81c1e12098511611898cb",
       full_message: "apple sweet",
       subject_line: "apple sweet",
-      branch_id: null,
-      title: null,
+      branch_id: "6Ak-qn+5Z",
+      title: "new group",
     },
   ],
   pr_lookup: {
@@ -620,8 +620,8 @@ const COMMIT_MESSAGE_WITH_QUOTES: CommitMetadata.CommitRange = {
           sha: "f143d03c723c9f5231a81c1e12098511611898cb",
           full_message: '[new] invalid "by me" quotes',
           subject_line: '[new] invalid "by me" quotes',
-          branch_id: null,
-          title: null,
+          branch_id: "6Ak-qn+5Z",
+          title: '[new] invalid "by me" quotes',
         },
       ],
     },
@@ -631,8 +631,8 @@ const COMMIT_MESSAGE_WITH_QUOTES: CommitMetadata.CommitRange = {
       sha: "f143d03c723c9f5231a81c1e12098511611898cb",
       full_message: '[new] invalid "by me" quotes',
       subject_line: '[new] invalid "by me" quotes',
-      branch_id: null,
-      title: null,
+      branch_id: "6Ak-qn+5Z",
+      title: '[new] invalid "by me" quotes',
     },
   ],
   pr_lookup: {},

package/src/core/GitReviseTodo.ts

@@ -1,4 +1,10 @@
+import fs from "node:fs";
+import os from "node:os";
+import path from "node:path";
+
 import * as Metadata from "~/core/Metadata";
+import { cli } from "~/core/cli";
+import { invariant } from "~/core/invariant";
 
 import type * as CommitMetadata from "~/core/CommitMetadata";
 
@@ -47,7 +53,7 @@ import type * as CommitMetadata from "~/core/CommitMetadata";
 //   apple sweet
 //
 export function GitReviseTodo(args: Args): string {
-  const entry_list = [];
+  const commit_list = [];
 
   const group_list = args.commit_range.group_list;
 
@@ -55,31 +61,83 @@ export function GitReviseTodo(args: Args): string {
     const group = group_list[i];
 
     for (const commit of group.commits) {
-      // update git commit message with stack id
-      const metadata = { id: group.id, title: group.title };
-      const unsafe_message_with_id = Metadata.write(
-        commit.full_message,
-        metadata
-      );
+      commit_list.push(commit);
+    }
+  }
+
+  const todo = GitReviseTodo.todo({ commit_list });
+  return todo;
+}
 
-      let message_with_id = unsafe_message_with_id;
+type CommitListArgs = {
+  commit_list: CommitMetadata.CommitRange["commit_list"];
+};
+
+GitReviseTodo.todo = function todo(args: CommitListArgs) {
+  const entry_list = [];
 
-      message_with_id = message_with_id.replace(/[^\\]"/g, '\\"');
+  for (const commit of args.commit_list) {
+    // update git commit message with stack id
+    const id = commit.branch_id;
+    const title = commit.title;
 
-      // get first 12 characters of commit sha
-      const sha = commit.sha.slice(0, 12);
+    invariant(id, "commit.branch_id must exist");
+    invariant(title, "commit.title must exist");
 
-      // generate git revise entry
-      const entry_lines = [`++ pick ${sha}`, message_with_id];
-      const entry = entry_lines.join("\n");
+    const metadata = { id, title };
 
-      entry_list.push(entry);
-    }
+    const unsafe_message_with_id = Metadata.write(
+      commit.full_message,
+      metadata
+    );
+
+    let message_with_id = unsafe_message_with_id;
+
+    message_with_id = message_with_id.replace(/[^\\]"/g, '\\"');
+
+    // get first 12 characters of commit sha
+    const sha = commit.sha.slice(0, 12);
+
+    // generate git revise entry
+    const entry_lines = [`++ pick ${sha}`, message_with_id];
+    const entry = entry_lines.join("\n");
+
+    entry_list.push(entry);
   }
 
   const todo = entry_list.join("\n\n");
   return todo;
-}
+};
+
+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"
+  );
+
+  // ensure script is executable
+  fs.chmodSync(tmp_git_sequence_editor_path, "755");
+
+  const git_revise_todo = GitReviseTodo(args);
+
+  // execute cli with temporary git sequence editor script
+  // revise from merge base to pick correct commits
+  const command = [
+    `GIT_EDITOR="${tmp_git_sequence_editor_path}"`,
+    `GIT_REVISE_TODO="${git_revise_todo}"`,
+    `git`,
+    `revise --edit -i ${args.rebase_merge_base}`,
+  ];
+
+  await cli(command, { stdio: ["ignore", "ignore", "ignore"] });
+};
+
+type ExecuteArgs = {
+  rebase_group_index: number;
+  rebase_merge_base: string;
+  commit_range: CommitMetadata.CommitRange;
+};
 
 type Args = {
   rebase_group_index: number;

package/src/core/gs_short_id.ts

@@ -0,0 +1,5 @@
+import { short_id } from "~/core/short_id";
+
+export function gs_short_id() {
+  return `gs-${short_id()}`;
+}