GitSavvy Documentation

When defining the args array for a gs_custom command, you can use specific placeholder strings that GitSavvy will automatically substitute at runtime:

• {FILE_PATH}: The path to the currently opened file.
• {REPO_PATH}: The path to the repository of the currently opened file.
• {PROMPT_ARG}: Triggers a user prompt. The text of this prompt is determined by the prompt_msg configuration key.

The Rebase dashboard allows you to manage the history of your current branch by re-ordering, squashing, or editing commits.

Important Constraints:

• You cannot manipulate commits if the current branch is not connected to a base-ref. You must select a base-ref or perform a rebase first.
• Most manipulation commands (squashing, moving, editing) cannot be performed while a rebase operation is currently in progress.

The Repo History view is a central hub for Git operations. Key interactions include:

• Navigation: Use [n] and [p] to walk the reflog (useful for checking or undoing a rebase).
• Filtering: Use [s] to hide all commits and view only branches and tags. Use [ctrl+r] to search and select a branch or tag.
• Commit Details: Position the cursor on a commit and press [o] to see the full commit/patch. Use [p] and [n] to walk the history.
• Editing: Use [W] to reWord a commit message.
• Diffing: Select two commits with [space] and press [enter] to open a diff between them.
• Rebasing: Use [r] to open the rebase menu. If you have fixup or squash commits, the rebase menu provides specific actions to apply them to their associated commits.

GitSavvy uses DeferrableTestCase for its unit tests, which are executed by the DeferringTextTestRunner. This runner supports using Python generators as test functions to handle asynchronous-style waiting or conditional polling.

When a test function is a generator, the runner behaves based on the yielded object:

• Yielding a callable: The runner evaluates the callable. If it returns True, the generator continues immediately. If it returns False, the runner waits until the condition becomes True.
• Yielding an integer (x): The runner pauses the generator for x milliseconds before continuing.
• Yielding anything else: The runner pauses the generator for a default of 10 ms.

The git diff view in GitSavvy allows you to manipulate your current working state by staging, unstaging, or resetting (discarding) changes at multiple granularities:

• Files
• Hunks
• Individual lines

Use the flow: feature/release/hotfix/support finish command to complete a branch lifecycle.

• If the relevant branch is currently checked out, you will be asked to confirm the finish.
• If it is not checked out, you will be prompted to select the branch you wish to finish.

This command merges the changes from the target branch into the develop branch (performing a non-fast-forward merge unless the branch contains only a single commit).

Use the flow: feature/release/hotfix publish command to push a branch to its configured remote.

• If the branch is currently checked out, you will be asked to confirm the publish.
• If it is not checked out, you will be prompted to select the relevant branch.

This action pushes the target branch to the configured remote.