git-stack-cli 0.7.3 → 0.7.5

package/README.md

@@ -1,40 +1,51 @@
 # git-stack-cli
 
+- ✨ **[Stacked diffs](https://graphite.dev/guides/stacked-diffs) for `git`**
 - 🚀 **Simple one-branch workflow**
 - 🎯 **Interactively select commits for each pull request**
-- 📚 **Preserve your detailed commit history**
-- ♻️ **Automatically synchronize each pull request in the stack**
 - 💬 **Group commits for focused code review**
-- 🚫 **Avoid mutiple branch juggling and complex rebasing**
+- 🌐 **Use the [official GitHub CLI](https://cli.github.com/)**
+- ♻️ **Automatically synchronize each pull request in the stack**
 - 💪 **Work seamlessly with GitHub's interface**
-- 🌐 **Leverage the [official GitHub CLI](https://cli.github.com/)**
+- 🚫 **Avoid juggling mutiple branches and complex rebasing**
+- 📚 **Preserve your detailed commit history**
+
 
 ## Demo
 
-> <img src="https://github.com/magus/git-multi-diff-playground/assets/290084/cc583c01-4c3b-4416-b6a5-9702e5401c1b" width="720">
+> <img src="https://github.com/magus/git-multi-diff-playground/assets/290084/069c304b-80cb-49a9-9dc6-4ed3b061a5bc">
 
 ## Install
 
 ```bash
 npm i -g git-stack-cli
+```
+
+## Usage
+
 
+```bash
 git stack
-```
 
+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
+```
 
 ## Why?
 
-Most developers might not see much reason to **preserve commit history** or **create multiple pull requests of smaller changes**.
-Often pushing all your commits to a single pull request is the simplest and fastest approach to development.
-However, there is a cost to this, your teammates have to review larger, less related pieces of code and you will lose some of your atomic commit history if you squahs and merge.
+The goal of `git stack` is to combine the **simplicity of developing in a single branch** in order to **preserve your commit history** while also **grouping commits into pull requests for code review**.
 
+Often pushing all your commits to a single pull request is the simplest and fastest approach to development.
+This comes at a price, your teammates have to review larger, less related pieces of code and you will lose some of your atomic commit history if you "Squash and merge".
 
-Okay, so you decide to break changes up. This process is commonly referred to as **[stacked diffs](https://graphite.dev/guides/stacked-diffs)** (pull requests that depend on other pull requests).
-Manually this means managing multiple local branches, jumping between them, rebasing, etc.
+When you decide to break changes up into multiple diffs that depend on one another this process is commonly referred to as **[stacked diffs](https://graphite.dev/guides/stacked-diffs)** (pull requests that depend on other pull requests).
+This appraoch is popular at many major comparnies such as Twitter, Facebook, etc.
+Managing stacked diffs manually involves managing multiple local branches, jumping between them, rebasing, etc.
 This process gets even more complicated when you start getting feedback in code review and have to update individual branches.
 Managing even a few stacked diffs requires a relatively strong knowledge of `git`, even with tricks like [`--update-refs`](https://git-scm.com/docs/git-rebase#Documentation/git-rebase.txt---update-refs).
 
-The goal of `git stack` is to combine the **simplicity of developing in a single branch** in order to **preserve your commit history** while also **grouping commits into pull requests for code review**.
 
 ## How is this different than **`x`**
 

package/dist/app/LocalMergeRebase.js

@@ -17,9 +17,11 @@ export function LocalMergeRebase() {
 async function run() {
     const state = Store.getState();
     const actions = state.actions;
+    const argv = state.argv;
     const branch_name = state.branch_name;
     const commit_range = state.commit_range;
     const master_branch = state.master_branch;
+    invariant(argv, "argv must exist");
     invariant(branch_name, "branch_name must exist");
     invariant(commit_range, "commit_range must exist");
     // always listen for SIGINT event and restore git state
@@ -51,7 +53,11 @@ async function run() {
                         commit_message: React.createElement(Brackets, null, commit.message),
                     } }));
             }
-            await cli(`git cherry-pick ${commit.sha}`);
+            const git_cherry_pick_command = [`git cherry-pick ${commit.sha}`];
+            if (argv.verify === false) {
+                git_cherry_pick_command.push("--no-verify");
+            }
+            await cli(git_cherry_pick_command);
             if (commit.branch_id && !commit_pr) {
                 if (actions.isDebug()) {
                     actions.output(React.createElement(FormatText, { wrapper: React.createElement(Ink.Text, { color: colors.yellow, wrap: "truncate-end" }), message: "Cleaning up unused group {group}", values: {

package/dist/app/ManualRebase.js

@@ -57,7 +57,11 @@ async function run(props) {
             const selected_url = get_group_url(group);
             // cherry-pick and amend commits one by one
             for (const commit of group.commits) {
-                await cli(`git cherry-pick ${commit.sha}`);
+                const git_cherry_pick_command = [`git cherry-pick ${commit.sha}`];
+                if (argv.verify === false) {
+                    git_cherry_pick_command.push("--no-verify");
+                }
+                await cli(git_cherry_pick_command);
                 if (commit.branch_id !== group.id) {
                     const new_message = await Metadata.write(commit.message, group.id);
                     await cli(`git commit --amend -m "${new_message}"`);
@@ -72,7 +76,7 @@ async function run(props) {
                 if (argv.verify === false) {
                     git_push_command.push("--no-verify");
                 }
-                await cli(git_push_command.join(" "));
+                await cli(git_push_command);
                 if (group.pr) {
                     // ensure base matches pr in github
                     await github.pr_edit({

package/dist/command.js

@@ -19,13 +19,13 @@ export async function command() {
         .option("verify", {
         type: "boolean",
         default: true,
-        description: "Disable the pre-push hook, bypassing it completely",
+        description: "Skip git hooks such as pre-commit and pre-push",
     })
         .option("verbose", {
         type: "boolean",
         alias: ["v"],
         default: false,
-        description: "Enable verbose mode with more detailed output for debugging",
+        description: "Print more detailed logs for debugging internals",
     })
         .option("branch", {
         type: "string",

package/dist/core/cli.js

@@ -1,8 +1,15 @@
 import * as child from "node:child_process";
 import { Store } from "../app/Store.js";
-export async function cli(command, unsafe_options) {
+export async function cli(unsafe_command, unsafe_options) {
     const state = Store.getState();
     const options = Object.assign({}, unsafe_options);
+    let command;
+    if (Array.isArray(unsafe_command)) {
+        command = unsafe_command.join(" ");
+    }
+    else {
+        command = unsafe_command;
+    }
     return new Promise((resolve, reject) => {
         const childProcess = child.spawn("sh", ["-c", command], options);
         let stdout = "";

package/package.json

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