nixvim docs

plugins.nvim-surround.settings

Options provided to the require('nvim-surround').setup function.

Type: attribute set of anything

Default: { }

Example:

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

Declared by:

• <nixvim/plugins/by-name/nvim-surround>

plugins.nvim-surround.settings.aliases

Maps characters to other characters, or lists of characters.

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

Default: null

Plugin default:

''
  {
    "a" = ">";
    "b" = ")";
    "B" = "}";
    "r" = "]";
    "q" = [ "\"" "'" "`" ];
    "s" = [ "}" "]" ")" ">" "\"" "'" "`" ];
  }
''

Declared by:

• <nixvim/plugins/by-name/nvim-surround>

plugins.nvim-surround.settings.keymaps

Defines the keymaps used to perform surround actions.

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

Default: null

Plugin default:

''
  {
    insert = "<C-g>s";
    insert_line = "<C-g>S";
    normal = "ys";
    normal_cur = "yss";
    normal_line = "yS";
    normal_cur_line = "ySS";
    visual = "S";
    visual_line = "gS";
    delete = "ds";
    change = "cs";
    change_line = "cS";
  }
''

Declared by:

• <nixvim/plugins/by-name/nvim-surround>

plugins.nvim-surround.settings.surrounds

Associates each key with a “surround”. The attribute set contains the ‘add’, ‘find’, ‘delete’, and ‘change’ keys.

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

Default: null

Plugin default: See upstream default configuration

Declared by:

• <nixvim/plugins/by-name/nvim-surround>