git-stack-cli 2.6.1 → 2.7.1

package/package.json

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

package/src/app/App.tsx

@@ -17,6 +17,7 @@ import { RebaseCheck } from "~/app/RebaseCheck";
 import { RequireBranch } from "~/app/RequireBranch";
 import { Store } from "~/app/Store";
 import { VerboseDebugInfo } from "~/app/VerboseDebugInfo";
+import { Config } from "~/commands/Config";
 import { Fixup } from "~/commands/Fixup";
 import { Log } from "~/commands/Log";
 import { Rebase } from "~/commands/Rebase";
@@ -92,6 +93,8 @@ function MaybeMain() {
     return <Log />;
   } else if (positional_list.has("update")) {
     return <Update />;
+  } else if (positional_list.has("config")) {
+    return <Config />;
   } else if (positional_list.has("rebase")) {
     return (
       <DependencyCheck>

package/src/app/AutoUpdate.tsx

@@ -5,6 +5,7 @@ import * as Ink from "ink-cjs";
 import { Brackets } from "~/app/Brackets";
 import { Command } from "~/app/Command";
 import { FormatText } from "~/app/FormatText";
+import { Url } from "~/app/Url";
 import { YesNoPrompt } from "~/app/YesNoPrompt";
 import { assertNever } from "~/core/assertNever";
 import { cli } from "~/core/cli";
@@ -26,10 +27,9 @@ type Props = {
 };
 
 type State = {
-  error: null | Error;
+  status: "init" | "prompt" | "install" | "done";
   local_version: null | string;
   latest_version: null | string;
-  status: "init" | "prompt" | "install" | "done";
   is_brew_bun_standalone: boolean;
 };
 
@@ -44,24 +44,94 @@ export function AutoUpdate(props: Props) {
   const [output, set_output] = React.useState<Array<React.ReactNode>>([]);
 
   const [state, patch] = React.useReducer(reducer, {
-    error: null,
+    status: "init",
     local_version: null,
     latest_version: null,
-    status: "init",
     is_brew_bun_standalone: false,
+
+    // // debugging
+    // status: "prompt",
+    // local_version: "2.5.3",
+    // latest_version: "2.7.0",
+    // is_brew_bun_standalone: true,
   });
 
-  function handle_output(node: React.ReactNode) {
-    if (typeof props.onOutput === "function") {
-      props.onOutput(node);
-    } else {
-      set_output((current) => {
-        return [...current, node];
-      });
+  React.useEffect(handle_init_state, []);
+  React.useEffect(handle_status, [state.latest_version]);
+  React.useEffect(handle_on_done, [state.status]);
+
+  const status = render_status();
+
+  return (
+    <React.Fragment>
+      {output}
+      {status}
+    </React.Fragment>
+  );
+
+  function render_status() {
+    switch (state.status) {
+      case "init":
+        return null;
+
+      case "install":
+        return null;
+
+      case "done":
+        return props.children;
+
+      case "prompt": {
+        let install_command = "";
+        if (state.is_brew_bun_standalone) {
+          install_command = "brew install magus/git-stack/git-stack";
+        } else {
+          install_command = `npm install -g ${props.name}@latest`;
+        }
+
+        return (
+          <YesNoPrompt
+            message={
+              <Ink.Box flexDirection="column" gap={1}>
+                <Command>{install_command}</Command>
+                <FormatText
+                  wrapper={<Ink.Text color={colors.yellow} />}
+                  message="Would you like to run the above command to update?"
+                />
+              </Ink.Box>
+            }
+            onNo={() => {
+              patch({ status: "done" });
+            }}
+            onYes={async () => {
+              info(<Command>{install_command}</Command>);
+
+              patch({ status: "install" });
+
+              await cli(install_command, {
+                env: {
+                  ...process.env,
+                  HOMEBREW_COLOR: "1",
+                },
+                onOutput: (data: string) => {
+                  info(<Ink.Text>{data}</Ink.Text>);
+                },
+              });
+
+              info(
+                <Ink.Text key="done">
+                  ✅ Installed <Brackets>{state.latest_version}</Brackets>
+                </Ink.Text>,
+              );
+
+              patch({ status: "done" });
+            }}
+          />
+        );
+      }
     }
   }
 
-  React.useEffect(() => {
+  function handle_on_done() {
     switch (state.status) {
       case "init":
       case "prompt":
@@ -76,199 +146,165 @@ export function AutoUpdate(props: Props) {
       default:
         assertNever(state.status);
     }
-  }, [state.status]);
+  }
 
-  React.useEffect(() => {
-    let status: State["status"] = "init";
-    let latest_version: string | null = null;
-    let is_brew_bun_standalone = false;
+  function handle_init_state() {
+    init_state().catch(abort);
 
-    const local_version = process.env.CLI_VERSION;
-    const is_output = props_ref.current.verbose || props_ref.current.force;
+    async function init_state() {
+      if (state.latest_version !== null) return;
 
-    async function auto_update() {
-      if (!local_version) {
-        throw new Error("Auto update requires process.env.CLI_VERSION to be set");
-      }
+      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 npm_json = await Promise.race([
         fetch_json(`https://registry.npmjs.org/${props.name}`),
 
         sleep(timeout_ms).then(() => {
-          throw new Error("AutoUpdate timeout");
+          abort(new Error("AutoUpdate timeout"));
         }),
       ]);
 
-      latest_version = npm_json?.["dist-tags"]?.latest;
+      const maybe_version = npm_json?.["dist-tags"]?.latest;
 
-      if (!latest_version) {
-        throw new Error("Unable to retrieve latest version from npm");
+      if (typeof maybe_version === "string") {
+        return maybe_version;
       }
 
+      throw new Error("Unable to retrieve latest version from npm");
+    }
+
+    function get_is_brew_bun_standalone() {
       const binary_path = process.argv[1];
+      debug(<Ink.Text dimColor>{JSON.stringify({ binary_path })}</Ink.Text>);
+
+      const is_bunfs_path = binary_path.startsWith("/$bunfs");
+      debug(
+        <Ink.Text dimColor>
+          {is_bunfs_path
+            ? "brew install detected (compiled bun standalone)"
+            : "npm install detected"}
+        </Ink.Text>,
+      );
+
+      return is_bunfs_path;
+    }
+  }
+
+  function handle_status() {
+    const latest_version = state.latest_version;
+
+    if (latest_version === null) {
+      return;
+    }
+
+    const local_version = state.local_version;
+
+    if (!local_version) {
+      throw new Error("Auto update requires process.env.CLI_VERSION to be set");
+    }
+
+    debug(
+      <FormatText
+        key="versions"
+        wrapper={<Ink.Text dimColor />}
+        message="Auto update found latest version {latest_version} and current local version {local_version}"
+        values={{
+          latest_version: <Brackets>{latest_version}</Brackets>,
+          local_version: <Brackets>{local_version}</Brackets>,
+        }}
+      />,
+    );
+
+    const semver_result = semver_compare(latest_version, local_version);
+    debug(<Ink.Text dimColor>{JSON.stringify({ semver_result })}</Ink.Text>);
+
+    switch (semver_result) {
+      case 0: {
+        info(
+          <Ink.Text>
+            ✅ Everything up to date. <Brackets>{latest_version}</Brackets>
+          </Ink.Text>,
+        );
 
-      if (props_ref.current.verbose) {
-        handle_output(<Ink.Text dimColor>{JSON.stringify({ binary_path })}</Ink.Text>);
+        return patch({ status: "done" });
       }
 
-      is_brew_bun_standalone = binary_path.startsWith("/$bunfs");
+      case 1: {
+        const old_tag = local_version;
+        const new_tag = state.latest_version;
+        const url = `https://github.com/magus/git-stack-cli/compare/${old_tag}...${new_tag}`;
 
-      if (props_ref.current.verbose) {
-        if (is_brew_bun_standalone) {
-          handle_output(
-            <Ink.Text dimColor>brew install detected (compiled bun standalone)</Ink.Text>,
-          );
-        } else {
-          handle_output(<Ink.Text dimColor>npm install detected</Ink.Text>);
-        }
+        info(
+          <Ink.Box flexDirection="column" gap={1} paddingTop={1} paddingBottom={1}>
+            <Ink.Text>
+              🆕 New version available! <Brackets>{latest_version}</Brackets>
+            </Ink.Text>
+            <Ink.Box flexDirection="column">
+              <Ink.Text dimColor>Changelog</Ink.Text>
+              <Url>{url}</Url>
+            </Ink.Box>
+          </Ink.Box>,
+        );
+
+        return patch({ status: "prompt" });
       }
 
-      if (props_ref.current.verbose) {
-        handle_output(
+      case -1: {
+        info(
           <FormatText
-            key="versions"
-            wrapper={<Ink.Text />}
-            message="Auto update found latest version {latest_version} and current local version {local_version}"
+            message="⚠️ Local version {local_version} is newer than latest version {latest_version}"
             values={{
-              latest_version: <Brackets>{latest_version}</Brackets>,
               local_version: <Brackets>{local_version}</Brackets>,
+              latest_version: <Brackets>{latest_version}</Brackets>,
             }}
           />,
         );
-      }
 
-      const semver_result = semver_compare(latest_version, local_version);
-      if (props_ref.current.verbose) {
-        handle_output(<Ink.Text dimColor>{JSON.stringify({ semver_result })}</Ink.Text>);
+        return patch({ status: "done" });
       }
 
-      if (semver_result === 0) {
-        status = "done";
-
-        if (is_output) {
-          handle_output(
-            <Ink.Text>
-              ✅ Everything up to date. <Brackets>{latest_version}</Brackets>
-            </Ink.Text>,
-          );
-        }
-        return;
-      }
-
-      if (semver_result === 1) {
-        // trigger yes no prompt
-        status = "prompt";
+      default: {
+        assertNever(semver_result);
+        abort(new Error("AutoUpdate failed"));
       }
+    }
+  }
 
-      throw new Error("AutoUpdate failed");
+  function info(node: React.ReactNode) {
+    if (props_ref.current.verbose || props_ref.current.force) {
+      handle_output(node);
     }
+  }
 
-    const onError = props_ref.current.onError || (() => {});
-
-    auto_update()
-      .then(() => {
-        patch({ status, local_version, latest_version, is_brew_bun_standalone });
-      })
-      .catch((error) => {
-        if (props_ref.current.verbose) {
-          handle_output(
-            <Ink.Text key="error" color={colors.red}>
-              {error?.message}
-            </Ink.Text>,
-          );
-        }
+  function debug(node: React.ReactNode) {
+    if (props_ref.current.verbose) {
+      handle_output(node);
+    }
+  }
+  function abort(error: Error) {
+    info(
+      <Ink.Text key="error" color={colors.red}>
+        {error.message}
+      </Ink.Text>,
+    );
+    patch({ status: "done" });
+    props_ref.current.onError?.(error);
+  }
 
-        // ensure we always exit
-        status = "done";
-        patch({ status, error, local_version, latest_version, is_brew_bun_standalone });
-        onError(error);
+  function handle_output(node: React.ReactNode) {
+    if (typeof props.onOutput === "function") {
+      props.onOutput(node);
+    } else {
+      set_output((current) => {
+        return [...current, node];
       });
-  }, []);
-
-  const status = (function render_status() {
-    switch (state.status) {
-      case "init":
-        return null;
-
-      case "prompt": {
-        let install_command = "";
-        if (state.is_brew_bun_standalone) {
-          install_command = "brew install magus/git-stack/git-stack";
-        } else {
-          install_command = `npm install -g ${props.name}@latest`;
-        }
-
-        return (
-          <YesNoPrompt
-            message={
-              <Ink.Box flexDirection="column">
-                <Ink.Box flexDirection="column">
-                  <Ink.Text color={colors.yellow}>
-                    <FormatText
-                      wrapper={<Ink.Text />}
-                      message="New version available {latest_version}"
-                      values={{
-                        latest_version: <Brackets>{state.latest_version}</Brackets>,
-                      }}
-                    />
-                    ,
-                  </Ink.Text>
-                  <Ink.Text> </Ink.Text>
-                  <Command>{install_command}</Command>
-                  <Ink.Text> </Ink.Text>
-                </Ink.Box>
-                <Ink.Box>
-                  <FormatText
-                    wrapper={<Ink.Text color={colors.yellow} />}
-                    message="Would you like to run the above command to update?"
-                  />
-                </Ink.Box>
-              </Ink.Box>
-            }
-            onYes={async () => {
-              handle_output(<Command>{install_command}</Command>);
-
-              patch({ status: "install" });
-
-              await cli(install_command, {
-                env: {
-                  ...process.env,
-                  HOMEBREW_COLOR: "1",
-                },
-                onOutput: (data: string) => {
-                  handle_output(<Ink.Text>{data}</Ink.Text>);
-                },
-              });
-
-              handle_output(
-                <Ink.Text key="done">
-                  ✅ Installed <Brackets>{state.latest_version}</Brackets>
-                </Ink.Text>,
-              );
-
-              patch({ status: "done" });
-            }}
-            onNo={() => {
-              patch({ status: "done" });
-            }}
-          />
-        );
-      }
-
-      case "install":
-        return null;
-
-      case "done":
-        return props.children;
     }
-  })();
-
-  return (
-    <React.Fragment>
-      {output}
-      {status}
-    </React.Fragment>
-  );
+  }
 }

package/src/app/SelectCommitRanges.tsx

@@ -10,8 +10,8 @@ import { Parens } from "~/app/Parens";
 import { Store } from "~/app/Store";
 import { TextInput } from "~/app/TextInput";
 import { colors } from "~/core/colors";
-import { gs_short_id } from "~/core/gs_short_id";
 import { invariant } from "~/core/invariant";
+import { short_id } from "~/core/short_id";
 import { wrap_index } from "~/core/wrap_index";
 
 import type { State } from "~/app/Store";
@@ -35,6 +35,8 @@ function SelectCommitRangesInternal(props: Props) {
   const actions = Store.useActions();
 
   const argv = Store.useState((state) => state.argv);
+  const branch_name = Store.useState((state) => state.branch_name);
+  invariant(branch_name, "branch_name must exist");
 
   const [selected_group_id, set_selected_group_id] = React.useState(() => {
     const first_group = props.commit_range.group_list.find(
@@ -444,17 +446,7 @@ function SelectCommitRangesInternal(props: Props) {
   );
 
   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()}`;
+    return `${branch_name}-${short_id()}`;
   }
 
   function submit_group_input(title: string) {

package/src/command.ts

@@ -1,54 +1,78 @@
 import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
 
-import type { Options, InferredOptionTypes, Arguments } from "yargs";
+import type { Options, InferredOptionTypes, Arguments, ParserConfigurationOptions } from "yargs";
 
 export type Argv = Arguments & TGlobalOptions & TFixupOptions & TDefaultOptions;
 
-export async function command() {
+type CommandOptions = {
+  env_config?: Partial<Argv>;
+  parserConfiguration?: Partial<ParserConfigurationOptions>;
+};
+
+export async function command(argv: string[], options: CommandOptions = {}) {
   // https://yargs.js.org/docs/#api-reference-optionkey-opt
-  return (
-    yargs(hideBin(process.argv))
-      .scriptName("git stack")
-      .usage("Usage: git stack [command] [options]")
-
-      .command("$0", "Sync commit ranges to Github", (yargs) => yargs.options(DefaultOptions))
-
-      .command("fixup [commit]", "Amend staged changes to a specific commit in history", (yargs) =>
-        yargs.positional("commit", FixupOptions.commit),
-      )
-
-      .command(
-        "log [args...]",
-        "Print an abbreviated log with numbered commits, useful for git stack fixup",
-        (yargs) => yargs.strict(false),
-      )
-
-      .command(
-        "rebase",
-        "Update local branch via rebase with latest changes from origin master branch",
-        (yargs) => yargs,
-      )
-
-      .command(
-        ["update", "upgrade"],
-        "Check and install the latest version of git stack",
-        (yargs) => yargs,
-      )
-
-      .option("verbose", GlobalOptions.verbose)
-
-      // yargs default wraps to 80 columns
-      // passing null will wrap to terminal width
-      // value below if what seems to look decent
-      .wrap(123)
-
-      // disallow unknown options
-      .strict()
-      .version(process.env.CLI_VERSION || "unknown")
-      .showHidden("show-hidden", "Show hidden options via `git stack help --show-hidden`")
-      .help("help", "Show usage via `git stack help`").argv as unknown as Promise<Argv>
-  );
+  let builder = yargs(hideBin(argv));
+
+  if (options.parserConfiguration) {
+    builder = builder.parserConfiguration(options.parserConfiguration);
+  }
+
+  // apply overrides from config
+  // higher precedence than defaults, but lower precendence than cli flags
+  // perfect since that's what we want, prefer config only if not explicitly set on cli
+  if (options.env_config) {
+    builder = builder.config(options.env_config);
+  }
+
+  const parsed = await builder
+    .scriptName("git stack")
+    .usage("Usage: git stack [command] [options]")
+
+    .command("$0", "Sync commit ranges to Github", (yargs) => yargs.options(DefaultOptions))
+
+    .command("fixup [commit]", "Amend staged changes to a specific commit in history", (yargs) =>
+      yargs.positional("commit", FixupOptions.commit),
+    )
+
+    .command(
+      "log [args...]",
+      "Print an abbreviated log with numbered commits, useful for git stack fixup",
+      (yargs) => yargs.strict(false),
+    )
+
+    .command(
+      "rebase",
+      "Update local branch via rebase with latest changes from origin master branch",
+      (yargs) => yargs,
+    )
+
+    .command(
+      ["update", "upgrade"],
+      "Check and install the latest version of git stack",
+      (yargs) => yargs,
+    )
+    .command(
+      "config",
+      "Generate a one-time configuration json based on the passed arguments",
+      (yargs) => yargs.options(DefaultOptions),
+    )
+
+    .option("verbose", GlobalOptions.verbose)
+
+    // yargs default wraps to 80 columns
+    // passing null will wrap to terminal width
+    // value below if what seems to look decent
+    .wrap(123)
+
+    // disallow unknown options
+    .strict()
+    .version(process.env.CLI_VERSION || "unknown")
+    .showHidden("show-hidden", "Show hidden options via `git stack help --show-hidden`")
+    .help("help", "Show usage via `git stack help`");
+
+  const result = parsed.argv as unknown as Argv;
+  return result;
 }
 
 const GlobalOptions = {
@@ -109,12 +133,6 @@ const DefaultOptions = {
     description: "Open all PRs as drafts",
   },
 
-  "branch-prefix": {
-    type: "string",
-    default: "",
-    description: "Prefix for generated branch names, e.g. dev/magus/",
-  },
-
   "revise-sign": {
     type: "boolean",
     default: true,