plugins.spectre.settings

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

Type: attribute set of anything

Default: { }

Example:

{
  default = {
    find = {
      cmd = "rg";
      options = [
        "word"
        "hidden"
      ];
    };
    replace = {
      cmd = "sed";
    };
  };
  find_engine = {
    rg = {
      args = [
        "--color=never"
        "--no-heading"
        "--with-filename"
        "--line-number"
        "--column"
      ];
      cmd = "rg";
      options = {
        hidden = {
          desc = "hidden file";
          icon = "[H]";
          value = "--hidden";
        };
        ignore-case = {
          desc = "ignore case";
          icon = "[I]";
          value = "--ignore-case";
        };
        line = {
          desc = "match in line";
          icon = "[L]";
          value = "-x";
        };
        word = {
          desc = "match in word";
          icon = "[W]";
          value = "-w";
        };
      };
    };
  };
  is_insert_mode = false;
  live_update = true;
}

Declared by:

plugins.spectre.settings.color_devicons

Whether to enable color devicons.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.spectre.settings.highlight

Highlight groups.

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

Default: null

Plugin default:

{
  border = "SpectreBorder";
  filedirectory = "SpectreDir";
  filename = "SpectreFile";
  headers = "SpectreHeader";
  replace = "SpectreReplace";
  search = "SpectreSearch";
  ui = "SpectreBody";
}

Declared by:

plugins.spectre.settings.is_block_ui_break

Mapping backspace and enter key to avoid ui break.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.spectre.settings.is_insert_mode

Start open panel in insert mode.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.spectre.settings.is_open_target_win

Open file on opener window.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.spectre.settings.line_sep

Line separator.

Type: null or string or raw lua code

Default: null

Plugin default: "└──────────────────────────────────────────────────────"

Declared by:

plugins.spectre.settings.line_sep_start

Start of the line separator

Type: null or string or raw lua code

Default: null

Plugin default: "┌──────────────────────────────────────────────────────"

Declared by:

plugins.spectre.settings.live_update

Auto execute search again when you write to any file in vim.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.spectre.settings.lnum_for_results

Show line number for search/replace results.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.spectre.settings.open_cmd

The open command.

Type: null or string or raw lua code

Default: null

Plugin default: "vnew"

Declared by:

plugins.spectre.settings.replace_vim_cmd

The replace command to use within vim.

Type: null or string or raw lua code

Default: null

Plugin default: "cdo"

Declared by:

plugins.spectre.settings.result_padding

Result padding string.

Type: null or string or raw lua code

Default: null

Plugin default: "│ "

Declared by: