plugins.gitmessenger.settings

The configuration options for gitmessenger without the git_messenger_ prefix.

For example, the following settings are equivialent to these :setglobal commands:

  • foo_bar = 1 -> :setglobal git_messenger_foo_bar=1
  • hello = "world" -> :setglobal git_messenger_hello="world"
  • some_toggle = true -> :setglobal git_messenger_some_toggle
  • other_toggle = false -> :setglobal nogit_messenger_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  extra_blame_args = "-w";
  floating_win_opts = {
    border = "single";
  };
  include_diff = "current";
}

Declared by:

plugins.gitmessenger.settings.always_into_popup

When this value is set to true, the cursor goes into a popup window when running :GitMessenger or <Plug>(git-messenger).

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.gitmessenger.settings.close_on_cursor_moved

A popup window is no longer closed automatically when moving a cursor after the window is shown up.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.gitmessenger.settings.conceal_word_diff_marker

When this value is set to true, markers for word diffs like [-, -], {+, +} are concealed. Set false when you don’t want to hide them.

Note: Word diff is enabled by typing r in a popup window.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.gitmessenger.settings.date_format

String value to format dates in popup window.

Please see :help strftime() to know the details of the format.

Type: null or string or raw lua code

Default: null

Plugin default: "%c"

Declared by:

plugins.gitmessenger.settings.extra_blame_args

When this variable is set the contents will be appended to the git blame command. Use it to add options (like -w).

Type: null or string or raw lua code

Default: null

Plugin default: ""

Declared by:

plugins.gitmessenger.settings.floating_win_opts

Options passed to nvim_open_win() on opening a popup window.

This is useful when you want to override some window options.

Type: null or (attribute set of (anything or raw lua code))

Default: null

Plugin default: { }

Example:

{
  border = "single";
}

Declared by:

plugins.gitmessenger.settings.git_command

git command to retrieve commit messages.

If your git executable is not in $PATH directories, please specify the path to the executable.

Type: null or string or raw lua code

Default: null

Plugin default: "git"

Declared by:

plugins.gitmessenger.settings.include_diff

When this value is not set to "none", a popup window includes diff hunks of the commit at showing up. "current" includes diff hunks of only current file in the commit. "all" includes all diff hunks in the commit.

Please note that typing d/D or r/R in popup window toggle showing diff hunks even if this value is set to "none".

Type: null or one of “none”, “current”, “all” or raw lua code

Default: null

Plugin default: "none"

Declared by:

plugins.gitmessenger.settings.into_popup_after_show

When this value is set to false, running :GitMessenger or <plug>(git-messenger) again after showing a popup does not move the cursor in the window.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.gitmessenger.settings.max_popup_height

Max lines of popup window in an integer value. Setting null means no limit.

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Plugin default: null

Declared by:

plugins.gitmessenger.settings.max_popup_width

Max characters of popup window in an integer value. Setting null means no limit.

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Plugin default: null

Declared by:

plugins.gitmessenger.settings.no_default_mappings

When this value is set, it does not define any key mappings.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.gitmessenger.settings.popup_content_margins

Setting true means adding margins in popup window. Blank lines at the top and bottom of popup content are inserted. And every line is indented with one whitespace character.

Setting false to this variable removes all the margins.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.gitmessenger.settings.preview_mods

This variable is effective only when opening preview window (on Neovim (0.3.0 or earlier) or Vim).

Command modifiers for opening preview window. The value will be passed as prefix of :pedit command.

For example, setting "botright" to the variable opens a preview window at bottom of the current window. Please see :help <mods> for more details.

Type: null or string or raw lua code

Default: null

Plugin default: ""

Declared by: