emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
doomemacs/modules/ui/vc-gutter
History
Henrik Lissner 037b018cdd
feat: add .doommodule files 
These optional dotfiles indicate the root of a module or module
group (:lang), and will later contain module metadata. They will also
serve as an alternative to packages.el and doctor.el, and will aide the
parts of the v3.0 module API concerned with resolving the current module
from a path (`doom-module-from-path`), which currently rely too heavily
on parsing path strings.

For now, however, they're simply placeholders.
2024-09-14 20:47:39 -04:00
..
autoload refactor!(vc-gutter): drop git-gutter for diff-hl 2024-06-22 18:14:04 -04:00
.doommodule feat: add .doommodule files 2024-09-14 20:47:39 -04:00
config.el fix(dired,vc-gutter): don't inhibit diff-hl-dired-mode 2024-08-29 01:12:29 -04:00
packages.el bump: :ui 2024-08-08 17:26:58 -04:00
README.org refactor!(vc-gutter): drop git-gutter for diff-hl 2024-06-22 18:14:04 -04: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

+pretty
Apply some stylistic defaults to the fringe that present the diff in the fringe as thin bars, taking after the modern look of the git-gutter plugin in VSCode and Sublime Text. However, this will look bad with themes that invert the foreground/background of 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 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.
  • 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.

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?