emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
doomemacs/modules/ui/vc-gutter
History
Henrik Lissner 665d808d09
bump: :ui 
Alexander-Miller/treemacs@df26b6ab9a -> Alexander-Miller/treemacs@8c6df39f01
dgutov/diff-hl@b8b2727a72 -> dgutov/diff-hl@9662083943
doomemacs/themes@ff26f26ea3 -> doomemacs/themes@37d2182f50
jrblevin/deft@28be94d89b -> jrblevin/deft@bb1a16b87c
seagle0128/doom-modeline@bf880ae56f -> seagle0128/doom-modeline@e09b8e989f
2024-03-21 12:02:02 -04:00
..
autoload refactor: deprecate featurep! for modulep! 2022-08-14 20:43:35 +02:00
config.el fix(format): handle git-gutter nicely 2023-09-13 20:21:01 +01:00
packages.el bump: :ui 2024-03-21 12:02:02 -04:00
README.org docs(*): replace all-the-icons with nerd-icons 2023-09-16 20:19:11 +02:00

README.org

: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.

Maintainers

Become a maintainer?

Module flags

+diff-hl
Use doom-package:diff-hl instead of git-gutter to power the VC gutter. It is a little faster, but is slightly more prone to visual glitching. doom-package: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).

Packages

Hacks

  • 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 doom-module:+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 doom-package:+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).

TODO Changelog

This module does not have a changelog yet.

Installation

Enable this module in your doom! block.

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

TODO Usage

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

TODO Configuration

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

Troubleshooting

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

Frequently asked questions

This module has no FAQs yet. Ask one?

TODO Appendix

󱌣 This module has no appendix yet. Write one?