git-stack-cli 1.9.0 → 1.10.0

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()}`;
+}