git-stack-cli 2.7.8 → 2.8.0

package/src/core/GitReviseTodo.test.ts

@@ -171,8 +171,10 @@ const SINGLE_COMMIT_EXISTING_GROUP: CommitMetadata.CommitRange = {
           subject_line: "banana color",
           branch_id: "AAWsYx1UU",
           title: "banana",
+          master_base: false,
         },
       ],
+      master_base: false,
     },
     {
       id: "E63ytp5dj",
@@ -244,6 +246,7 @@ const SINGLE_COMMIT_EXISTING_GROUP: CommitMetadata.CommitRange = {
           subject_line: "lemon color",
           branch_id: "E63ytp5dj",
           title: "lemon color",
+          master_base: false,
         },
         {
           sha: "d36d63499425bb46a1e62c2c9df1a4332b13004f",
@@ -251,6 +254,7 @@ const SINGLE_COMMIT_EXISTING_GROUP: CommitMetadata.CommitRange = {
           subject_line: "cantaloupe color",
           branch_id: "E63ytp5dj",
           title: "lemon color",
+          master_base: false,
         },
         {
           sha: "4f98dd3e67d03b79d7a12480c7d1c2fcbd186ac5",
@@ -258,6 +262,7 @@ const SINGLE_COMMIT_EXISTING_GROUP: CommitMetadata.CommitRange = {
           subject_line: "banana sweet",
           branch_id: "E63ytp5dj",
           title: "lemon color",
+          master_base: false,
         },
         {
           sha: "f143d03c723c9f5231a81c1e12098511611898cb",
@@ -265,8 +270,10 @@ const SINGLE_COMMIT_EXISTING_GROUP: CommitMetadata.CommitRange = {
           subject_line: "apple sweet",
           branch_id: "E63ytp5dj",
           title: "lemon color",
+          master_base: false,
         },
       ],
+      master_base: false,
     },
   ],
   commit_list: [
@@ -276,6 +283,7 @@ const SINGLE_COMMIT_EXISTING_GROUP: CommitMetadata.CommitRange = {
       subject_line: "banana color",
       branch_id: "AAWsYx1UU",
       title: "banana",
+      master_base: false,
     },
     {
       sha: "3cb22661ecff6c872e96ce9c40b31c824938cab7",
@@ -283,6 +291,7 @@ const SINGLE_COMMIT_EXISTING_GROUP: CommitMetadata.CommitRange = {
       subject_line: "lemon color",
       branch_id: "E63ytp5dj",
       title: "lemon color",
+      master_base: false,
     },
     {
       sha: "d36d63499425bb46a1e62c2c9df1a4332b13004f",
@@ -290,6 +299,7 @@ const SINGLE_COMMIT_EXISTING_GROUP: CommitMetadata.CommitRange = {
       subject_line: "cantaloupe color",
       branch_id: "E63ytp5dj",
       title: "lemon color",
+      master_base: false,
     },
     {
       sha: "4f98dd3e67d03b79d7a12480c7d1c2fcbd186ac5",
@@ -297,6 +307,7 @@ const SINGLE_COMMIT_EXISTING_GROUP: CommitMetadata.CommitRange = {
       subject_line: "banana sweet",
       branch_id: "E63ytp5dj",
       title: "lemon color",
+      master_base: false,
     },
     {
       sha: "f143d03c723c9f5231a81c1e12098511611898cb",
@@ -304,6 +315,7 @@ const SINGLE_COMMIT_EXISTING_GROUP: CommitMetadata.CommitRange = {
       subject_line: "apple sweet",
       branch_id: "6Ak-qn+5Z",
       title: "new group",
+      master_base: false,
     },
   ],
   pr_lookup: {
@@ -440,8 +452,10 @@ const SINGLE_COMMIT_NEW_GROUP: CommitMetadata.CommitRange = {
           subject_line: "banana color",
           branch_id: "AAWsYx1UU",
           title: "banana",
+          master_base: false,
         },
       ],
+      master_base: false,
     },
     {
       id: "E63ytp5dj",
@@ -513,6 +527,7 @@ const SINGLE_COMMIT_NEW_GROUP: CommitMetadata.CommitRange = {
           subject_line: "lemon color",
           branch_id: "E63ytp5dj",
           title: "lemon color",
+          master_base: false,
         },
         {
           sha: "d36d63499425bb46a1e62c2c9df1a4332b13004f",
@@ -520,6 +535,7 @@ const SINGLE_COMMIT_NEW_GROUP: CommitMetadata.CommitRange = {
           subject_line: "cantaloupe color",
           branch_id: "E63ytp5dj",
           title: "lemon color",
+          master_base: false,
         },
         {
           sha: "4f98dd3e67d03b79d7a12480c7d1c2fcbd186ac5",
@@ -527,8 +543,10 @@ const SINGLE_COMMIT_NEW_GROUP: CommitMetadata.CommitRange = {
           subject_line: "banana sweet",
           branch_id: "E63ytp5dj",
           title: "lemon color",
+          master_base: false,
         },
       ],
+      master_base: false,
     },
     {
       id: "6Ak-qn+5Z",
@@ -543,8 +561,10 @@ const SINGLE_COMMIT_NEW_GROUP: CommitMetadata.CommitRange = {
           subject_line: "apple sweet",
           branch_id: "6Ak-qn+5Z",
           title: "new group",
+          master_base: false,
         },
       ],
+      master_base: false,
     },
   ],
   commit_list: [
@@ -554,6 +574,7 @@ const SINGLE_COMMIT_NEW_GROUP: CommitMetadata.CommitRange = {
       subject_line: "banana color",
       branch_id: "AAWsYx1UU",
       title: "banana",
+      master_base: false,
     },
     {
       sha: "3cb22661ecff6c872e96ce9c40b31c824938cab7",
@@ -561,6 +582,7 @@ const SINGLE_COMMIT_NEW_GROUP: CommitMetadata.CommitRange = {
       subject_line: "lemon color",
       branch_id: "E63ytp5dj",
       title: "lemon color",
+      master_base: false,
     },
     {
       sha: "d36d63499425bb46a1e62c2c9df1a4332b13004f",
@@ -568,6 +590,7 @@ const SINGLE_COMMIT_NEW_GROUP: CommitMetadata.CommitRange = {
       subject_line: "cantaloupe color",
       branch_id: "E63ytp5dj",
       title: "lemon color",
+      master_base: false,
     },
     {
       sha: "4f98dd3e67d03b79d7a12480c7d1c2fcbd186ac5",
@@ -575,6 +598,7 @@ const SINGLE_COMMIT_NEW_GROUP: CommitMetadata.CommitRange = {
       subject_line: "banana sweet",
       branch_id: "E63ytp5dj",
       title: "lemon color",
+      master_base: false,
     },
     {
       sha: "f143d03c723c9f5231a81c1e12098511611898cb",
@@ -582,6 +606,7 @@ const SINGLE_COMMIT_NEW_GROUP: CommitMetadata.CommitRange = {
       subject_line: "apple sweet",
       branch_id: "6Ak-qn+5Z",
       title: "new group",
+      master_base: false,
     },
   ],
   pr_lookup: {
@@ -691,8 +716,10 @@ const COMMIT_MESSAGE_WITH_QUOTES: CommitMetadata.CommitRange = {
           subject_line: '[new] invalid "by me" quotes',
           branch_id: "6Ak-qn+5Z",
           title: '[new] invalid "by me" quotes',
+          master_base: false,
         },
       ],
+      master_base: false,
     },
   ],
   commit_list: [
@@ -702,6 +729,7 @@ const COMMIT_MESSAGE_WITH_QUOTES: CommitMetadata.CommitRange = {
       subject_line: '[new] invalid "by me" quotes',
       branch_id: "6Ak-qn+5Z",
       title: '[new] invalid "by me" quotes',
+      master_base: false,
     },
   ],
   pr_lookup: {},
@@ -726,6 +754,7 @@ const SYNC_WITH_UNASSIGNED: CommitMetadata.CommitRange = {
           subject_line: "head~7",
           branch_id: "gs---4gvxa-5v-2mx26",
           title: "pr-title",
+          master_base: false,
         },
         {
           sha: "391476bbfc6b77b60a3ef7fa97155496a9f8f27f",
@@ -733,6 +762,7 @@ const SYNC_WITH_UNASSIGNED: CommitMetadata.CommitRange = {
           subject_line: "head~6",
           branch_id: "gs---4gvxa-5v-2mx26",
           title: "pr-title",
+          master_base: false,
         },
         {
           sha: "5a98cf8f0406712405d41af07c3a012f72ad36fa",
@@ -740,6 +770,7 @@ const SYNC_WITH_UNASSIGNED: CommitMetadata.CommitRange = {
           subject_line: "head~5",
           branch_id: "gs---4gvxa-5v-2mx26",
           title: "pr-title",
+          master_base: false,
         },
         {
           sha: "e820018cb370bb6cda118dc649e841c75d797188",
@@ -747,6 +778,7 @@ const SYNC_WITH_UNASSIGNED: CommitMetadata.CommitRange = {
           subject_line: "head~4",
           branch_id: "gs---4gvxa-5v-2mx26",
           title: "pr-title",
+          master_base: false,
         },
         {
           sha: "e6d1dfc7ec007468712bfc015884cc22bfa79e1d",
@@ -754,6 +786,7 @@ const SYNC_WITH_UNASSIGNED: CommitMetadata.CommitRange = {
           subject_line: "head~3",
           branch_id: "gs---4gvxa-5v-2mx26",
           title: "pr-title",
+          master_base: false,
         },
         {
           sha: "a26f21025a558968554c439ab9b942d5fe84bccb",
@@ -761,8 +794,10 @@ const SYNC_WITH_UNASSIGNED: CommitMetadata.CommitRange = {
           subject_line: "head~2",
           branch_id: "gs---4gvxa-5v-2mx26",
           title: "pr-title",
+          master_base: false,
         },
       ],
+      master_base: false,
     },
     {
       id: "unassigned",
@@ -777,6 +812,7 @@ const SYNC_WITH_UNASSIGNED: CommitMetadata.CommitRange = {
           subject_line: "head~1",
           branch_id: "unassigned",
           title: "allow_unassigned",
+          master_base: false,
         },
         {
           sha: "b61c5b09a4b7c9dcff9a9071386b134997569a01",
@@ -784,8 +820,10 @@ const SYNC_WITH_UNASSIGNED: CommitMetadata.CommitRange = {
           subject_line: "head",
           branch_id: "unassigned",
           title: "allow_unassigned",
+          master_base: false,
         },
       ],
+      master_base: false,
     },
   ],
   commit_list: [
@@ -795,6 +833,7 @@ const SYNC_WITH_UNASSIGNED: CommitMetadata.CommitRange = {
       subject_line: "head~7",
       branch_id: "gs---4gvxa-5v-2mx26",
       title: "pr-title",
+      master_base: false,
     },
     {
       sha: "391476bbfc6b77b60a3ef7fa97155496a9f8f27f",
@@ -802,6 +841,7 @@ const SYNC_WITH_UNASSIGNED: CommitMetadata.CommitRange = {
       subject_line: "head~6",
       branch_id: "gs---4gvxa-5v-2mx26",
       title: "pr-title",
+      master_base: false,
     },
     {
       sha: "5a98cf8f0406712405d41af07c3a012f72ad36fa",
@@ -809,6 +849,7 @@ const SYNC_WITH_UNASSIGNED: CommitMetadata.CommitRange = {
       subject_line: "head~5",
       branch_id: "gs---4gvxa-5v-2mx26",
       title: "pr-title",
+      master_base: false,
     },
     {
       sha: "e820018cb370bb6cda118dc649e841c75d797188",
@@ -816,6 +857,7 @@ const SYNC_WITH_UNASSIGNED: CommitMetadata.CommitRange = {
       subject_line: "head~4",
       branch_id: "gs---4gvxa-5v-2mx26",
       title: "pr-title",
+      master_base: false,
     },
     {
       sha: "e6d1dfc7ec007468712bfc015884cc22bfa79e1d",
@@ -823,6 +865,7 @@ const SYNC_WITH_UNASSIGNED: CommitMetadata.CommitRange = {
       subject_line: "head~3",
       branch_id: "gs---4gvxa-5v-2mx26",
       title: "pr-title",
+      master_base: false,
     },
     {
       sha: "a26f21025a558968554c439ab9b942d5fe84bccb",
@@ -830,6 +873,7 @@ const SYNC_WITH_UNASSIGNED: CommitMetadata.CommitRange = {
       subject_line: "head~2",
       branch_id: "gs---4gvxa-5v-2mx26",
       title: "pr-title",
+      master_base: false,
     },
     {
       sha: "90667fe97e059e8285e070d6268f2b4035b2ebd4",
@@ -837,6 +881,7 @@ const SYNC_WITH_UNASSIGNED: CommitMetadata.CommitRange = {
       subject_line: "head~1",
       branch_id: "unassigned",
       title: "allow_unassigned",
+      master_base: false,
     },
     {
       sha: "b61c5b09a4b7c9dcff9a9071386b134997569a01",
@@ -844,6 +889,7 @@ const SYNC_WITH_UNASSIGNED: CommitMetadata.CommitRange = {
       subject_line: "head",
       branch_id: "unassigned",
       title: "allow_unassigned",
+      master_base: false,
     },
   ],
   pr_lookup: {},

package/src/core/GitReviseTodo.ts

@@ -76,6 +76,8 @@ type CommitListArgs = {
   commit_list: CommitMetadata.CommitRange["commit_list"];
 };
 
+type MetadataWriteValues = Parameters<typeof Metadata.write>[1];
+
 GitReviseTodo.todo = function todo(args: CommitListArgs) {
   const entry_list = [];
 
@@ -95,7 +97,10 @@ GitReviseTodo.todo = function todo(args: CommitListArgs) {
       const title = commit.title;
       invariant(title, "commit.title must exist");
 
-      const metadata = { id, title };
+      const metadata: MetadataWriteValues = { id, title };
+      if (commit.master_base) {
+        metadata.base = "master";
+      }
       const unsafe_message_with_id = Metadata.write(commit.full_message, metadata);
       const message_with_id = unsafe_message_with_id;
       entry_lines.push(message_with_id);

package/src/core/Metadata.test.ts

@@ -2,6 +2,54 @@ import { test, expect } from "bun:test";
 
 import * as Metadata from "~/core/Metadata";
 
+test("read all metadata", () => {
+  const body = [
+    "[test] read all metadata",
+    "",
+    "git-stack-id: noah/test---4h783e3zbtavw4",
+    "git-stack-title: read all metadata",
+    "git-stack-base: master",
+  ].join("\n");
+
+  const metadata = Metadata.read(body);
+
+  expect(metadata).toEqual({
+    subject: "[test] read all metadata",
+    id: "noah/test---4h783e3zbtavw4",
+    title: "read all metadata",
+    base: "master",
+  });
+});
+
+test("write all metadata", () => {
+  const body = [
+    "[test] write all metadata",
+    "",
+    "- details about this commit",
+    "",
+    "git-stack-id: DdKIFyufW",
+    "git-stack-title: old title",
+  ].join("\n");
+
+  const metadata = {
+    id: "noah/test---4h783e3zbtavw4",
+    title: "read all metadata",
+    base: "master",
+  };
+
+  expect(Metadata.write(body, metadata)).toEqual(
+    [
+      "[test] write all metadata",
+      "",
+      "- details about this commit",
+      "",
+      "git-stack-id: noah/test---4h783e3zbtavw4",
+      "git-stack-title: read all metadata",
+      "git-stack-base: master",
+    ].join("\n"),
+  );
+});
+
 test("read handles bulleted lists", () => {
   const body = [
     "[feat] implement various features",
@@ -20,6 +68,7 @@ test("read handles bulleted lists", () => {
     subject: "[feat] implement various features",
     id: "DdKIFyufW",
     title: "saved group title",
+    base: null,
   });
 });
 
@@ -67,6 +116,7 @@ test("read handles slashes in branch name", () => {
     subject: "[fix] slash in branch name",
     id: "dev/noah/fix-slash-branch",
     title: "fix slash branch",
+    base: null,
   });
 });
 
@@ -114,6 +164,7 @@ test("read handles double quotes", () => {
     subject: 'Revert "[abc / 123] subject (#1234)"',
     id: "dev/noah/fix-slash-branch",
     title: 'Revert \\"[abc / 123] subject (#1234)\\"',
+    base: null,
   });
 });
 

package/src/core/Metadata.ts

@@ -3,12 +3,14 @@ import { invariant } from "~/core/invariant";
 type InputMetadataValues = {
   id: string;
   title?: string;
+  base?: string;
 };
 
 type OutputMetadataValues = {
   subject: null | string;
   id: null | string;
   title: null | string;
+  base: null | string;
 };
 
 export function write(message: string, values: InputMetadataValues) {
@@ -23,13 +25,22 @@ export function write(message: string, values: InputMetadataValues) {
     line_list.push(TEMPLATE.group_title(values.title));
   }
 
+  if (values.base) {
+    line_list.push(TEMPLATE.base(values.base));
+  }
+
   let new_message = line_list.join("\n");
 
   return new_message;
 }
 
 export function read(message: string): OutputMetadataValues {
-  const values: OutputMetadataValues = { subject: null, id: null, title: null };
+  const values: OutputMetadataValues = {
+    subject: null,
+    id: null,
+    title: null,
+    base: null,
+  };
 
   const match_subject = message.match(RE.subject_line);
 
@@ -51,6 +62,12 @@ export function read(message: string): OutputMetadataValues {
     values.title = match_title.groups["title"];
   }
 
+  const match_base = message.match(RE.base);
+
+  if (match_base?.groups) {
+    values.base = match_base.groups["ref"];
+  }
+
   return values;
 }
 
@@ -60,6 +77,7 @@ export function remove(message: string) {
   // remove metadata
   result = result.replace(new RegExp(RE.stack_id, "gmi"), "");
   result = result.replace(new RegExp(RE.group_title, "gmi"), "");
+  result = result.replace(new RegExp(RE.base, "gmi"), "");
 
   result = result.trimEnd();
 
@@ -74,6 +92,10 @@ const TEMPLATE = {
   group_title(title: string) {
     return `git-stack-title: ${title}`;
   },
+
+  base(ref: string) {
+    return `git-stack-base: ${ref}`;
+  },
 };
 
 const RE = {
@@ -82,4 +104,5 @@ const RE = {
   // https://regex101.com/r/wLmGVq/1
   stack_id: new RegExp(`${TEMPLATE.stack_id("(?<id>[^\\s]+)")}`, "i"),
   group_title: new RegExp(TEMPLATE.group_title("(?<title>[^\\n^\\r]+)"), "i"),
+  base: new RegExp(`${TEMPLATE.base("(?<ref>[^\\s]+)")}`, "i"),
 };

package/src/core/__snapshots__/git.test.ts.snap

@@ -51,6 +51,7 @@ git-stack-title: Github: pr_list duration timer"
   {
     "branch_id": null,
     "full_message": "homebrew-git-stack 2.7.1",
+    "master_base": false,
     "sha": "ba067f8ad641dda7e65e3c2acb2421c955843829",
     "subject_line": "homebrew-git-stack 2.7.1",
     "title": null,
@@ -63,6 +64,7 @@ git-stack-title: Github: pr_list duration timer"
 git-stack-id: noah/paint-test---4gwpqhd033n6y5
 git-stack-title: Rebase: debug logs"
 ,
+    "master_base": false,
     "sha": "7c8da9f5fe681fc7459a0e737241df631983cd3c",
     "subject_line": "Rebase: debug logs",
     "title": "Rebase: debug logs",
@@ -75,6 +77,7 @@ git-stack-title: Rebase: debug logs"
 git-stack-id: noah/paint-test---4gwpqirewoudxa
 git-stack-title: CommitMetadata: track last group id"
 ,
+    "master_base": false,
     "sha": "47a69d37f8c5cc796884a91fa9e93fc1db5297dd",
     "subject_line": "CommitMetadata: track last group id",
     "title": "CommitMetadata: track last group id",
@@ -87,6 +90,7 @@ git-stack-title: CommitMetadata: track last group id"
 git-stack-id: noah/paint-test---4gwpqjcpu7-isv
 git-stack-title: Github: pr_list duration timer"
 ,
+    "master_base": false,
     "sha": "8ccf42a7c72aa194fafc7c326f5874f5a0a009c6",
     "subject_line": "Github: pr_list duration timer",
     "title": "Github: pr_list duration timer",

package/src/core/git.ts

@@ -1,8 +1,11 @@
 import { Store } from "~/app/Store";
 import * as Metadata from "~/core/Metadata";
 import { cli } from "~/core/cli";
+import { invariant } from "~/core/invariant";
 
-export type Commit = Awaited<ReturnType<typeof get_commits>>[0];
+type CommitList = Awaited<ReturnType<typeof get_commits>>;
+
+export type Commit = CommitList[0];
 
 export async function get_commits(dot_range: string) {
   const log_result = await cli(`git log ${dot_range} --format=${FORMAT} --color=never`);
@@ -34,6 +37,7 @@ export async function get_commits(dot_range: string) {
     const branch_id = metadata.id;
     const subject_line = metadata.subject || "";
     const title = metadata.title;
+    const master_base = metadata.base === "master";
 
     const commit = {
       sha,
@@ -41,6 +45,7 @@ export async function get_commits(dot_range: string) {
       subject_line,
       branch_id,
       title,
+      master_base,
     };
 
     commit_list.push(commit);
@@ -51,6 +56,15 @@ export async function get_commits(dot_range: string) {
   return commit_list;
 }
 
+export async function get_diff(commit_list: CommitList) {
+  invariant(commit_list.length, "commit_list must exist");
+  const first_commit = commit_list[0];
+  const last_commit = commit_list[commit_list.length - 1];
+  const sha_range = `${first_commit.sha}~1..${last_commit.sha}`;
+  const diff_result = await cli(`git --no-pager diff --color=never ${sha_range}`);
+  return diff_result.stdout;
+}
+
 // Why these separators?
 // - Rare in human written text
 // - Supported in git %xNN to write bytes

package/src/core/github.tsx

@@ -167,6 +167,10 @@ type EditPullRequestArgs = {
 };
 
 export async function pr_edit(args: EditPullRequestArgs) {
+  // const state = Store.getState();
+  // const actions = state.actions;
+  // actions.debug(`github.pr_edit ${JSON.stringify(args)}`);
+
   const command_parts = [`gh pr edit ${args.branch}`];
 
   if (args.base) {
@@ -237,6 +241,20 @@ export async function pr_draft(args: DraftPullRequestArgs) {
   }
 }
 
+export async function pr_diff(number: number) {
+  // https://cli.github.com/manual/gh_pr_diff
+
+  const cli_result = await cli(`gh pr diff --color=never ${number}`);
+
+  if (cli_result.code !== 0) {
+    handle_error(cli_result.output);
+  }
+
+  return cli_result.stdout;
+}
+
+// pull request JSON fields
+// https://cli.github.com/manual/gh_pr_list
 // prettier-ignore
 const JSON_FIELDS = "--json id,number,state,baseRefName,headRefName,commits,title,body,url,isDraft";
 
@@ -281,11 +299,10 @@ async function write_body_file(args: EditPullRequestArgs) {
   invariant(args.body, "args.body must exist");
 
   // ensure unique filename is safe for filesystem
-  // base (group id) might contain slashes, e.g. dev/magus/gs-3cmrMBSUj
+  // args.branch_id (group id) might contain slashes, e.g. dev/magus/gs-3cmrMBSUj
   // the flashes would mess up the filesystem path to this file
-  let base = args.base || "master";
-  base = base.replace(/^origin\//, "");
-  let tmp_filename = safe_filename(`git-stack-body-${base}`);
+  const branch = args.branch;
+  let tmp_filename = safe_filename(`git-stack-body-${branch}`);
 
   const temp_path = path.join(await get_tmp_dir(), tmp_filename);