git-stack-cli 1.13.1 → 1.14.0

package/README.md

@@ -83,6 +83,19 @@ To update your local branch with the latest changes in the remote branch (e.g. `
 git stack rebase
 ```
 
+### Customizing branch name
+
+By default `git stack` generates a unique branch name such as `gs-3cmrMBSUj`.
+
+You can specify a prefix for the generated branch name by using either the environment variable or the command line option.
+In the example below branches would be generated such as `dev/magus/gs-3cmrMBSUj`.
+
+```bash
+GIT_STACK_BRANCH_PREFIX="dev/magus/" git stack
+
+git stack --branch-prefix="dev/magus/"
+```
+
 ## Why?
 
 The goal of `git stack` is to combine the **simplicity of developing in a single branch** in order to **preserve your commit history** while also **grouping commits into pull requests for code review**.

package/dist/cjs/index.cjs

@@ -14912,7 +14912,7 @@ var isSafeInteger = hasNativeIsSafeInteger
 // IE11 does not support y and u.
 var REGEX_SUPPORTS_U_AND_Y = true;
 try {
-    var re = RE$5('([^\\p{White_Space}\\p{Pattern_Syntax}]*)', 'yu');
+    var re = RE$6('([^\\p{White_Space}\\p{Pattern_Syntax}]*)', 'yu');
     /**
      * legacy Edge or Xbox One browser
      * Unicode flag support: supported
@@ -15009,14 +15009,14 @@ var trimEnd = hasTrimEnd
             return s.replace(SPACE_SEPARATOR_END_REGEX, '');
         };
 // Prevent minifier to translate new RegExp to literal form that might cause syntax error on IE11.
-function RE$5(s, flag) {
+function RE$6(s, flag) {
     return new RegExp(s, flag);
 }
 // #endregion
 var matchIdentifierAtIndex;
 if (REGEX_SUPPORTS_U_AND_Y) {
     // Native
-    var IDENTIFIER_PREFIX_RE_1 = RE$5('([^\\p{White_Space}\\p{Pattern_Syntax}]*)', 'yu');
+    var IDENTIFIER_PREFIX_RE_1 = RE$6('([^\\p{White_Space}\\p{Pattern_Syntax}]*)', 'yu');
     matchIdentifierAtIndex = function matchIdentifierAtIndex(s, index) {
         var _a;
         IDENTIFIER_PREFIX_RE_1.lastIndex = index;
@@ -26941,15 +26941,15 @@ match_group.safe = (value, re, group) => {
 
 function auth_status(output) {
     let username;
-    username = match_group.safe(output, RE$4.logged_in_as, "username");
+    username = match_group.safe(output, RE$5.logged_in_as, "username");
     if (username)
         return username;
-    username = match_group.safe(output, RE$4.logged_in_account, "username");
+    username = match_group.safe(output, RE$5.logged_in_account, "username");
     if (username)
         return username;
     return null;
 }
-const RE$4 = {
+const RE$5 = {
     // Logged in to github.com as magus
     logged_in_as: /Logged in to github.com as (?<username>[^\s]+)/,
     logged_in_account: /Logged in to github.com account (?<username>[^\s]+)/,
@@ -29663,10 +29663,10 @@ var cloneDeep$1 = /*@__PURE__*/getDefaultExportFromCjs(cloneDeep_1);
 // escape double-quote for cli
 function safe_quote(value) {
     let result = value;
-    result = result.replace(RE$3.all_double_quote, '\\"');
+    result = result.replace(RE$4.all_double_quote, '\\"');
     return result;
 }
-const RE$3 = {
+const RE$4 = {
     all_double_quote: /"/g,
 };
 
@@ -29684,12 +29684,12 @@ function write$1(message, values) {
 }
 function read(message) {
     const values = { id: null, title: null };
-    const match_id = message.match(RE$2.stack_id);
+    const match_id = message.match(RE$3.stack_id);
     if (match_id?.groups) {
         values.id = match_id.groups["id"];
         invariant(values.id, "id must exist");
     }
-    const match_title = message.match(RE$2.group_title);
+    const match_title = message.match(RE$3.group_title);
     if (match_title?.groups) {
         values.title = match_title.groups["title"];
     }
@@ -29698,8 +29698,8 @@ function read(message) {
 function remove(message) {
     let result = message;
     // remove metadata
-    result = result.replace(new RegExp(RE$2.stack_id, "gmi"), "");
-    result = result.replace(new RegExp(RE$2.group_title, "gmi"), "");
+    result = result.replace(new RegExp(RE$3.stack_id, "gmi"), "");
+    result = result.replace(new RegExp(RE$3.group_title, "gmi"), "");
     result = result.trimEnd();
     return result;
 }
@@ -29711,7 +29711,7 @@ const TEMPLATE$1 = {
         return `git-stack-title: ${title}`;
     },
 };
-const RE$2 = {
+const RE$3 = {
     // https://regex101.com/r/wLmGVq/1
     stack_id: new RegExp(`${TEMPLATE$1.stack_id("(?<id>[^\\s]+)")}`, "i"),
     group_title: new RegExp(TEMPLATE$1.group_title("(?<title>[^\\n^\\r]+)"), "i"),
@@ -29782,11 +29782,23 @@ async function pr_status(branch) {
 }
 async function pr_create(args) {
     const title = safe_quote(args.title);
-    let command = `gh pr create --fill --head ${args.branch} --base ${args.base} --title="${title}" --body="${args.body}"`;
+    // explicit refs/heads head branch to avoid creation failing
+    //
+    //   ❯ gh pr create --head origin/gs-ED2etrzv2 --base gs-6LAx-On45 --title="2024-01-05 test" --body=""
+    //   pull request create failed: GraphQL: Head sha can't be blank, Base sha can't be blank, No commits between gs-6LAx-On45 and origin/gs-ED2etrzv2, Head ref must be a branch (createPullRequest)
+    //
+    // https://github.com/cli/cli/issues/5465
+    let command_parts = [
+        "gh pr create",
+        `--head refs/heads/${args.branch}`,
+        `--base ${args.base}`,
+        `--title="${title}"`,
+        `--body="${args.body}"`,
+    ];
     if (args.draft) {
-        command += " --draft";
+        command_parts.push("--draft");
     }
-    const cli_result = await cli(command);
+    const cli_result = await cli(command_parts);
     if (cli_result.code !== 0) {
         handle_error(cli_result.output);
         return null;
@@ -29799,8 +29811,7 @@ async function pr_edit(args) {
         const body_file = await write_body_file(args);
         command_parts.push(`--body-file="${body_file}"`);
     }
-    const command = command_parts.join(" ");
-    const cli_result = await cli(command);
+    const cli_result = await cli(command_parts);
     if (cli_result.code !== 0) {
         handle_error(cli_result.output);
     }
@@ -29867,11 +29878,19 @@ function handle_error(output) {
 async function write_body_file(args) {
     invariant(args.body, "args.body must exist");
     const temp_dir = os.tmpdir();
-    const temp_path = path.join(temp_dir, `git-stack-body-${args.base}`);
+    // ensure unique filename is safe for filesystem
+    // base (group id) might contain slashes, e.g. dev/magus/gs-3cmrMBSUj
+    // the flashes would mess up the filesystem path to this file
+    let temp_filename = `git-stack-body-${args.base}`;
+    temp_filename = temp_filename.replace(RE$2.non_alphanumeric_dash, "-");
+    const temp_path = path.join(temp_dir, temp_filename);
     await safe_rm(temp_path);
     await fs$1.writeFile(temp_path, args.body);
     return temp_path;
 }
+const RE$2 = {
+    non_alphanumeric_dash: /[^a-zA-Z0-9_-]+/g,
+};
 
 async function range(commit_group_map) {
     const master_branch = Store.getState().master_branch;
@@ -31528,8 +31547,20 @@ function SelectCommitRangesInternal(props) {
             reactExports.createElement(FormatText, { wrapper: reactExports.createElement(Text, { color: colors.gray }), message: "Press {enter} to toggle commit selection", values: {
                     enter: (reactExports.createElement(Text, { bold: true, color: colors.green }, SYMBOL.enter)),
                 } }))));
+    function get_group_id() {
+        let branch_prefix = "";
+        // branch prefix via cli flag or env var
+        // cli flag takes precedence since it is more explicit
+        if (argv["branch-prefix"]) {
+            branch_prefix = argv["branch-prefix"];
+        }
+        else if (process.env.GIT_STACK_BRANCH_PREFIX) {
+            branch_prefix = process.env.GIT_STACK_BRANCH_PREFIX;
+        }
+        return `${branch_prefix}${gs_short_id()}`;
+    }
     function submit_group_input(title) {
-        const id = gs_short_id();
+        const id = get_group_id();
         actions.output(reactExports.createElement(FormatText, { wrapper: reactExports.createElement(Text, { dimColor: true }), message: "Created new group {group} {note}", values: {
                 group: reactExports.createElement(Brackets, null, title),
                 note: reactExports.createElement(Parens, null, id),
@@ -31782,7 +31813,6 @@ async function run$3(args) {
             before_push_tasks.push(before_push({ group }));
         }
         await Promise.all(before_push_tasks);
-        // git push -f origin HEAD~6:OtVX7Qvrw HEAD~3:E63ytp5dj HEAD~2:gs-NBabNSjXA HEAD~1:gs-UGVJdKNoD HEAD~0:gs-6LAx-On4
         const git_push_command = [`git push -f origin`];
         if (argv.verify === false) {
             git_push_command.push("--no-verify");
@@ -31790,7 +31820,24 @@ async function run$3(args) {
         for (const group of push_group_list) {
             const last_commit = last$1(group.commits);
             invariant(last_commit, "last_commit must exist");
-            const target = `${last_commit.sha}:${group.id}`;
+            // explicit refs/heads head branch to avoid push failing
+            //
+            //   ❯ git push -f origin --no-verify f6e249051b4820a03deb957ddebc19acfd7dfd7c:gs-ED2etrzv2
+            //   error: The destination you provided is not a full refname (i.e.,
+            //   starting with "refs/"). We tried to guess what you meant by:
+            //
+            //   - Looking for a ref that matches 'gs-ED2etrzv2' on the remote side.
+            //   - Checking if the <src> being pushed ('f6e249051b4820a03deb957ddebc19acfd7dfd7c')
+            //     is a ref in "refs/{heads,tags}/". If so we add a corresponding
+            //     refs/{heads,tags}/ prefix on the remote side.
+            //
+            //   Neither worked, so we gave up. You must fully qualify the ref.
+            //   hint: The <src> part of the refspec is a commit object.
+            //   hint: Did you mean to create a new branch by pushing to
+            //   hint: 'f6e249051b4820a03deb957ddebc19acfd7dfd7c:refs/heads/gs-ED2etrzv2'?
+            //   error: failed to push some refs to 'github.com:magus/git-multi-diff-playground.git'
+            //
+            const target = `${last_commit.sha}:refs/heads/${group.id}`;
             git_push_command.push(target);
         }
         await cli(git_push_command);
@@ -37573,7 +37620,7 @@ async function command() {
         .wrap(123)
         // disallow unknown options
         .strict()
-        .version("1.13.1" )
+        .version("1.14.0" )
         .showHidden("show-hidden", "Show hidden options via `git stack help --show-hidden`")
         .help("help", "Show usage via `git stack help`")
         .argv;
@@ -37627,17 +37674,22 @@ const DefaultOptions = {
         default: false,
         description: "Open all PRs as drafts",
     },
-    "write-state-json": {
-        hidden: true,
-        type: "boolean",
-        default: false,
-        description: "Write state to local json file for debugging",
+    "branch-prefix": {
+        type: "string",
+        default: "",
+        description: "Prefix for generated branch names, e.g. dev/magus/",
     },
     "template": {
         type: "boolean",
         default: true,
         description: "Use automatic Github PR template, e.g. .github/pull_request_template.md, disable with --no-template",
     },
+    "write-state-json": {
+        hidden: true,
+        type: "boolean",
+        default: false,
+        description: "Write state to local json file for debugging",
+    },
     "mock-metadata": {
         hidden: true,
         type: "boolean",

package/package.json

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

package/src/app/SelectCommitRanges.tsx

@@ -387,8 +387,21 @@ function SelectCommitRangesInternal(props: Props) {
     </Ink.Box>
   );
 
+  function get_group_id() {
+    let branch_prefix = "";
+
+    // branch prefix via cli flag or env var
+    // cli flag takes precedence since it is more explicit
+    if (argv["branch-prefix"]) {
+      branch_prefix = argv["branch-prefix"];
+    } else if (process.env.GIT_STACK_BRANCH_PREFIX) {
+      branch_prefix = process.env.GIT_STACK_BRANCH_PREFIX;
+    }
+
+    return `${branch_prefix}${gs_short_id()}`;
+  }
   function submit_group_input(title: string) {
-    const id = gs_short_id();
+    const id = get_group_id();
 
     actions.output(
       <FormatText

package/src/app/SyncGithub.tsx

@@ -93,8 +93,6 @@ async function run(args: Args) {
 
     await Promise.all(before_push_tasks);
 
-    // git push -f origin HEAD~6:OtVX7Qvrw HEAD~3:E63ytp5dj HEAD~2:gs-NBabNSjXA HEAD~1:gs-UGVJdKNoD HEAD~0:gs-6LAx-On4
-
     const git_push_command = [`git push -f origin`];
 
     if (argv.verify === false) {
@@ -104,7 +102,25 @@ async function run(args: Args) {
     for (const group of push_group_list) {
       const last_commit = last(group.commits);
       invariant(last_commit, "last_commit must exist");
-      const target = `${last_commit.sha}:${group.id}`;
+
+      // explicit refs/heads head branch to avoid push failing
+      //
+      //   ❯ git push -f origin --no-verify f6e249051b4820a03deb957ddebc19acfd7dfd7c:gs-ED2etrzv2
+      //   error: The destination you provided is not a full refname (i.e.,
+      //   starting with "refs/"). We tried to guess what you meant by:
+      //
+      //   - Looking for a ref that matches 'gs-ED2etrzv2' on the remote side.
+      //   - Checking if the <src> being pushed ('f6e249051b4820a03deb957ddebc19acfd7dfd7c')
+      //     is a ref in "refs/{heads,tags}/". If so we add a corresponding
+      //     refs/{heads,tags}/ prefix on the remote side.
+      //
+      //   Neither worked, so we gave up. You must fully qualify the ref.
+      //   hint: The <src> part of the refspec is a commit object.
+      //   hint: Did you mean to create a new branch by pushing to
+      //   hint: 'f6e249051b4820a03deb957ddebc19acfd7dfd7c:refs/heads/gs-ED2etrzv2'?
+      //   error: failed to push some refs to 'github.com:magus/git-multi-diff-playground.git'
+      //
+      const target = `${last_commit.sha}:refs/heads/${group.id}`;
       git_push_command.push(target);
     }
 

package/src/command.ts

@@ -111,11 +111,10 @@ const DefaultOptions = {
     description: "Open all PRs as drafts",
   },
 
-  "write-state-json": {
-    hidden: true,
-    type: "boolean",
-    default: false,
-    description: "Write state to local json file for debugging",
+  "branch-prefix": {
+    type: "string",
+    default: "",
+    description: "Prefix for generated branch names, e.g. dev/magus/",
   },
 
   "template": {
@@ -125,6 +124,13 @@ const DefaultOptions = {
       "Use automatic Github PR template, e.g. .github/pull_request_template.md, disable with --no-template",
   },
 
+  "write-state-json": {
+    hidden: true,
+    type: "boolean",
+    default: false,
+    description: "Write state to local json file for debugging",
+  },
+
   "mock-metadata": {
     hidden: true,
     type: "boolean",

package/src/core/github.tsx

@@ -123,13 +123,26 @@ type CreatePullRequestArgs = {
 
 export async function pr_create(args: CreatePullRequestArgs) {
   const title = safe_quote(args.title);
-  let command = `gh pr create --fill --head ${args.branch} --base ${args.base} --title="${title}" --body="${args.body}"`;
+
+  // explicit refs/heads head branch to avoid creation failing
+  //
+  //   ❯ gh pr create --head origin/gs-ED2etrzv2 --base gs-6LAx-On45 --title="2024-01-05 test" --body=""
+  //   pull request create failed: GraphQL: Head sha can't be blank, Base sha can't be blank, No commits between gs-6LAx-On45 and origin/gs-ED2etrzv2, Head ref must be a branch (createPullRequest)
+  //
+  // https://github.com/cli/cli/issues/5465
+  let command_parts = [
+    "gh pr create",
+    `--head refs/heads/${args.branch}`,
+    `--base ${args.base}`,
+    `--title="${title}"`,
+    `--body="${args.body}"`,
+  ];
 
   if (args.draft) {
-    command += " --draft";
+    command_parts.push("--draft");
   }
 
-  const cli_result = await cli(command);
+  const cli_result = await cli(command_parts);
 
   if (cli_result.code !== 0) {
     handle_error(cli_result.output);
@@ -153,9 +166,7 @@ export async function pr_edit(args: EditPullRequestArgs) {
     command_parts.push(`--body-file="${body_file}"`);
   }
 
-  const command = command_parts.join(" ");
-
-  const cli_result = await cli(command);
+  const cli_result = await cli(command_parts);
 
   if (cli_result.code !== 0) {
     handle_error(cli_result.output);
@@ -247,7 +258,14 @@ async function write_body_file(args: EditPullRequestArgs) {
   invariant(args.body, "args.body must exist");
 
   const temp_dir = os.tmpdir();
-  const temp_path = path.join(temp_dir, `git-stack-body-${args.base}`);
+
+  // ensure unique filename is safe for filesystem
+  // base (group id) might contain slashes, e.g. dev/magus/gs-3cmrMBSUj
+  // the flashes would mess up the filesystem path to this file
+  let temp_filename = `git-stack-body-${args.base}`;
+  temp_filename = temp_filename.replace(RE.non_alphanumeric_dash, "-");
+
+  const temp_path = path.join(temp_dir, temp_filename);
 
   await safe_rm(temp_path);
 
@@ -284,3 +302,7 @@ export type PullRequest = {
   url: string;
   isDraft: boolean;
 };
+
+const RE = {
+  non_alphanumeric_dash: /[^a-zA-Z0-9_-]+/g,
+};

package/src/types/global.d.ts

@@ -5,5 +5,6 @@ declare namespace NodeJS {
     CLI_VERSION?: string;
     GIT_STACK_STANDALONE?: "true" | "false";
     GIT_SEQUENCE_EDITOR_SCRIPT?: string;
+    GIT_STACK_BRANCH_PREFIX?: string;
   }
 }