git-stack-cli 1.5.0 → 1.6.0

package/README.md

@@ -20,15 +20,18 @@
 > [!TIP]
 >
 > Install via **[Homebrew](https://brew.sh/)** to ensure the **[official Github CLI](https://cli.github.com/)** and **[git revise](https://github.com/mystor/git-revise)** dependencies are installed automatically
+>
+> ```bash
+> brew install magus/git-stack/git-stack
+> ```
 
-```bash
-brew tap magus/git-stack
-brew install git-stack
-```
+<details>
 
-### `npm`
+<summary>
+npm alternative
+</summary>
 
-Installing via **[npm](https://www.npmjs.com/)** requires installing the **[official Github CLI](https://cli.github.com/)** and **[git revise](https://github.com/mystor/git-revise)** dependencies separarely
+If you prefer to use **[npm](https://www.npmjs.com/)** you will need to install the **[official Github CLI](https://cli.github.com/)** and **[git revise](https://github.com/mystor/git-revise)** dependencies separarely
 
 ```bash
 brew install gh
@@ -37,6 +40,8 @@ brew install git-revise
 npm i -g git-stack-cli
 ```
 
+</details>
+
 ## Usage
 
 ```bash
@@ -76,6 +81,8 @@ Managing even a few stacked diffs requires a relatively strong knowledge of `git
 
 ## Development
 
+Ensure `node --version` is the same across both projects you are using to test the `git-stack` cli
+
 ```bash
 git submodule update --init --recursive
 npm i

package/dist/cjs/index.cjs

@@ -27800,7 +27800,8 @@ function GitReviseTodo(args) {
         for (const commit of group.commits) {
             // update git commit message with stack id
             const metadata = { id: group.id, title: group.title };
-            const message_with_id = write$1(commit.full_message, metadata);
+            const unsafe_message_with_id = write$1(commit.full_message, metadata);
+            const message_with_id = unsafe_message_with_id.replace(/"/g, '\\"');
             // get first 12 characters of commit sha
             const sha = commit.sha.slice(0, 12);
             // generate git revise entry
@@ -27816,9 +27817,13 @@ function GitReviseTodo(args) {
 function write(args) {
     const stack_table = table(args);
     let result = args.body;
-    if (RE.stack_table.test(result)) {
+    if (RE.stack_table_link.test(result)) {
         // replace stack table
-        result = result.replace(RE.stack_table, stack_table);
+        result = result.replace(RE.stack_table_link, stack_table);
+    }
+    else if (RE.stack_table_legacy.test(result)) {
+        // replace stack table
+        result = result.replace(RE.stack_table_legacy, stack_table);
     }
     else {
         // append stack table
@@ -27861,10 +27866,13 @@ function table(args) {
     if (!stack_list.length) {
         return "";
     }
-    return TEMPLATE.stack_table(["", ...stack_list, "", ""].join("\n"));
+    return TEMPLATE.stack_table_link(["", ...stack_list, "", ""].join("\n"));
 }
 function parse(body) {
-    const stack_table_match = body.match(RE.stack_table);
+    let stack_table_match = body.match(RE.stack_table_link);
+    if (!stack_table_match?.groups) {
+        stack_table_match = body.match(RE.stack_table_legacy);
+    }
     if (!stack_table_match?.groups) {
         return new Map();
     }
@@ -27878,26 +27886,39 @@ function parse(body) {
             // skip invalid row
             continue;
         }
+        if (!RE.pr_url.test(parsed_row.pr_url)) {
+            continue;
+        }
         result.set(parsed_row.pr_url, parsed_row);
     }
     return result;
 }
 const TEMPLATE = {
-    stack_table(rows) {
+    stack_table_legacy(rows) {
         return `#### git stack${rows}`;
     },
+    stack_table_link(rows) {
+        return `#### [git stack](https://github.com/magus/git-stack-cli)${rows}`;
+    },
     row(args) {
         return `- ${args.icon} \`${args.num}\` ${args.pr_url}`;
     },
 };
 const RE = {
     // https://regex101.com/r/kqB9Ft/1
-    stack_table: new RegExp(TEMPLATE.stack_table("\\s+(?<rows>(?:- [^\r^\n]*(?:[\r\n]+)?)+)")),
+    stack_table_legacy: new RegExp(TEMPLATE.stack_table_legacy("\\s+(?<rows>(?:- [^\r^\n]*(?:[\r\n]+)?)+)")),
+    stack_table_link: new RegExp(TEMPLATE.stack_table_link("ROWS")
+        .replace("[", "\\[")
+        .replace("]", "\\]")
+        .replace("(", "\\(")
+        .replace(")", "\\)")
+        .replace("ROWS", "\\s+(?<rows>(?:- [^\r^\n]*(?:[\r\n]+)?)+)")),
     row: new RegExp(TEMPLATE.row({
         icon: "(?<icon>.+)",
         num: "(?<num>\\d+)",
         pr_url: "(?<pr_url>.+)",
     })),
+    pr_url: /^https:\/\/.*$/,
 };
 
 function ManualRebase() {
@@ -28495,7 +28516,8 @@ function MultiSelect(props) {
     });
     // clamp index to keep in item range
     const [index, set_index] = reactExports.useReducer((_, value) => {
-        return clamp(value, 0, props.items.length - 1);
+        const next_index = clamp(value, 0, props.items.length - 1);
+        return next_index;
     }, 0, function find_initial_index() {
         let last_enabled;
         for (let i = props.items.length - 1; i >= 0; i--) {
@@ -28522,9 +28544,17 @@ function MultiSelect(props) {
         const selected_list = Array.from(selected_set);
         const selected = selected_set.has(index);
         const state = selected_list.map((index) => props.items[index].value);
-        // console.debug({ item, selected, state });
+        // console.debug("onSelect", { item, selected, state });
         props.onSelect({ item, selected, state });
     }, [selected_set]);
+    reactExports.useEffect(() => {
+        const item = props.items[index].value;
+        const selected_list = Array.from(selected_set);
+        const selected = selected_set.has(index);
+        const state = selected_list.map((index) => props.items[index].value);
+        // console.debug("onFocus", { item, selected, state });
+        props.onFocus?.({ item, selected, state });
+    }, [index]);
     useInput((input, key) => {
         if (props.disabled) {
             // console.debug("[MultiSelect] disabled, ignoring input");
@@ -28659,7 +28689,7 @@ function TextInput(props) {
         reactExports.createElement(Text, { color: colors.yellow, dimColor: true, inverse: caret_visible }, " ")));
 }
 function get_value(props) {
-    return props.value || "";
+    return props.value || props.defaultValue || "";
 }
 
 function SelectCommitRanges() {
@@ -28790,9 +28820,13 @@ function SelectCommitRangesInternal(props) {
     group_title_width = Math.min(group.title.length, group_title_width);
     let max_item_width = max_group_label_width;
     max_item_width -= left_arrow.length + right_arrow.length;
+    const [focused, set_focused] = reactExports.useState("");
     return (reactExports.createElement(Box, { flexDirection: "column" },
         reactExports.createElement(Box, { height: 1 }),
-        reactExports.createElement(MultiSelect, { key: group.id, items: items, maxWidth: max_item_width, disabled: group_input, onSelect: (args) => {
+        reactExports.createElement(MultiSelect, { key: group.id, items: items, maxWidth: max_item_width, disabled: group_input, onFocus: (args) => {
+                // console.debug("onFocus", args);
+                set_focused(args.item.subject_line);
+            }, onSelect: (args) => {
                 // console.debug("onSelect", args);
                 const key = args.item.sha;
                 let value;
@@ -28837,7 +28871,7 @@ function SelectCommitRangesInternal(props) {
                                 enter: (reactExports.createElement(Text, { bold: true, color: colors.green }, SYMBOL.enter)),
                             } }))),
                 } }),
-            reactExports.createElement(TextInput, { onSubmit: submit_group_input }),
+            reactExports.createElement(TextInput, { defaultValue: focused, onSubmit: submit_group_input }),
             reactExports.createElement(Box, { height: 1 }))),
         reactExports.createElement(Box, null,
             reactExports.createElement(FormatText, { wrapper: reactExports.createElement(Text, { color: colors.gray }), message: "Press {left} and {right} to view PR groups", values: {
@@ -34418,7 +34452,7 @@ async function command() {
         .wrap(123)
         // disallow unknown options
         .strict()
-        .version("1.5.0" )
+        .version("1.6.0" )
         .showHidden("show-hidden", "Show hidden options via `git stack help --show-hidden`")
         .help("help", "Show usage via `git stack help`").argv);
 }

package/package.json

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

package/src/app/MultiSelect.tsx

@@ -9,7 +9,8 @@ import { wrap_index } from "~/core/wrap_index";
 
 type Props<T> = {
   items: Array<Item<T>>;
-  onSelect(args: SelectArgs<T>): void;
+  onSelect: (args: CallbackArgs<T>) => void;
+  onFocus?: (args: CallbackArgs<T>) => void;
   disabled?: boolean;
   maxWidth?: number;
 };
@@ -21,7 +22,7 @@ type Item<T> = {
   disabled?: ItemRowProps["disabled"];
 };
 
-type SelectArgs<T> = {
+type CallbackArgs<T> = {
   item: T;
   selected: boolean;
   state: Array<T>;
@@ -55,7 +56,8 @@ export function MultiSelect<T>(props: Props<T>) {
   // clamp index to keep in item range
   const [index, set_index] = React.useReducer(
     (_: unknown, value: number) => {
-      return clamp(value, 0, props.items.length - 1);
+      const next_index = clamp(value, 0, props.items.length - 1);
+      return next_index;
     },
     0,
     function find_initial_index() {
@@ -94,10 +96,20 @@ export function MultiSelect<T>(props: Props<T>) {
     const selected = selected_set.has(index);
     const state = selected_list.map((index) => props.items[index].value);
 
-    // console.debug({ item, selected, state });
+    // console.debug("onSelect", { item, selected, state });
     props.onSelect({ item, selected, state });
   }, [selected_set]);
 
+  React.useEffect(() => {
+    const item = props.items[index].value;
+    const selected_list = Array.from(selected_set);
+    const selected = selected_set.has(index);
+    const state = selected_list.map((index) => props.items[index].value);
+
+    // console.debug("onFocus", { item, selected, state });
+    props.onFocus?.({ item, selected, state });
+  }, [index]);
+
   Ink.useInput((input, key) => {
     if (props.disabled) {
       // console.debug("[MultiSelect] disabled, ignoring input");

package/src/app/SelectCommitRanges.tsx

@@ -199,6 +199,8 @@ function SelectCommitRangesInternal(props: Props) {
   let max_item_width = max_group_label_width;
   max_item_width -= left_arrow.length + right_arrow.length;
 
+  const [focused, set_focused] = React.useState("");
+
   return (
     <Ink.Box flexDirection="column">
       <Ink.Box height={1} />
@@ -208,6 +210,11 @@ function SelectCommitRangesInternal(props: Props) {
         items={items}
         maxWidth={max_item_width}
         disabled={group_input}
+        onFocus={(args) => {
+          // console.debug("onFocus", args);
+
+          set_focused(args.item.subject_line);
+        }}
         onSelect={(args) => {
           // console.debug("onSelect", args);
 
@@ -326,7 +333,7 @@ function SelectCommitRangesInternal(props: Props) {
             }}
           />
 
-          <TextInput onSubmit={submit_group_input} />
+          <TextInput defaultValue={focused} onSubmit={submit_group_input} />
 
           <Ink.Box height={1} />
         </React.Fragment>

package/src/app/TextInput.tsx

@@ -6,6 +6,7 @@ import { colors } from "~/core/colors";
 
 type Props = {
   multiline?: boolean;
+  defaultValue?: string;
   value?: string;
   onChange?: (value: string) => void;
   onSubmit?: (value: string) => void;
@@ -84,5 +85,5 @@ export function TextInput(props: Props) {
 }
 
 function get_value(props: Props) {
-  return props.value || "";
+  return props.value || props.defaultValue || "";
 }

package/src/core/GitReviseTodo.test.ts

@@ -57,6 +57,24 @@ test("git-revise-todo from commit range with single new commit in new group", ()
   );
 });
 
+test("git-revise-todo handles double quotes in commit message", () => {
+  const rebase_group_index = 0;
+  const commit_range = COMMIT_MESSAGE_WITH_QUOTES;
+
+  const git_revise_todo = GitReviseTodo({ rebase_group_index, commit_range });
+
+  expect(git_revise_todo).toBe(
+    [
+      //force line break
+      "++ pick f143d03c723c",
+      '[new] invalid \\\\"by me\\\\" quotes',
+      "",
+      "git-stack-id: 6Ak-qn+5Z",
+      'git-stack-title: [new] invalid \\"by me\\" quotes',
+    ].join("\n")
+  );
+});
+
 const SINGLE_COMMIT_EXISTING_GROUP: CommitMetadata.CommitRange = {
   "invalid": false,
   "group_list": [
@@ -595,3 +613,36 @@ const SINGLE_COMMIT_NEW_GROUP: CommitMetadata.CommitRange = {
   },
   "UNASSIGNED": "unassigned",
 };
+
+const COMMIT_MESSAGE_WITH_QUOTES: CommitMetadata.CommitRange = {
+  "invalid": false,
+  "group_list": [
+    {
+      "id": "6Ak-qn+5Z",
+      "title": '[new] invalid "by me" quotes',
+      "pr": null,
+      "base": "E63ytp5dj",
+      "dirty": true,
+      "commits": [
+        {
+          "sha": "f143d03c723c9f5231a81c1e12098511611898cb",
+          "full_message": '[new] invalid "by me" quotes',
+          "subject_line": '[new] invalid "by me" quotes',
+          "branch_id": null,
+          "title": null,
+        },
+      ],
+    },
+  ],
+  "commit_list": [
+    {
+      "sha": "f143d03c723c9f5231a81c1e12098511611898cb",
+      "full_message": '[new] invalid "by me" quotes',
+      "subject_line": '[new] invalid "by me" quotes',
+      "branch_id": null,
+      "title": null,
+    },
+  ],
+  "pr_lookup": {},
+  "UNASSIGNED": "unassigned",
+};

package/src/core/GitReviseTodo.ts

@@ -57,7 +57,11 @@ export function GitReviseTodo(args: Args): string {
     for (const commit of group.commits) {
       // update git commit message with stack id
       const metadata = { id: group.id, title: group.title };
-      const message_with_id = Metadata.write(commit.full_message, metadata);
+      const unsafe_message_with_id = Metadata.write(
+        commit.full_message,
+        metadata
+      );
+      const message_with_id = unsafe_message_with_id.replace(/"/g, '\\"');
 
       // get first 12 characters of commit sha
       const sha = commit.sha.slice(0, 12);

package/src/core/StackSummaryTable.test.ts

@@ -79,7 +79,7 @@ test("builds list of prs with selected emoji", () => {
   expect(output.split("\n")).toEqual([
     ...args.body.split("\n"),
     "",
-    "#### git stack",
+    "#### [git stack](https://github.com/magus/git-stack-cli)",
     "- 👉 `1` https://github.com/magus/git-multi-diff-playground/pull/43",
     "- ⏳ `2` https://github.com/magus/git-multi-diff-playground/pull/47",
   ]);
@@ -89,7 +89,7 @@ test("can parse stack table from body", () => {
   const body_line_list = [
     "",
     "",
-    "#### git stack",
+    "#### [git stack](https://github.com/magus/git-stack-cli)",
     "- invalid line that will be dropped",
     "- ⏳ `2` https://github.com/magus/git-multi-diff-playground/pull/47",
     "- 👉 `1` https://github.com/magus/git-multi-diff-playground/pull/43",
@@ -122,7 +122,7 @@ test("persists removed pr urls from previous stack table", () => {
     body: [
       "Summary of problem",
       "",
-      "#### git stack",
+      "#### [git stack](https://github.com/magus/git-stack-cli)",
       "- ⏳ `1` https://github.com/magus/git-multi-diff-playground/pull/43",
       "- ⏳ `2` https://github.com/magus/git-multi-diff-playground/pull/44",
       "- 👉 `3` https://github.com/magus/git-multi-diff-playground/pull/47",
@@ -142,7 +142,7 @@ test("persists removed pr urls from previous stack table", () => {
   expect(output.split("\n")).toEqual([
     "Summary of problem",
     "",
-    "#### git stack",
+    "#### [git stack](https://github.com/magus/git-stack-cli)",
     "- ✅ `1` https://github.com/magus/git-multi-diff-playground/pull/43",
     "- ✅ `2` https://github.com/magus/git-multi-diff-playground/pull/44",
     "- 👉 `3` https://github.com/magus/git-multi-diff-playground/pull/47",
@@ -155,3 +155,106 @@ test("persists removed pr urls from previous stack table", () => {
 
   expect(rerun_output).toBe(output);
 });
+
+test("persist only valid urls, removed broken branch ids from interrupted sync", () => {
+  const args = {
+    body: [
+      "Summary of problem",
+      "",
+      "#### [git stack](https://github.com/magus/git-stack-cli)",
+      "- ✅ `1` https://github.com/magus/git-multi-diff-playground/pull/43",
+      "- ✅ `2` gs-P4EBkJm+q",
+      "- 👉 `3` https://github.com/magus/git-multi-diff-playground/pull/47",
+    ].join("\n"),
+
+    pr_url_list: [
+      "https://github.com/magus/git-multi-diff-playground/pull/47",
+      "https://github.com/magus/git-multi-diff-playground/pull/54",
+      "https://github.com/magus/git-multi-diff-playground/pull/61",
+    ],
+
+    selected_url: "https://github.com/magus/git-multi-diff-playground/pull/47",
+  };
+
+  const output = StackSummaryTable.write(args);
+
+  expect(output.split("\n")).toEqual([
+    "Summary of problem",
+    "",
+    "#### [git stack](https://github.com/magus/git-stack-cli)",
+    "- ✅ `1` https://github.com/magus/git-multi-diff-playground/pull/43",
+    "- 👉 `2` https://github.com/magus/git-multi-diff-playground/pull/47",
+    "- ⏳ `3` https://github.com/magus/git-multi-diff-playground/pull/54",
+    "- ⏳ `4` https://github.com/magus/git-multi-diff-playground/pull/61",
+  ]);
+
+  // run again on the output to make sure it doesn't change
+  const rerun_output = StackSummaryTable.write({ ...args, body: output });
+
+  expect(rerun_output).toBe(output);
+});
+
+test("can parse legacy git stack", () => {
+  const body_line_list = [
+    "",
+    "",
+    "#### git stack",
+    "- invalid line that will be dropped",
+    "- ⏳ `2` https://github.com/magus/git-multi-diff-playground/pull/47",
+    "- 👉 `1` https://github.com/magus/git-multi-diff-playground/pull/43",
+  ];
+
+  const parsed = StackSummaryTable.parse(body_line_list.join("\n"));
+
+  expect(Array.from(parsed.entries())).toEqual([
+    [
+      "https://github.com/magus/git-multi-diff-playground/pull/47",
+      {
+        icon: "⏳",
+        num: "2",
+        pr_url: "https://github.com/magus/git-multi-diff-playground/pull/47",
+      },
+    ],
+    [
+      "https://github.com/magus/git-multi-diff-playground/pull/43",
+      {
+        icon: "👉",
+        num: "1",
+        pr_url: "https://github.com/magus/git-multi-diff-playground/pull/43",
+      },
+    ],
+  ]);
+});
+
+test("converts legacy git stack to link version", () => {
+  const args = {
+    body: [
+      "Summary of problem",
+      "",
+      "#### git stack",
+      "- ✅ `1` https://github.com/magus/git-multi-diff-playground/pull/43",
+      "- ✅ `2` gs-P4EBkJm+q",
+      "- 👉 `3` https://github.com/magus/git-multi-diff-playground/pull/47",
+    ].join("\n"),
+
+    pr_url_list: [
+      "https://github.com/magus/git-multi-diff-playground/pull/47",
+      "https://github.com/magus/git-multi-diff-playground/pull/54",
+      "https://github.com/magus/git-multi-diff-playground/pull/61",
+    ],
+
+    selected_url: "https://github.com/magus/git-multi-diff-playground/pull/47",
+  };
+
+  const output = StackSummaryTable.write(args);
+
+  expect(output.split("\n")).toEqual([
+    "Summary of problem",
+    "",
+    "#### [git stack](https://github.com/magus/git-stack-cli)",
+    "- ✅ `1` https://github.com/magus/git-multi-diff-playground/pull/43",
+    "- 👉 `2` https://github.com/magus/git-multi-diff-playground/pull/47",
+    "- ⏳ `3` https://github.com/magus/git-multi-diff-playground/pull/54",
+    "- ⏳ `4` https://github.com/magus/git-multi-diff-playground/pull/61",
+  ]);
+});

package/src/core/StackSummaryTable.ts

@@ -9,9 +9,12 @@ export function write(args: WriteArgs) {
 
   let result = args.body;
 
-  if (RE.stack_table.test(result)) {
+  if (RE.stack_table_link.test(result)) {
     // replace stack table
-    result = result.replace(RE.stack_table, stack_table);
+    result = result.replace(RE.stack_table_link, stack_table);
+  } else if (RE.stack_table_legacy.test(result)) {
+    // replace stack table
+    result = result.replace(RE.stack_table_legacy, stack_table);
   } else {
     // append stack table
     result = `${result}\n\n${stack_table}`;
@@ -64,11 +67,15 @@ export function table(args: WriteArgs) {
     return "";
   }
 
-  return TEMPLATE.stack_table(["", ...stack_list, "", ""].join("\n"));
+  return TEMPLATE.stack_table_link(["", ...stack_list, "", ""].join("\n"));
 }
 
 export function parse(body: string): Map<string, StackTableRow> {
-  const stack_table_match = body.match(RE.stack_table);
+  let stack_table_match = body.match(RE.stack_table_link);
+
+  if (!stack_table_match?.groups) {
+    stack_table_match = body.match(RE.stack_table_legacy);
+  }
 
   if (!stack_table_match?.groups) {
     return new Map();
@@ -88,6 +95,10 @@ export function parse(body: string): Map<string, StackTableRow> {
       continue;
     }
 
+    if (!RE.pr_url.test(parsed_row.pr_url)) {
+      continue;
+    }
+
     result.set(parsed_row.pr_url, parsed_row);
   }
 
@@ -95,10 +106,14 @@ export function parse(body: string): Map<string, StackTableRow> {
 }
 
 const TEMPLATE = {
-  stack_table(rows: string) {
+  stack_table_legacy(rows: string) {
     return `#### git stack${rows}`;
   },
 
+  stack_table_link(rows: string) {
+    return `#### [git stack](https://github.com/magus/git-stack-cli)${rows}`;
+  },
+
   row(args: StackTableRow) {
     return `- ${args.icon} \`${args.num}\` ${args.pr_url}`;
   },
@@ -106,8 +121,17 @@ const TEMPLATE = {
 
 const RE = {
   // https://regex101.com/r/kqB9Ft/1
-  stack_table: new RegExp(
-    TEMPLATE.stack_table("\\s+(?<rows>(?:- [^\r^\n]*(?:[\r\n]+)?)+)")
+  stack_table_legacy: new RegExp(
+    TEMPLATE.stack_table_legacy("\\s+(?<rows>(?:- [^\r^\n]*(?:[\r\n]+)?)+)")
+  ),
+
+  stack_table_link: new RegExp(
+    TEMPLATE.stack_table_link("ROWS")
+      .replace("[", "\\[")
+      .replace("]", "\\]")
+      .replace("(", "\\(")
+      .replace(")", "\\)")
+      .replace("ROWS", "\\s+(?<rows>(?:- [^\r^\n]*(?:[\r\n]+)?)+)")
   ),
 
   row: new RegExp(
@@ -117,6 +141,8 @@ const RE = {
       pr_url: "(?<pr_url>.+)",
     })
   ),
+
+  pr_url: /^https:\/\/.*$/,
 };
 
 type StackTableRow = {