plugins.trouble.settings

Options provided to the require('trouble').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.trouble.settings.auto_close

Automatically close the list when you have no diagnostics.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.trouble.settings.auto_fold

Automatically fold a file trouble list at creation.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.trouble.settings.auto_jump

For the given modes, automatically jump if there is only a single result.

Type: null or (list of (string or raw lua code))

Default: null

Plugin default:

[
  "lsp_definitions"
]

Declared by:

plugins.trouble.settings.auto_open

Automatically open the list when you have diagnostics.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.trouble.settings.auto_preview

Automatically preview the location of the diagnostic. <esc> to close preview and go back to last window.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.trouble.settings.cycle_results

Whether to cycle item list when reaching beginning or end of list

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.trouble.settings.fold_closed

Icon used for closed folds

Type: null or string or raw lua code

Default: null

Plugin default: ""

Declared by:

plugins.trouble.settings.fold_open

Icon used for open folds

Type: null or string or raw lua code

Default: null

Plugin default: ""

Declared by:

plugins.trouble.settings.group

Group results by file

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.trouble.settings.height

Height of the trouble list when position is top or bottom.

Type: null or signed integer or floating point number or raw lua code

Default: null

Plugin default: 10

Declared by:

plugins.trouble.settings.icons

Use devicons for filenames

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.trouble.settings.include_declaration

For the given modes, include the declaration of the current symbol in the results.

Type: null or (list of (string or raw lua code))

Default: null

Plugin default:

[
  "lsp_references"
  "lsp_implementations"
  "lsp_definitions"
]

Declared by:

plugins.trouble.settings.indent_lines

Add an indent guide below the fold icons.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.trouble.settings.mode

Mode for default list

Type: null or one of “workspace_diagnostics”, “document_diagnostics”, “quickfix”, “lsp_references”, “loclist” or raw lua code

Default: null

Plugin default: "workspace_diagnostics"

Declared by:

plugins.trouble.settings.padding

Add an extra new line on top of the list

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.trouble.settings.position

Position of the list.

Type: null or one of “top”, “left”, “right”, “bottom” or raw lua code

Default: null

Plugin default: "bottom"

Declared by:

plugins.trouble.settings.use_diagnostic_signs

Enabling this will use the signs defined in your lsp client

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.trouble.settings.width

Width of the list when position is left or right.

Type: null or signed integer or floating point number or raw lua code

Default: null

Plugin default: 50

Declared by:

plugins.trouble.settings.win_config

Configuration for floating windows. See |nvim_open_win()|.

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

Default: null

Plugin default:

{
  border = "single";
}

Declared by: