git-stack-cli 1.2.2 → 1.2.4

package/README.md

@@ -9,6 +9,7 @@
 - 💪 **Work seamlessly with GitHub's interface**
 - 🚫 **Avoid juggling mutiple branches and complex rebasing**
 - 📚 **Preserve your detailed commit history**
+- ⚡ **Faster, in-memory rebase via [`git revise`](https://github.com/mystor/git-revise)**
 
 ## Demo
 
@@ -16,24 +17,36 @@
 
 ## Install
 
-```bash
-# node
-npm i -g git-stack-cli
+> [!TIP]
+>
+> Install via **[Homebrew](https://brew.sh/)** to ensure the **[official Github CLI](https://cli.github.com/)** and **[git revise](https://github.com/mystor/git-revise)** dependencies are installed automatically
 
-# homebrew
+```bash
 brew tap magus/git-stack
 brew install git-stack
 ```
 
+### `npm`
+
+Installing via **[npm](https://www.npmjs.com/)** requires installing the **[official Github CLI](https://cli.github.com/)** and **[git revise](https://github.com/mystor/git-revise)** dependencies separarely
+
+```bash
+brew install gh
+brew install git-revise
+
+npm i -g git-stack-cli
+```
+
 ## Usage
 
 ```bash
-git stack
+git stack             # group and sync commits in branch to Github
 
+git stack --check     # print status only, skipping rebase and sync to Github
 git stack --verbose   # print more detailed logs for debugging internals
 git stack --no-verify # skip git hooks such as pre-commit and pre-push
 
-git-stack --help      # print a table of all command-line arguments
+git stack help        # print a table of all CLI arguments
 ```
 
 ## Why?
@@ -58,7 +71,7 @@ Managing even a few stacked diffs requires a relatively strong knowledge of `git
 - `ghstack` requires rebasing and squashing since each commit creates a pull request, which means you lose commit history
 - `git stack` allows developing in a single local branch and selecting groups of commits for each pull request
 - `git stack` adds a clear comment to each pull request in the stack showing the entire stack
-- `git stack` does not break if you land pull requests through Github directly, `ghstack` requires landing from the command-line interface
+- `git stack` does not break if you land pull requests through Github directly, `ghstack` requires landing from the CLI interface
 - `git stack` uses the [official GitHub CLI](https://cli.github.com/) (`gh`) instead of personal access tokens
 
 ## Development

package/dist/cjs/index.cjs

@@ -26920,12 +26920,10 @@ function CheckGithubCli(props) {
             actions.output(reactExports.createElement(Text, { color: colors.yellow },
                 reactExports.createElement(Command, null, "gh"),
                 " must be installed."));
-            actions.output(reactExports.createElement(Text, { color: colors.yellow },
-                reactExports.createElement(Text, null, "Visit "),
-                reactExports.createElement(Url, null, "https://cli.github.com"),
-                reactExports.createElement(Text, null, " to install the github cli "),
-                reactExports.createElement(Parens, null,
-                    reactExports.createElement(Command, null, "gh"))));
+            actions.output(reactExports.createElement(FormatText, { wrapper: reactExports.createElement(Text, { color: colors.yellow }), message: "Visit {url} to install the official Github CLI {command}", values: {
+                    url: reactExports.createElement(Url, null, "https://cli.github.com"),
+                    command: reactExports.createElement(Command, null, "gh"),
+                } }));
             actions.exit(3);
         } }, props.children));
 }
@@ -26950,10 +26948,10 @@ function CheckGithubCliAuth(props) {
             if (actions.isDebug()) {
                 actions.error("gh auth status could not find username");
             }
-            actions.output(reactExports.createElement(Text, { color: colors.yellow },
-                reactExports.createElement(Command, null, "gh"),
-                reactExports.createElement(Text, null, " requires login, please run "),
-                reactExports.createElement(Command, null, "gh auth login")));
+            actions.output(reactExports.createElement(FormatText, { wrapper: reactExports.createElement(Text, { color: colors.yellow }), message: "{gh} requires login, please run {command}", values: {
+                    gh: reactExports.createElement(Command, null, "gh"),
+                    command: reactExports.createElement(Command, null, "gh auth login"),
+                } }));
             actions.exit(4);
         } }, props.children));
 }
@@ -26967,20 +26965,20 @@ function CheckGitRevise(props) {
     return (reactExports.createElement(Await, { fallback: reactExports.createElement(Text, { color: colors.yellow },
             reactExports.createElement(Text, null,
                 "Checking ",
-                reactExports.createElement(Command, null, "git-revise"),
+                reactExports.createElement(Command, null, "git revise"),
                 " install...")), function: async () => {
             if (is_command_available("git-revise")) {
                 return;
             }
             actions.output(reactExports.createElement(Text, { color: colors.yellow },
-                reactExports.createElement(Command, null, "git-revise"),
+                reactExports.createElement(Command, null, "git revise"),
                 " must be installed."));
-            actions.output(reactExports.createElement(Text, { color: colors.yellow },
-                reactExports.createElement(Text, null, "Visit "),
-                reactExports.createElement(Url, null, "https://github.com/mystor/git-revise#install"),
-                reactExports.createElement(Text, null, " to install the git revise cli "),
-                reactExports.createElement(Parens, null,
-                    reactExports.createElement(Command, null, "git-revise"))));
+            actions.output(reactExports.createElement(FormatText, { wrapper: reactExports.createElement(Text, { color: colors.yellow }), message: "Visit {url} to install the {git_revise} CLI for faster, in-memory rebasing {command}", values: {
+                    url: reactExports.createElement(Url, null, "https://github.com/mystor/git-revise#install"),
+                    git_revise: reactExports.createElement(Command, null, "git revise"),
+                    command: (reactExports.createElement(Parens, null,
+                        reactExports.createElement(Command, null, "git revise"))),
+                } }));
             actions.exit(10);
         } }, props.children));
 }
@@ -34295,7 +34293,11 @@ async function command() {
         type: "string",
         choices: [Rebase["git-revise"], Rebase["cherry-pick"]],
         default: Rebase["git-revise"],
-        description: `Rebase implementation, "${Rebase["git-revise"]}" by default to perform in-memory rebase. "${Rebase["cherry-pick"]}" can be used to use disk and incrementally rebase each commit`,
+        description: [
+            "Strategy used for syncing branches",
+            `${Rebase["git-revise"]}: perform faster in-memory rebase`,
+            `${Rebase["cherry-pick"]}: use disk and incrementally rebase each commit`,
+        ].join(" | "),
     })
         .option("verbose", {
         type: "boolean",
@@ -34312,7 +34314,7 @@ async function command() {
         .option("branch", {
         type: "string",
         alias: ["b"],
-        description: `Set the master branch name, defaults to "master" (or "main" if "master" is not found)`,
+        description: 'Set the master branch name, defaults to "master" (or "main" if "master" is not found)',
     })
         .option("write-state-json", {
         hidden: true,
@@ -34326,13 +34328,13 @@ async function command() {
         default: false,
         description: "Mock local store metadata for testing",
     })
-        // do not wrap to 80 columns (yargs default)
-        // 140 seems to look decent so lets do that instead
+        // yargs default wraps to 80 columns
         // passing null will wrap to terminal width
-        .wrap(140)
+        // value below if what seems to look decent
+        .wrap(123)
         // disallow unknown options
         .strict()
-        .version("1.2.2" )
+        .version("1.2.4" )
         .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.2.2",
+  "version": "1.2.4",
   "description": "",
   "author": "magus",
   "license": "MIT",

package/src/app/DependencyCheck.tsx

@@ -4,6 +4,7 @@ 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 { Url } from "~/app/Url";
@@ -89,15 +90,15 @@ function CheckGithubCli(props: Props) {
         );
 
         actions.output(
-          <Ink.Text color={colors.yellow}>
-            <Ink.Text>{"Visit "}</Ink.Text>
-            <Url>https://cli.github.com</Url>
-            <Ink.Text>{" to install the github cli "}</Ink.Text>
-
-            <Parens>
-              <Command>gh</Command>
-            </Parens>
-          </Ink.Text>
+          <FormatText
+            wrapper={<Ink.Text color={colors.yellow} />}
+            message="Visit {url} to install the official Github CLI {command}"
+            values={{
+              url: <Url>https://cli.github.com</Url>,
+
+              command: <Command>gh</Command>,
+            }}
+          />
         );
 
         actions.exit(3);
@@ -141,11 +142,15 @@ function CheckGithubCliAuth(props: Props) {
         }
 
         actions.output(
-          <Ink.Text color={colors.yellow}>
-            <Command>gh</Command>
-            <Ink.Text>{" requires login, please run "}</Ink.Text>
-            <Command>gh auth login</Command>
-          </Ink.Text>
+          <FormatText
+            wrapper={<Ink.Text color={colors.yellow} />}
+            message="{gh} requires login, please run {command}"
+            values={{
+              gh: <Command>gh</Command>,
+
+              command: <Command>gh auth login</Command>,
+            }}
+          />
         );
 
         actions.exit(4);
@@ -170,7 +175,7 @@ function CheckGitRevise(props: Props) {
       fallback={
         <Ink.Text color={colors.yellow}>
           <Ink.Text>
-            Checking <Command>git-revise</Command> install...
+            Checking <Command>git revise</Command> install...
           </Ink.Text>
         </Ink.Text>
       }
@@ -181,20 +186,26 @@ function CheckGitRevise(props: Props) {
 
         actions.output(
           <Ink.Text color={colors.yellow}>
-            <Command>git-revise</Command> must be installed.
+            <Command>git revise</Command> must be installed.
           </Ink.Text>
         );
 
         actions.output(
-          <Ink.Text color={colors.yellow}>
-            <Ink.Text>{"Visit "}</Ink.Text>
-            <Url>https://github.com/mystor/git-revise#install</Url>
-            <Ink.Text>{" to install the git revise cli "}</Ink.Text>
-
-            <Parens>
-              <Command>git-revise</Command>
-            </Parens>
-          </Ink.Text>
+          <FormatText
+            wrapper={<Ink.Text color={colors.yellow} />}
+            message="Visit {url} to install the {git_revise} CLI for faster, in-memory rebasing {command}"
+            values={{
+              url: <Url>https://github.com/mystor/git-revise#install</Url>,
+
+              git_revise: <Command>git revise</Command>,
+
+              command: (
+                <Parens>
+                  <Command>git revise</Command>
+                </Parens>
+              ),
+            }}
+          />
         );
 
         actions.exit(10);

package/src/command.ts

@@ -35,7 +35,11 @@ export async function command() {
         type: "string",
         choices: [Rebase["git-revise"], Rebase["cherry-pick"]],
         default: Rebase["git-revise"],
-        description: `Rebase implementation, "${Rebase["git-revise"]}" by default to perform in-memory rebase. "${Rebase["cherry-pick"]}" can be used to use disk and incrementally rebase each commit`,
+        description: [
+          "Strategy used for syncing branches",
+          `${Rebase["git-revise"]}: perform faster in-memory rebase`,
+          `${Rebase["cherry-pick"]}: use disk and incrementally rebase each commit`,
+        ].join(" | "),
       })
 
       .option("verbose", {
@@ -55,7 +59,8 @@ export async function command() {
       .option("branch", {
         type: "string",
         alias: ["b"],
-        description: `Set the master branch name, defaults to "master" (or "main" if "master" is not found)`,
+        description:
+          'Set the master branch name, defaults to "master" (or "main" if "master" is not found)',
       })
 
       .option("write-state-json", {
@@ -72,10 +77,10 @@ export async function command() {
         description: "Mock local store metadata for testing",
       })
 
-      // do not wrap to 80 columns (yargs default)
-      // 140 seems to look decent so lets do that instead
+      // yargs default wraps to 80 columns
       // passing null will wrap to terminal width
-      .wrap(140)
+      // value below if what seems to look decent
+      .wrap(123)
 
       // disallow unknown options
       .strict()