git-stack-cli 1.6.2 → 1.8.0

package/dist/cjs/index.cjs

@@ -17694,7 +17694,7 @@ function YesNoPrompt(props) {
                 n));
     }
     return (reactExports.createElement(Box, { flexDirection: "column" },
-        reactExports.createElement(Box, null,
+        reactExports.createElement(Box, { alignItems: "flex-end" },
             typeof props.message === "object" ? (props.message) : (reactExports.createElement(Text, { color: colors.yellow }, props.message)),
             reactExports.createElement(Text, null, " "),
             reactExports.createElement(Parens, null,
@@ -26209,6 +26209,8 @@ const BaseStore = createStore()(immer((set, get) => ({
     branch_name: null,
     commit_range: null,
     commit_map: null,
+    pr_templates: [],
+    pr_template_body: null,
     step: "loading",
     output: [],
     pending_output: {},
@@ -27040,10 +27042,15 @@ function DirtyCheck(props) {
         case "done":
             return props.children;
         case "prompt":
-            return (reactExports.createElement(YesNoPrompt, { message: reactExports.createElement(FormatText, { wrapper: reactExports.createElement(Text, { color: colors.yellow }), message: "{git} repo is dirty, changed may be lost during {git_stack}, are you sure you wannt to proceed?", values: {
-                        git: reactExports.createElement(Command, null, "git"),
-                        git_stack: reactExports.createElement(Command, null, "git stack"),
-                    } }), onYes: async () => {
+            return (reactExports.createElement(YesNoPrompt, { message: reactExports.createElement(Box, { flexDirection: "column" },
+                    reactExports.createElement(FormatText, { wrapper: reactExports.createElement(Text, { color: colors.yellow }), message: "{git} repo has uncommitted changes.", values: {
+                            git: reactExports.createElement(Command, null, "git"),
+                            git_stack: reactExports.createElement(Command, null, "git stack"),
+                        } }),
+                    reactExports.createElement(FormatText, { wrapper: reactExports.createElement(Text, { color: colors.yellow }), message: "Changes may be lost during {git_stack}, are you sure you want to proceed?", values: {
+                            git: reactExports.createElement(Command, null, "git"),
+                            git_stack: reactExports.createElement(Command, null, "git stack"),
+                        } })), onYes: async () => {
                     patch({ status: "done" });
                 }, onNo: async () => {
                     actions.exit(0);
@@ -27171,9 +27178,9 @@ function format_time(date) {
 }
 
 function GithubApiError() {
-    return reactExports.createElement(Await, { fallback: null, function: run$4 });
+    return reactExports.createElement(Await, { fallback: null, function: run$5 });
 }
-async function run$4() {
+async function run$5() {
     const actions = Store.getState().actions;
     const res = await cli(`gh api https://api.github.com/rate_limit`);
     const res_json = JSON.parse(res.stdout);
@@ -27340,7 +27347,11 @@ async function pr_status(branch) {
 }
 async function pr_create(args) {
     const title = safe_quote(args.title);
-    const cli_result = await cli(`gh pr create --fill --head ${args.branch} --base ${args.base} --title="${title}" --body="${args.body}"`);
+    let command = `gh pr create --fill --head ${args.branch} --base ${args.base} --title="${title}" --body="${args.body}"`;
+    if (args.draft) {
+        command += " --draft";
+    }
+    const cli_result = await cli(command);
     if (cli_result.code !== 0) {
         handle_error(cli_result.output);
         return null;
@@ -27630,9 +27641,9 @@ function encode(value) {
 }
 
 function LocalMergeRebase() {
-    return (reactExports.createElement(Await, { fallback: reactExports.createElement(Text, { color: colors.yellow }, "Rebasing commits\u2026"), function: run$3 }));
+    return (reactExports.createElement(Await, { fallback: reactExports.createElement(Text, { color: colors.yellow }, "Rebasing commits\u2026"), function: run$4 }));
 }
-async function run$3() {
+async function run$4() {
     const state = Store.getState();
     const actions = state.actions;
     const branch_name = state.branch_name;
@@ -27922,9 +27933,9 @@ const RE = {
 };
 
 function ManualRebase() {
-    return (reactExports.createElement(Await, { fallback: reactExports.createElement(Text, { color: colors.yellow }, "Rebasing commits\u2026"), function: run$2 }));
+    return (reactExports.createElement(Await, { fallback: reactExports.createElement(Text, { color: colors.yellow }, "Rebasing commits\u2026"), function: run$3 }));
 }
-async function run$2() {
+async function run$3() {
     const state = Store.getState();
     const actions = state.actions;
     const argv = state.argv;
@@ -27938,6 +27949,10 @@ async function run$2() {
     invariant(repo_root, "repo_root must exist");
     // always listen for SIGINT event and restore git state
     process.once("SIGINT", handle_exit);
+    let DEFAULT_PR_BODY = "";
+    if (state.pr_template_body) {
+        DEFAULT_PR_BODY = state.pr_template_body;
+    }
     const temp_branch_name = `${branch_name}_${short_id()}`;
     const commit_range = await range(commit_map);
     // reverse commit list so that we can cherry-pick in order
@@ -28163,7 +28178,8 @@ echo "$GIT_REVISE_TODO" > "$git_revise_todo_path"
                 branch: group.id,
                 base: group.base,
                 title: group.title,
-                body: "",
+                body: DEFAULT_PR_BODY,
+                draft: argv.draft,
             });
             if (!pr_url) {
                 throw new Error("unable to create pr");
@@ -28190,7 +28206,7 @@ echo "$GIT_REVISE_TODO" > "$git_revise_todo_path"
             // use the updated pr_url_list to get the actual selected_url
             const selected_url = pr_url_list[i];
             invariant(group.base, "group.base must exist");
-            const body = group.pr?.body || "";
+            const body = group.pr?.body || DEFAULT_PR_BODY;
             const update_body = write({
                 body,
                 pr_url_list,
@@ -28430,9 +28446,9 @@ function get_status_bold(row) {
 }
 
 function PostRebaseStatus() {
-    return reactExports.createElement(Await, { fallback: null, function: run$1 });
+    return reactExports.createElement(Await, { fallback: null, function: run$2 });
 }
-async function run$1() {
+async function run$2() {
     const actions = Store.getState().actions;
     // reset github pr cache before refreshing via commit range below
     actions.reset_pr();
@@ -28461,6 +28477,65 @@ function PreLocalMergeRebase() {
         }, onNo: () => actions.exit(0) }));
 }
 
+function PreManualRebase() {
+    return reactExports.createElement(Await, { fallback: null, function: run$1 });
+}
+async function run$1() {
+    const state = Store.getState();
+    const actions = state.actions;
+    const repo_root = state.repo_root;
+    const argv = state.argv;
+    invariant(repo_root, "repo_root must exist");
+    invariant(argv, "argv must exist");
+    if (!argv.template) {
+        return actions.set((state) => {
+            state.step = "manual-rebase";
+        });
+    }
+    let pr_template_body = null;
+    // look for pull request template
+    // https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository
+    // ./.github/pull_request_template.md
+    // ./pull_request_template.md
+    // ./docs/pull_request_template.md
+    for (const key of PR_TEMPLATE_KEY_LIST) {
+        const pr_template_fn = PR_TEMPLATE[key];
+        if (fs.existsSync(pr_template_fn(repo_root))) {
+            pr_template_body = fs.readFileSync(pr_template_fn(repo_root), "utf-8");
+            actions.output(reactExports.createElement(FormatText, { wrapper: reactExports.createElement(Text, { color: colors.yellow }), message: "Using PR template {pr_filepath}", values: {
+                    pr_filepath: reactExports.createElement(Brackets, null, pr_template_fn("")),
+                } }));
+            break;
+        }
+    }
+    // ./.github/PULL_REQUEST_TEMPLATE/*.md
+    let pr_templates = [];
+    if (fs.existsSync(PR_TEMPLATE.TemplateDir(repo_root))) {
+        pr_templates = fs.readdirSync(PR_TEMPLATE.TemplateDir(repo_root));
+    }
+    // check if repo has multiple pr templates
+    actions.set((state) => {
+        state.pr_template_body = pr_template_body;
+        state.pr_templates = pr_templates;
+        if (pr_templates.length > 0) {
+            actions.output(reactExports.createElement(FormatText, { wrapper: reactExports.createElement(Text, { color: colors.yellow }), message: "{count} queryable templates found under {dir}, but not supported.", values: {
+                    count: (reactExports.createElement(Text, { color: colors.blue }, pr_templates.length)),
+                    dir: reactExports.createElement(Brackets, null, PR_TEMPLATE.TemplateDir("")),
+                } }));
+        }
+        state.step = "manual-rebase";
+    });
+}
+// prettier-ignore
+const PR_TEMPLATE = Object.freeze({
+    Github: (root) => path.join(root, ".github", "pull_request_template.md"),
+    Root: (root) => path.join(root, "pull_request_template.md"),
+    Docs: (root) => path.join(root, "docs", "pull_request_template.md"),
+    TemplateDir: (root) => path.join(root, ".github", "PULL_REQUEST_TEMPLATE"),
+});
+// prettier-ignore
+const PR_TEMPLATE_KEY_LIST = Object.keys(PR_TEMPLATE);
+
 function PreSelectCommitRanges() {
     const actions = Store.useActions();
     const argv = Store.useState((state) => state.argv);
@@ -28776,7 +28851,7 @@ function SelectCommitRangesInternal(props) {
                 }
                 switch (inputLower) {
                     case "s":
-                        state.step = "manual-rebase";
+                        state.step = "pre-manual-rebase";
                         break;
                 }
             });
@@ -28975,6 +29050,8 @@ function Main() {
             return reactExports.createElement(PreSelectCommitRanges, null);
         case "select-commit-ranges":
             return reactExports.createElement(SelectCommitRanges, null);
+        case "pre-manual-rebase":
+            return reactExports.createElement(PreManualRebase, null);
         case "manual-rebase":
             return reactExports.createElement(ManualRebase, null);
         case "post-rebase-status":
@@ -34443,12 +34520,23 @@ async function command() {
         type: "string",
         alias: ["b"],
         description: 'Set the master branch name, defaults to "master" (or "main" if "master" is not found)',
+    })
+        .option("draft", {
+        type: "boolean",
+        alias: ["d"],
+        default: false,
+        description: "Open all PRs as drafts",
     })
         .option("write-state-json", {
         hidden: true,
         type: "boolean",
         default: false,
         description: "Write state to local json file for debugging",
+    })
+        .option("template", {
+        type: "boolean",
+        default: true,
+        description: "Use automatic Github PR template, e.g. .github/pull_request_template.md, disable with --no-template",
     })
         .option("mock-metadata", {
         hidden: true,
@@ -34462,7 +34550,7 @@ async function command() {
         .wrap(123)
         // disallow unknown options
         .strict()
-        .version("1.6.2" )
+        .version("1.8.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.6.2",
+  "version": "1.8.0",
   "description": "",
   "author": "magus",
   "license": "MIT",

package/src/app/DirtyCheck.tsx

@@ -37,14 +37,24 @@ export function DirtyCheck(props: Props) {
       return (
         <YesNoPrompt
           message={
-            <FormatText
-              wrapper={<Ink.Text color={colors.yellow} />}
-              message="{git} repo is dirty, changed may be lost during {git_stack}, are you sure you wannt to proceed?"
-              values={{
-                git: <Command>git</Command>,
-                git_stack: <Command>git stack</Command>,
-              }}
-            />
+            <Ink.Box flexDirection="column">
+              <FormatText
+                wrapper={<Ink.Text color={colors.yellow} />}
+                message="{git} repo has uncommitted changes."
+                values={{
+                  git: <Command>git</Command>,
+                  git_stack: <Command>git stack</Command>,
+                }}
+              />
+              <FormatText
+                wrapper={<Ink.Text color={colors.yellow} />}
+                message="Changes may be lost during {git_stack}, are you sure you want to proceed?"
+                values={{
+                  git: <Command>git</Command>,
+                  git_stack: <Command>git stack</Command>,
+                }}
+              />
+            </Ink.Box>
           }
           onYes={async () => {
             patch({ status: "done" });

package/src/app/Main.tsx

@@ -5,6 +5,7 @@ import { LocalMergeRebase } from "~/app/LocalMergeRebase";
 import { ManualRebase } from "~/app/ManualRebase";
 import { PostRebaseStatus } from "~/app/PostRebaseStatus";
 import { PreLocalMergeRebase } from "~/app/PreLocalMergeRebase";
+import { PreManualRebase } from "~/app/PreManualRebase";
 import { PreSelectCommitRanges } from "~/app/PreSelectCommitRanges";
 import { SelectCommitRanges } from "~/app/SelectCommitRanges";
 import { Status } from "~/app/Status";
@@ -36,6 +37,9 @@ export function Main() {
     case "select-commit-ranges":
       return <SelectCommitRanges />;
 
+    case "pre-manual-rebase":
+      return <PreManualRebase />;
+
     case "manual-rebase":
       return <ManualRebase />;
 

package/src/app/ManualRebase.tsx

@@ -46,6 +46,11 @@ async function run() {
   // always listen for SIGINT event and restore git state
   process.once("SIGINT", handle_exit);
 
+  let DEFAULT_PR_BODY = "";
+  if (state.pr_template_body) {
+    DEFAULT_PR_BODY = state.pr_template_body;
+  }
+
   const temp_branch_name = `${branch_name}_${short_id()}`;
 
   const commit_range = await CommitMetadata.range(commit_map);
@@ -328,7 +333,8 @@ async function run() {
         branch: group.id,
         base: group.base,
         title: group.title,
-        body: "",
+        body: DEFAULT_PR_BODY,
+        draft: argv.draft,
       });
 
       if (!pr_url) {
@@ -363,7 +369,7 @@ async function run() {
 
       invariant(group.base, "group.base must exist");
 
-      const body = group.pr?.body || "";
+      const body = group.pr?.body || DEFAULT_PR_BODY;
 
       const update_body = StackSummaryTable.write({
         body,

package/src/app/PreManualRebase.tsx

@@ -0,0 +1,100 @@
+import * as React from "react";
+
+import fs from "node:fs";
+import path from "node:path";
+
+import * as Ink from "ink-cjs";
+
+import { Await } from "~/app/Await";
+import { Brackets } from "~/app/Brackets";
+import { FormatText } from "~/app/FormatText";
+import { Store } from "~/app/Store";
+import { colors } from "~/core/colors";
+import { invariant } from "~/core/invariant";
+
+export function PreManualRebase() {
+  return <Await fallback={null} function={run} />;
+}
+
+async function run() {
+  const state = Store.getState();
+  const actions = state.actions;
+  const repo_root = state.repo_root;
+  const argv = state.argv;
+
+  invariant(repo_root, "repo_root must exist");
+  invariant(argv, "argv must exist");
+
+  if (!argv.template) {
+    return actions.set((state) => {
+      state.step = "manual-rebase";
+    });
+  }
+
+  let pr_template_body: null | string = null;
+
+  // look for pull request template
+  // https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository
+  // ./.github/pull_request_template.md
+  // ./pull_request_template.md
+  // ./docs/pull_request_template.md
+  for (const key of PR_TEMPLATE_KEY_LIST) {
+    const pr_template_fn = PR_TEMPLATE[key as keyof typeof PR_TEMPLATE];
+
+    if (fs.existsSync(pr_template_fn(repo_root))) {
+      pr_template_body = fs.readFileSync(pr_template_fn(repo_root), "utf-8");
+
+      actions.output(
+        <FormatText
+          wrapper={<Ink.Text color={colors.yellow} />}
+          message="Using PR template {pr_filepath}"
+          values={{
+            pr_filepath: <Brackets>{pr_template_fn("")}</Brackets>,
+          }}
+        />
+      );
+
+      break;
+    }
+  }
+
+  // ./.github/PULL_REQUEST_TEMPLATE/*.md
+  let pr_templates: Array<string> = [];
+  if (fs.existsSync(PR_TEMPLATE.TemplateDir(repo_root))) {
+    pr_templates = fs.readdirSync(PR_TEMPLATE.TemplateDir(repo_root));
+  }
+
+  // check if repo has multiple pr templates
+  actions.set((state) => {
+    state.pr_template_body = pr_template_body;
+    state.pr_templates = pr_templates;
+
+    if (pr_templates.length > 0) {
+      actions.output(
+        <FormatText
+          wrapper={<Ink.Text color={colors.yellow} />}
+          message="{count} queryable templates found under {dir}, but not supported."
+          values={{
+            count: (
+              <Ink.Text color={colors.blue}>{pr_templates.length}</Ink.Text>
+            ),
+            dir: <Brackets>{PR_TEMPLATE.TemplateDir("")}</Brackets>,
+          }}
+        />
+      );
+    }
+
+    state.step = "manual-rebase";
+  });
+}
+
+// prettier-ignore
+const PR_TEMPLATE = Object.freeze({
+  Github: (root: string) => path.join(root, ".github", "pull_request_template.md"),
+  Root: (root: string) => path.join(root, "pull_request_template.md"),
+  Docs: (root: string) => path.join(root, "docs", "pull_request_template.md"),
+  TemplateDir: (root: string) => path.join(root, ".github", "PULL_REQUEST_TEMPLATE"),
+});
+
+// prettier-ignore
+const PR_TEMPLATE_KEY_LIST = Object.keys(PR_TEMPLATE) as Array<keyof typeof PR_TEMPLATE>;

package/src/app/SelectCommitRanges.tsx

@@ -143,7 +143,7 @@ function SelectCommitRangesInternal(props: Props) {
 
         switch (inputLower) {
           case "s":
-            state.step = "manual-rebase";
+            state.step = "pre-manual-rebase";
             break;
         }
       });

package/src/app/Store.tsx

@@ -38,6 +38,8 @@ export type State = {
   branch_name: null | string;
   commit_range: null | CommitMetadata.CommitRange;
   commit_map: null | CommitMap;
+  pr_templates: Array<string>;
+  pr_template_body: null | string;
 
   step:
     | "github-api-error"
@@ -47,6 +49,7 @@ export type State = {
     | "local-merge-rebase"
     | "pre-select-commit-ranges"
     | "select-commit-ranges"
+    | "pre-manual-rebase"
     | "manual-rebase"
     | "post-rebase-status";
 
@@ -98,6 +101,8 @@ const BaseStore = createStore<State>()(
     branch_name: null,
     commit_range: null,
     commit_map: null,
+    pr_templates: [],
+    pr_template_body: null,
 
     step: "loading",
 

package/src/app/YesNoPrompt.tsx

@@ -55,7 +55,7 @@ export function YesNoPrompt(props: Props) {
 
   return (
     <Ink.Box flexDirection="column">
-      <Ink.Box>
+      <Ink.Box alignItems="flex-end">
         {typeof props.message === "object" ? (
           props.message
         ) : (

package/src/command.ts

@@ -71,6 +71,13 @@ export async function command() {
           'Set the master branch name, defaults to "master" (or "main" if "master" is not found)',
       })
 
+      .option("draft", {
+        type: "boolean",
+        alias: ["d"],
+        default: false,
+        description: "Open all PRs as drafts",
+      })
+
       .option("write-state-json", {
         hidden: true,
         type: "boolean",
@@ -78,6 +85,13 @@ export async function command() {
         description: "Write state to local json file for debugging",
       })
 
+      .option("template", {
+        type: "boolean",
+        default: true,
+        description:
+          "Use automatic Github PR template, e.g. .github/pull_request_template.md, disable with --no-template",
+      })
+
       .option("mock-metadata", {
         hidden: true,
         type: "boolean",

package/src/core/github.tsx

@@ -131,14 +131,18 @@ type CreatePullRequestArgs = {
   base: string;
   title: string;
   body: string;
+  draft: boolean;
 };
 
 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}"`;
 
-  const cli_result = await cli(
-    `gh pr create --fill --head ${args.branch} --base ${args.base} --title="${title}" --body="${args.body}"`
-  );
+  if (args.draft) {
+    command += " --draft";
+  }
+
+  const cli_result = await cli(command);
 
   if (cli_result.code !== 0) {
     handle_error(cli_result.output);