git-stack-cli 2.6.0 → 2.7.0

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,

package/src/commands/Config.tsx

@@ -0,0 +1,106 @@
+import * as React from "react";
+
+import * as Ink from "ink-cjs";
+
+import { Await } from "~/app/Await";
+import { FormatText } from "~/app/FormatText";
+import { Store } from "~/app/Store";
+import { command } from "~/command";
+import { colors } from "~/core/colors";
+import { invariant } from "~/core/invariant";
+
+export function Config() {
+  return <Await fallback={null} function={run} />;
+
+  async function run() {
+    const state = Store.getState();
+    const actions = state.actions;
+
+    const config = await get_explicit_args();
+    const config_json = JSON.stringify(config).replace(/"/g, '\\"');
+
+    actions.output(
+      <Ink.Box flexDirection="column" gap={1} paddingTop={1}>
+        <Ink.Text></Ink.Text>
+
+        <FormatText
+          message="Add the line below to your shell rc file ({zshrc}, {bashrc}, etc.)"
+          values={{
+            zshrc: <Ink.Text color={colors.gray}>.zshrc</Ink.Text>,
+            bashrc: <Ink.Text color={colors.gray}>.bashrc</Ink.Text>,
+          }}
+        />
+
+        <FormatText
+          message={`{export} {ENV_VAR}{e}{q}{config_json}{q}`}
+          values={{
+            export: <Ink.Text color={colors.purple}>export</Ink.Text>,
+            ENV_VAR: <Ink.Text color={colors.yellow}>{ENV_VAR}</Ink.Text>,
+            e: <Ink.Text color={colors.purple}>{"="}</Ink.Text>,
+            q: <Ink.Text color={colors.white}>{'"'}</Ink.Text>,
+            config_json: <Ink.Text color={colors.green}>{config_json}</Ink.Text>,
+          }}
+        />
+      </Ink.Box>,
+    );
+
+    actions.exit(0);
+  }
+}
+
+export async function argv_with_config_from_env() {
+  if (!process.env.GIT_STACK_CONFIG) {
+    return await command(process.argv);
+  }
+
+  const env_config = parse_env_config();
+  return await command(process.argv, { env_config });
+}
+
+function parse_env_config() {
+  const GIT_STACK_CONFIG = process.env.GIT_STACK_CONFIG;
+  invariant(GIT_STACK_CONFIG, "GIT_STACK_CONFIG must exist");
+
+  try {
+    const env_config = JSON.parse(GIT_STACK_CONFIG);
+    return env_config;
+  } catch (error) {
+    // eslint-disable-next-line no-console
+    console.error(`ERROR GIT_STACK_CONFIG=${GIT_STACK_CONFIG}`);
+    // eslint-disable-next-line no-console
+    console.error("ERROR GIT_STACK_CONFIG environment variable is not valid JSON");
+    process.exit(18);
+  }
+}
+
+async function get_explicit_args() {
+  const default_argv = await command(["git", "stack"], COMMAND_OPTIONS);
+  const state_argv = await command(process.argv, COMMAND_OPTIONS);
+
+  const config: Record<string, any> = {};
+
+  // find delta between default_argv and argv
+  for (const key of Object.keys(state_argv)) {
+    if (key === "_" || key === "$0") continue;
+
+    const state_value = state_argv[key];
+    const default_value = default_argv[key];
+    const is_set = default_value !== state_value;
+    if (is_set) {
+      config[key] = state_value;
+    }
+  }
+
+  return config;
+}
+
+const ENV_VAR = "GIT_STACK_CONFIG";
+
+type CommandOptions = NonNullable<Parameters<typeof command>[1]>;
+
+const COMMAND_OPTIONS = {
+  parserConfiguration: {
+    // Should aliases be removed before returning results? Default is `false`
+    "strip-aliased": true,
+  },
+} satisfies CommandOptions;

package/src/commands/Rebase.tsx

@@ -22,7 +22,7 @@ type Props = {
 export function Rebase(props: Props) {
   return (
     <Await
-      fallback={<Ink.Text color={colors.yellow}>Rebasing commits…</Ink.Text>}
+      fallback={<Ink.Text color={colors.yellow}>Rebasing…</Ink.Text>}
       function={() => Rebase.run(props)}
     />
   );
@@ -48,6 +48,7 @@ Rebase.run = async function run(props: Props) {
     return 19;
   });
 
+  const master_branch_name = master_branch.replace(/^origin\//, "");
   const temp_branch_name = `${branch_name}_${short_id()}`;
 
   try {
@@ -58,9 +59,56 @@ Rebase.run = async function run(props: Props) {
     await cli(`pwd`);
 
     // fetch origin master branch for latest sha
-    const master_branch_name = master_branch.replace(/^origin\//, "");
     await cli(`git fetch --no-tags -v origin ${master_branch_name}`);
 
+    if (branch_name === master_branch_name) {
+      await rebase_master();
+    } else {
+      await rebase_branch();
+    }
+
+    actions.unregister_abort_handler();
+  } catch (err) {
+    actions.error("Unable to rebase.");
+
+    if (err instanceof Error) {
+      actions.error(err.message);
+    }
+
+    actions.exit(20);
+  }
+
+  const next_commit_range = await CommitMetadata.range();
+
+  actions.output(
+    <FormatText
+      wrapper={<Ink.Text color={colors.green} />}
+      message="✅ {branch_name} in sync with {origin_branch}"
+      values={{
+        branch_name: <Brackets>{branch_name}</Brackets>,
+        origin_branch: <Brackets>{master_branch}</Brackets>,
+      }}
+    />,
+  );
+
+  actions.set((state) => {
+    state.commit_range = next_commit_range;
+  });
+
+  if (props.onComplete) {
+    props.onComplete();
+  } else {
+    actions.output(<Status />);
+    actions.exit(0);
+  }
+
+  async function rebase_master() {
+    await cli(`git switch -C "${master_branch_name}" "${master_branch}"`);
+  }
+
+  async function rebase_branch() {
+    invariant(commit_range, "commit_range must exist");
+
     const master_sha = (await cli(`git rev-parse ${master_branch}`)).stdout;
     const rebase_merge_base = master_sha;
 
@@ -120,40 +168,6 @@ Rebase.run = async function run(props: Props) {
     await cli(`git branch -f ${branch_name} ${temp_branch_name}`);
 
     restore_git();
-
-    actions.unregister_abort_handler();
-  } catch (err) {
-    actions.error("Unable to rebase.");
-
-    if (err instanceof Error) {
-      actions.error(err.message);
-    }
-
-    actions.exit(20);
-  }
-
-  const next_commit_range = await CommitMetadata.range();
-
-  actions.output(
-    <FormatText
-      wrapper={<Ink.Text color={colors.green} />}
-      message="✅ {branch_name} in sync with {origin_branch}"
-      values={{
-        branch_name: <Brackets>{branch_name}</Brackets>,
-        origin_branch: <Brackets>{master_branch}</Brackets>,
-      }}
-    />,
-  );
-
-  actions.set((state) => {
-    state.commit_range = next_commit_range;
-  });
-
-  if (props.onComplete) {
-    props.onComplete();
-  } else {
-    actions.output(<Status />);
-    actions.exit(0);
   }
 
   // cleanup git operations if cancelled during manual rebase

package/src/components/ColorTest.tsx

@@ -0,0 +1,49 @@
+import * as React from "react";
+
+import { colors } from "~/core/colors";
+
+type RenderOptions = {
+  color: string;
+  name: string;
+};
+
+type Props = {
+  children: (render_options: RenderOptions) => React.ReactNode;
+};
+
+export function ColorTest(props: Props) {
+  return (
+    <React.Fragment>
+      {Object.entries(colors).map(([key, color]) => {
+        const name = `colors:${key}`;
+        return props.children({ color, name });
+      })}
+
+      {INK_COLORS.map((color) => {
+        const name = `ink:${color}`;
+        return props.children({ color, name });
+      })}
+    </React.Fragment>
+  );
+}
+
+// ForegroundColor
+// https://github.com/magus/git-stack-cli/blob/master/node_modules/.pnpm/chalk@5.3.0/node_modules/chalk/source/vendor/ansi-styles/index.d.ts#L75
+const INK_COLORS = [
+  "black",
+  "red",
+  "green",
+  "yellow",
+  "blue",
+  "cyan",
+  "magenta",
+  "white",
+  "blackBright",
+  "redBright",
+  "greenBright",
+  "yellowBright",
+  "blueBright",
+  "cyanBright",
+  "magentaBright",
+  "whiteBright",
+];

package/src/core/cli.ts

@@ -7,6 +7,7 @@ type SpawnOptions = Parameters<typeof child.spawn>[2];
 
 type Options = SpawnOptions & {
   ignoreExitCode?: boolean;
+  onOutput?: (data: string) => void;
 };
 
 type Return = {
@@ -51,6 +52,7 @@ export async function cli(
     function write_output(value: string) {
       output += value;
       state.actions.debug(value, id);
+      options.onOutput?.(value);
     }
 
     childProcess.stdout?.on("data", (data: Buffer) => {

package/src/core/colors.ts

@@ -1,7 +1,7 @@
 // ink uses chalk internally
 // https://github.com/vadimdemedes/ink#color
 
-export const colors = {
+export const colors = Object.freeze({
   red: "rgb(248, 81, 73)",
   // red-emphasis rgb(218, 54, 51)
 
@@ -20,4 +20,6 @@ export const colors = {
   gray: "rgb(110, 118, 129)",
 
   lightGray: "rgb(125, 133, 144)",
-};
+
+  white: "whiteBright",
+});

package/src/index.tsx

@@ -11,13 +11,13 @@ import * as Ink from "ink-cjs";
 
 import { App } from "~/app/App";
 import { Store } from "~/app/Store";
-import { command } from "~/command";
+import { argv_with_config_from_env } from "~/commands/Config";
 import { get_tmp_dir } from "~/core/get_tmp_dir";
 import { pretty_json } from "~/core/pretty_json";
 
 (async function main() {
   try {
-    const argv = await command();
+    const argv = await argv_with_config_from_env();
 
     // required to get bun working with ink
     // https://github.com/oven-sh/bun/issues/6862#issuecomment-2429444852

package/src/types/global.d.ts

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

package/src/app/PreSelectCommitRanges.tsx

@@ -1,29 +0,0 @@
-import * as React from "react";
-
-import { Store } from "~/app/Store";
-import { YesNoPrompt } from "~/app/YesNoPrompt";
-
-export function PreSelectCommitRanges() {
-  const actions = Store.useActions();
-  const argv = Store.useState((state) => state.argv);
-
-  React.useEffect(() => {
-    if (argv.force) {
-      Store.setState((state) => {
-        state.step = "select-commit-ranges";
-      });
-    }
-  }, [argv]);
-
-  return (
-    <YesNoPrompt
-      message="Some commits are new or outdated, would you like to select new commit ranges?"
-      onYes={() => {
-        actions.set((state) => {
-          state.step = "select-commit-ranges";
-        });
-      }}
-      onNo={() => actions.exit(0)}
-    />
-  );
-}

package/src/core/gs_short_id.ts

@@ -1,5 +0,0 @@
-import { short_id } from "~/core/short_id";
-
-export function gs_short_id() {
-  return `gs-${short_id()}`;
-}