git-stack-cli 1.13.2 → 1.15.0

package/src/core/GitReviseTodo.ts

@@ -5,6 +5,7 @@ import path from "node:path";
 import * as Metadata from "~/core/Metadata";
 import { cli } from "~/core/cli";
 import { invariant } from "~/core/invariant";
+import { safe_rm } from "~/core/safe_rm";
 
 import type * as CommitMetadata from "~/core/CommitMetadata";
 
@@ -140,6 +141,9 @@ GitReviseTodo.execute = async function grt_execute(args: ExecuteArgs) {
   // change to pipe to see output temporarily
   // https://github.com/magus/git-stack-cli/commit/f9f10e3ac3cd9a35ee75d3e0851a48391967a23f
   await cli(command, { stdio: ["ignore", "ignore", "ignore"] });
+
+  // cleanup tmp_git_sequence_editor_path
+  await safe_rm(tmp_git_sequence_editor_path);
 };
 
 type ExecuteArgs = {

package/src/core/github.tsx

@@ -130,13 +130,19 @@ export async function pr_create(args: CreatePullRequestArgs) {
   //   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 = `gh pr create --head refs/heads/${args.branch} --base ${args.base} --title="${title}" --body="${args.body}"`;
+  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);
@@ -155,18 +161,23 @@ type EditPullRequestArgs = {
 export async function pr_edit(args: EditPullRequestArgs) {
   const command_parts = [`gh pr edit ${args.branch} --base ${args.base}`];
 
+  let body_file: string | undefined;
+
   if (args.body) {
-    const body_file = await write_body_file(args);
+    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);
   }
+
+  // cleanup body_file
+  if (body_file) {
+    await safe_rm(body_file);
+  }
 }
 
 type DraftPullRequestArgs = {
@@ -254,7 +265,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);
 
@@ -291,3 +309,7 @@ export type PullRequest = {
   url: string;
   isDraft: boolean;
 };
+
+const RE = {
+  non_alphanumeric_dash: /[^a-zA-Z0-9_-]+/g,
+};

package/src/core/pretty_json.ts

@@ -0,0 +1,12 @@
+export namespace pretty_json {
+  export type JSONValue =
+    | null
+    | number
+    | string
+    | boolean
+    | { [key: string]: JSONValue };
+}
+
+export function pretty_json<T extends pretty_json.JSONValue>(input: T): string {
+  return JSON.stringify(input, null, 2);
+}

package/src/index.tsx

@@ -7,12 +7,19 @@ import * as Ink from "ink-cjs";
 import { App } from "~/app/App";
 import { Store } from "~/app/Store";
 import { command } from "~/command";
+import { pretty_json } from "~/core/pretty_json";
+
+(async function main() {
+  try {
+    const argv = await command();
 
-command()
-  .then((argv) => {
     const ink = Ink.render(<App />, {
       // If true, each update will be rendered as a separate output, without replacing the previous one.
       // debug: true,
+      //
+      // Configure whether Ink should listen to Ctrl+C keyboard input and exit the app.
+      // We intentionally handle this ourselves in `<Exit />`
+      exitOnCtrlC: false,
     });
 
     Store.setState((state) => {
@@ -22,7 +29,15 @@ command()
       state.cwd = process.cwd();
     });
 
-    Store.getState().actions.debug(JSON.stringify(argv, null, 2));
-  })
+    Store.getState().actions.debug(pretty_json(argv as any));
+
+    await ink.waitUntilExit();
+  } catch (err) {
+    // eslint-disable-next-line no-console
+    console.error(err);
+    process.exit(235);
+  }
+})().catch((err) => {
   // eslint-disable-next-line no-console
-  .catch(console.error);
+  console.error(err);
+});

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;
   }
 }