StGit VSCode Support

A maintained fork of srydh/vscode-stgit. This fork is a drop-in replacement.

[!IMPORTANT]

You must uninstall the original samuelrydh.stgit extension before installing this one. Both contribute the same command and language identifiers, and VSCode has no way to resolve the conflict.

The main purpose of this extension is making it easy to modify, amend, reorder, squash or split commits during development with VSCode.

This extension provides a frontend to StGit, which is an external command line tool for managing patch series in the form of Git commits. Refer to the StGit homepage for more details about StGit.

The functionality of this extension is heavily inspired by a corresponding Emacs mode for StGit, originally written by David Kågedal.

Features

The StGit patch series is displayed in a window. StGit and Git operations, bound to various keyboard shortcuts, allow the series to be reworked as desired.

The extension also provides an Emacs-like diff mode, which among other things allows individual hunks to be applied, staged or split into smaller hunks.

While the StGit window is open, it follows the repository of the active file, including files in submodules.

Hint: To enter StGit, press Ctrl-C Ctrl-I or run the "StGit: Open..." command. In the StGit window, press h to list all available StGit operations.

Requirements

This extension requires StGit to be installed (the executable is called stg). The tool is available in most distributions (e.g. through "brew install stgit" on macOS). It can also be downloaded from GitHub here.

Git History Format

Git history entries use the effective format.pretty Git configuration. Custom format: and tformat: values and named pretty.<name> aliases are supported. Multiline output is flattened to one line, and terminal colors are omitted. If no reusable one-line format is configured, the extension uses %h %s.

Known Issues

The StGit extension can be used together with the popular Vim mode for VsCode, but there are currently a few key mapping conflicts for the StGit editor.

Release Notes

The latest release notes are available here.