doomemacs/modules/tools/magit

:tools magit

• Description
  • Maintainers
  • Module flags
  • Packages
  • Hacks
  • Changelog
• Installation
• Usage
• Configuration
  • Enable Gravatars
  • Enable granular diff-highlights for all hunks
• Troubleshooting
• Frequently asked questions
  • "I recently updated and now I get 'deferred error : (wrong-type-argument sequencep code-review–auth-token-set\?)' whenever I try to review'"
• Appendix

Description   unfold

This module provides Magit, an interface to the Git version control system.

Maintainers

• @hlissner

Become a maintainer?

Module flags

+forge

Enable Forge; a porcelain for managing Github issues and PRs from within Emacs. Will take a while on first run to build emacsql-sqlite.

Packages

• doom-package:evil-magit if doom-module::editor evil +everywhere
• doom-package:forge if doom-module:+forge
• doom-package:code-review if doom-module:+forge
• doom-package:magit
• doom-package:magit-todos

Hacks

• doom-package:magit has been modified to recognize $XDG_CACHE_HOME/git/credential/socket.
• doom-package:magit has been modified to invalidate the projectile cache when you check out a new branch or commit.
• doom-package:magit has been modified to revert repo buffers (e.g. after changing branches) when you later switch to them, rather than all at once.
• doom-package:forge was modified to defer compilation of emacsql-sqlite until you try to use forge, rather than when magit first loads (which could be as soon as startup).

TODO Changelog

This module does not have a changelog yet.

Installation

Enable this module in your doom! block.

This module requires:

• Git
• doom-module:+forge requires a Github API token
• doom-package:code-review will also require a token setup (see configuration for your particular forge)

TODO Usage

🔨 This module's usage documentation is incomplete. Complete it?

Start magit with <leader> g g (M-x magit-status).

If you are new to Magit, see the Getting Started section of its project readme.

TODO Configuration

🔨 This module's configuration documentation is incomplete. Complete it?

Enable Gravatars

To enable gravatars when viewing commits:

;; in $DOOMDIR/config.el
(after! magit
  (setq magit-revision-show-gravatars '("^Author:     " . "^Commit:     ")))

Enable granular diff-highlights for all hunks

By default, changes are highlighted linewise for all but the selected hunk. This is so for performance reasons. You can enable character-wise highlights for all visible hunks with:

;; in $DOOMDIR/config.el
(after! magit
  (setq magit-diff-refine-hunk 'all))

Troubleshooting

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

Frequently asked questions

"I recently updated and now I get 'deferred error : (wrong-type-argument sequencep code-review–auth-token-set\?)' whenever I try to review'"

The previous package "github-review" was replaced with a package that supercedes it called "code-review", which requires a simple change in your authinfo file.

machine api.github.com login yourlogin^github-review password MYTOKENGOESHERE

becomes

machine api.github.com login yourlogin^code-review password MYTOKENGOESHERE

TODO Appendix

🔨 This module has no appendix yet. Write one?