git-stack-cli 2.9.8 → 2.10.0

package/package.json

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

package/scripts/release-brew.ts

@@ -92,6 +92,10 @@ core = core.replace(re_token("tarball_sha256"), tarball_asset.sha256);
 
 await file.write_text(path.join("Formula", "git-stack.core.rb"), core);
 
+// write latest.json containing latest version
+const latest_json = JSON.stringify({ version });
+await file.write_text(path.join("latest.json"), latest_json);
+
 // commit homebrew repo changes
 process.chdir(HOMEBREW_DIR);
 await spawn.sync(`git add .`);

package/src/app/AutoUpdate.tsx

@@ -161,20 +161,32 @@ export function AutoUpdate(props: Props) {
       if (state.latest_version !== null) return;
 
       const local_version = process.env.CLI_VERSION;
-      const latest_version = await get_latest_version();
       const is_brew_bun_standalone = get_is_brew_bun_standalone();
-      patch({ local_version, latest_version, is_brew_bun_standalone });
-    }
 
-    async function get_latest_version() {
       const timeout_ms = is_finite_value(props.timeoutMs) ? props.timeoutMs : 2 * 1000;
       const timeout = get_timeout_fn(timeout_ms, "AutoUpdate timeout");
-      const npm_json = await timeout(fetch_json(`https://registry.npmjs.org/${props.name}`));
-      const maybe_version = npm_json?.["dist-tags"]?.latest;
-      if (typeof maybe_version === "string") {
-        return maybe_version;
+      const latest_version = await timeout(get_latest_version(is_brew_bun_standalone));
+
+      patch({ local_version, latest_version, is_brew_bun_standalone });
+    }
+
+    async function get_latest_version(is_brew_bun_standalone: boolean) {
+      if (is_brew_bun_standalone) {
+        // prettier-ignore
+        const brew_json = await fetch_json("https://raw.githubusercontent.com/magus/homebrew-git-stack/refs/heads/master/latest.json");
+        const maybe_version = brew_json.version;
+        if (typeof maybe_version === "string") {
+          return maybe_version;
+        }
+        throw new Error("Unable to retrieve latest version from brew");
+      } else {
+        const npm_json = await fetch_json(`https://registry.npmjs.org/${props.name}`);
+        const maybe_version = npm_json?.["dist-tags"]?.latest;
+        if (typeof maybe_version === "string") {
+          return maybe_version;
+        }
+        throw new Error("Unable to retrieve latest version from npm");
       }
-      throw new Error("Unable to retrieve latest version from npm");
     }
 
     function get_is_brew_bun_standalone() {

package/src/app/SyncGithub.tsx

@@ -28,6 +28,7 @@ async function run() {
   const master_branch = state.master_branch;
   const repo_path = state.repo_path;
   const sync_github = state.sync_github;
+  const labels = argv.label ?? [];
 
   invariant(branch_name, "branch_name must exist");
   invariant(commit_map, "commit_map must exist");
@@ -140,17 +141,17 @@ async function run() {
     const pr_url_list = all_pr_groups.map((g) => pr_url_by_group_id[g.id]);
 
     // update PR body for all pr groups (not just push_group_list)
-    const update_pr_body_tasks = [];
+    const update_pr_tasks = [];
     for (let i = 0; i < all_pr_groups.length; i++) {
       const group = all_pr_groups[i];
 
       const selected_url = pr_url_by_group_id[group.id];
 
-      const task = update_pr_body({ group, selected_url, pr_url_list });
-      update_pr_body_tasks.push(task);
+      const task = update_pr({ group, selected_url, pr_url_list, labels });
+      update_pr_tasks.push(task);
     }
 
-    await Promise.all(update_pr_body_tasks);
+    await Promise.all(update_pr_tasks);
 
     actions.unregister_abort_handler();
 
@@ -262,6 +263,7 @@ async function run() {
         title: group.title,
         body: DEFAULT_PR_BODY,
         draft: argv.draft,
+        labels,
       });
 
       if (!pr_url) {
@@ -273,10 +275,11 @@ async function run() {
     }
   }
 
-  async function update_pr_body(args: {
+  async function update_pr(args: {
     group: CommitMetadataGroup;
     selected_url: string;
     pr_url_list: Array<string>;
+    labels: Array<string>;
   }) {
     const { group, selected_url, pr_url_list } = args;
 
@@ -292,17 +295,30 @@ async function run() {
 
     const debug_meta = `${group.id} ${selected_url}`;
 
-    if (update_body === body) {
-      actions.debug(`Skipping body update ${debug_meta}`);
-    } else {
-      actions.debug(`Update body ${debug_meta}`);
+    const body_changed = update_body !== body;
+    const needs_labels = args.labels.length > 0;
 
-      await github.pr_edit({
-        branch: group.id,
-        base: group.base,
-        body: update_body,
-      });
+    if (!body_changed && !needs_labels) {
+      actions.debug(`Skipping update ${debug_meta}`);
+      return;
     }
+
+    actions.debug(`Update PR ${debug_meta}`);
+
+    const edit_args: Parameters<typeof github.pr_edit>[0] = {
+      branch: group.id,
+      base: group.base,
+    };
+
+    if (body_changed) {
+      edit_args.body = update_body;
+    }
+
+    if (needs_labels) {
+      edit_args.add_labels = args.labels;
+    }
+
+    await github.pr_edit(edit_args);
   }
 
   function is_pr_master_base(group: CommitMetadataGroup) {

package/src/command.ts

@@ -18,7 +18,7 @@ export async function command(argv: string[], options: CommandOptions = {}) {
     builder = builder.parserConfiguration(options.parserConfiguration);
   }
 
-  const parsed = await builder
+  const parsed = builder
     .scriptName("git stack")
     .usage("Usage: git stack [command] [options]")
 
@@ -122,6 +122,24 @@ const DefaultOptions = {
     description: "Sync commit ranges to Github, disable with --no-sync",
   },
 
+  "label": {
+    type: "array",
+    alias: ["labels"],
+    coerce: (label_input: Array<string | number>) => label_input.map((v) => String(v)),
+    description: [
+      // force line break
+      "Apply labels to all PRs in the stack (repeatable)",
+      "Example: --label backend --label needs-review",
+    ].join("\n"),
+  },
+
+  "draft": {
+    type: "boolean",
+    alias: ["d"],
+    default: false,
+    description: "Open all PRs as drafts",
+  },
+
   "verify": {
     type: "boolean",
     default: true,
@@ -142,19 +160,6 @@ const DefaultOptions = {
     ].join("\n"),
   },
 
-  "draft": {
-    type: "boolean",
-    alias: ["d"],
-    default: false,
-    description: "Open all PRs as drafts",
-  },
-
-  "revise-sign": {
-    type: "boolean",
-    default: true,
-    description: "Disable GPG signing for git revise with --no-revise-sign",
-  },
-
   "template": {
     type: "boolean",
     default: true,
@@ -164,12 +169,18 @@ const DefaultOptions = {
       "Disable with --no-template",
     ].join("\n"),
   },
+
+  "revise-sign": {
+    type: "boolean",
+    default: true,
+    description: "Disable GPG signing for git revise with --no-revise-sign",
+  },
 } satisfies YargsOptions;
 
 const FixupOptions = {
   commit: {
     type: "number",
-    default: 1,
+    default: 0,
     description: [
       "Relative number of commit to amend staged changes.",
       "Most recent is 1, next is 2, etc.",

package/src/commands/Fixup.tsx

@@ -3,11 +3,13 @@ import * as React from "react";
 import * as Ink from "ink-cjs";
 
 import { Await } from "~/app/Await";
+import { Command } from "~/app/Command";
 import { FormatText } from "~/app/FormatText";
 import { Parens } from "~/app/Parens";
 import { Store } from "~/app/Store";
 import { cli } from "~/core/cli";
 import { colors } from "~/core/colors";
+import { is_finite_value } from "~/core/is_finite_value";
 
 export function Fixup() {
   return (
@@ -25,27 +27,48 @@ async function run() {
 
   const relative_number = argv.commit;
 
-  if (!relative_number) {
+  if (!is_finite_value(relative_number)) {
     actions.output(
-      <Ink.Text color={colors.red}>❗️ Usage: git fixup {"<relative-commit-number>"}</Ink.Text>,
+      <Ink.Box flexDirection="column">
+        <Ink.Text color={colors.red}>❗️ Usage: git fixup {"<relative-commit-number>"}</Ink.Text>
+        <Ink.Text color={colors.gray}>
+          Automates the process of adding staged changes to a previous commit.
+        </Ink.Text>
+        <FormatText
+          wrapper={<Ink.Text color={colors.gray} />}
+          message="You can use {git_stack_log} to get the relative commit number."
+          values={{ git_stack_log: <Command>git stack log</Command> }}
+        />
+        <Ink.Box height={1} />
+        <FormatText
+          message="    {prompt} git stack log"
+          values={{ prompt: <Ink.Text color={colors.green}>❯</Ink.Text> }}
+        />
+        <FormatText
+          message="    0 * {sha}  18 hours ago    noah      homebrew-git-stack 2.9.9"
+          values={{ sha: <Ink.Text color={colors.green}>e329794</Ink.Text> }}
+        />
+        <FormatText
+          message="    1 * {sha}  18 hours ago    noah      2.9.9"
+          values={{ sha: <Ink.Text color={colors.green}>c7e4065</Ink.Text> }}
+        />
+        <FormatText
+          message="    2 * {sha}  18 hours ago    noah      command: --label + github add labels"
+          values={{ sha: <Ink.Text color={colors.green}>f82ac73</Ink.Text> }}
+        />
+        <Ink.Box height={1} />
+        <FormatText
+          wrapper={<Ink.Text color={colors.gray} />}
+          message="To target {sha} above, use {command}"
+          values={{
+            sha: <Ink.Text color={colors.green}>838e878</Ink.Text>,
+            command: <Command>git stack fixup 2</Command>,
+          }}
+        />
+      </Ink.Box>,
     );
+
     actions.output("");
-    actions.output("This script automates the process of adding staged changes as a fixup commit");
-    actions.output(
-      "and the subsequent git rebase to flatten the commits based on relative commit number",
-    );
-    actions.output("You can use a `git log` like below to get the relative commit number");
-    actions.output("");
-    actions.output("    ❯ git stack log");
-    actions.output(
-      "    1\te329794d5f881cbf0fc3f26d2108cf6f3fdebabe enable drop_error_subtask test param",
-    );
-    actions.output(
-      "    2\t57f43b596e5c6b97bc47e2a591f82ccc81651156 test drop_error_subtask baseline",
-    );
-    actions.output("    3\t838e878d483c6a2d5393063fc59baf2407225c6d ErrorSubtask test baseline");
-    actions.output("");
-    actions.output("To target `838e87` above, you would call `fixup 3`");
 
     actions.exit(0);
   }
@@ -64,11 +87,8 @@ async function run() {
     // );
   }
 
-  // Calculate commit SHA based on the relative commit number
-  const adjusted_number = Number(relative_number) - 1;
-
   // get the commit SHA of the target commit
-  const commit_sha = (await cli(`git rev-parse HEAD~${adjusted_number}`)).stdout;
+  const commit_sha = (await cli(`git rev-parse HEAD~${relative_number}`)).stdout;
 
   actions.output(
     <FormatText
@@ -104,7 +124,7 @@ async function run() {
 
   try {
     // rebase target needs to account for new commit created above
-    const rebase_target = Number(relative_number) + 1;
+    const rebase_target = Number(relative_number) + 2;
 
     await cli(`git rebase -i --autosquash HEAD~${rebase_target}`, {
       env: {

package/src/commands/Log.tsx

@@ -65,7 +65,7 @@ async function run(args: Args) {
   const command = [
     `git log --pretty=format:"${format}" -n20 --graph --color ${rest_args}`,
     `cut -c 1-"${truncation_width}"`,
-    `nl -w3 -s' '`,
+    `nl -v0 -w3 -s' '`,
   ].join(" | ");
 
   const result = await cli(command);

package/src/core/get_timeout_fn.ts

@@ -1,5 +1,5 @@
 export function get_timeout_fn(ms: number, message: string) {
-  return function timeout<T>(promise: Promise<T>) {
+  return async function timeout<T>(promise: Promise<T>) {
     let id: ReturnType<typeof setTimeout>;
 
     const timeout = new Promise<never>((_resolve, reject) => {

package/src/core/github.tsx

@@ -121,6 +121,7 @@ type CreatePullRequestArgs = {
   title: string;
   body: string;
   draft: boolean;
+  labels?: Array<string>;
 };
 
 export async function pr_create(args: CreatePullRequestArgs) {
@@ -147,6 +148,13 @@ export async function pr_create(args: CreatePullRequestArgs) {
     command_parts.push("--draft");
   }
 
+  if (args.labels && args.labels.length > 0) {
+    for (const label of args.labels) {
+      if (!label) continue;
+      command_parts.push(`--label="${safe_quote(label)}"`);
+    }
+  }
+
   const cli_result = await cli(command_parts);
 
   if (cli_result.code !== 0) {
@@ -161,14 +169,17 @@ type EditPullRequestArgs = {
   branch: string;
   base?: string;
   body?: string;
+  add_labels?: Array<string>;
 };
 
 export async function pr_edit(args: EditPullRequestArgs) {
+  // https://cli.github.com/manual/gh_pr_edit
+
   // const state = Store.getState();
   // const actions = state.actions;
   // actions.debug(`github.pr_edit ${JSON.stringify(args)}`);
 
-  if (!args.base && !args.body) {
+  if (!args.base && !args.body && !(args.add_labels && args.add_labels.length > 0)) {
     return;
   }
 
@@ -186,6 +197,13 @@ export async function pr_edit(args: EditPullRequestArgs) {
     command_parts.push(`--body-file="${body_file}"`);
   }
 
+  if (args.add_labels && args.add_labels.length > 0) {
+    for (const label of args.add_labels) {
+      if (!label) continue;
+      command_parts.push(`--add-label="${safe_quote(label)}"`);
+    }
+  }
+
   const cli_result = await cli(command_parts);
 
   if (cli_result.code !== 0) {