History

Henrik Lissner ad6a3d0f33 refactor: deprecate featurep! for modulep! featurep! will be renamed modulep! in the future, so it's been deprecated. They have identical interfaces, and can be replaced without issue. featurep! was never quite the right name for this macro. It implied that it had some connection to featurep, which it doesn't (only that it was similar in purpose; still, Doom modules are not features). To undo such implications and be consistent with its namespace (and since we're heading into a storm of breaking changes with the v3 release anyway), now was the best opportunity to begin the transition.		2022-08-14 20:43:35 +02:00
..
autoload	refactor: deprecate featurep! for modulep!	2022-08-14 20:43:35 +02:00
config.el	refactor: deprecate featurep! for modulep!	2022-08-14 20:43:35 +02:00
packages.el	refactor: deprecate featurep! for modulep!	2022-08-14 20:43:35 +02:00
README.org	docs(vc-gutter): document module's hacks	2022-08-10 13:18:34 +02:00

:ui vc-gutter

Description unfold

This module displays a diff of the current file (against HEAD) in the fringe. Supports Git, Svn, Hg, and Bzr.

+diff-hl: Use diff-hl instead of git-gutter to power the VC gutter. It is a little faster, but is slightly more prone to visual glitching. diff-hl is intended to replace git-gutter at some point in the future.
+pretty: Apply some stylistic defaults to the fringe, enabling thin bars in the fringe. This look takes after the modern look of git-gutter in VSCode and Sublime Text, without sacrificing on fringe width (which squeeze other indicators, like flycheck's, flymake's, or flyspell's). However, this will look bad with themes that invert the foreground/background of either git-gutter's or diff-hl's faces (like modus-themes does).

The VC gutter will be updated when pressing ESC, leaving insert mode (evil users), or refocusing the frame or window where it is active.
If +pretty is enabled
- The fringes that both git-gutter-fringe and diff-hl define will be replaced with a set of thin bars. This achieves a slicker look closer to git-gutter's appearance in VSCode or Sublime Text, but may look weird for themes that swap their faces' :foreground and :background (like modus-themes).
- The fringes are moved to the outside of the margins (closest to the frame edge), so they have some breathing space away from the buffer's contents.
If +diff-hl is enabled:
- diff-hl-revert-hunk displays a preview popup of the hunk being reverted. It takes up ~50% of the frame, by default, whether you're reverting 2 lines or 20. Since this isn't easily customized, it has been advised to shrink this popup to the side of its contents.
- diff-hl-revert-hunk will sometimes move the cursor to an unexpected location (the bounds of hunks, is my guess), but this is not intuitive and often unexpected. Cursor movements have been suppressed for it.
If +diff-hl is not enabled:
- Sometimes, git-gutter:next-hunk and git-gutter:previous-hunk get confused about the order of hunks. They have been advised to fix this (although the hack is a little inefficient).

This module does not have a changelog yet.

This module requires any of Git, Svn, Hg, and/or Bazaar to get gutter diffs in projects version controlled by them.

🔨 This module has no usage documentation yet. Write some?

🔨 This module has no configuration documentation yet. Write some?

There are no known problems with this module. Report one?

This module has no FAQs yet. Ask one?

🔨 This module has no appendix yet. Write one?