plugins.muren.settings

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

Type: attribute set of anything

Default: { }

Example:

{
  create_commands = true;
  filetype_in_preview = true;
}

Declared by:

plugins.muren.settings.all_on_line

When enabled, all replacements are applied on the same line.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.muren.settings.anchor

Specify the location of the muren UI.

Type: null or one of “center”, “top”, “bottom”, “left”, “right”, “top_left”, “top_right”, “bottom_left”, “bottom_right” or raw lua code

Default: null

Plugin default: "center"

Declared by:

plugins.muren.settings.create_commands

Automatically creates commands for the plugin.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.muren.settings.cwd

Use the current working directory for replacements.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.muren.settings.files

Specify the file pattern for replacements.

Type: null or string or raw lua code

Default: null

Plugin default: "**/*"

Declared by:

plugins.muren.settings.filetype_in_preview

Applies file type highlighting in the preview window.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.muren.settings.horizontal_offset

Horizontal offset relative to the anchor.

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

Default: null

Plugin default: 0

Declared by:

plugins.muren.settings.keys

Specify the keyboard shortcuts for various actions.

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

Default: null

Plugin default:

{
  close = "q";
  do_redo = "<localleader>r";
  do_replace = "<CR>";
  do_undo = "<localleader>u";
  scroll_preview_down = "<Down>";
  scroll_preview_up = "<Up>";
  toggle_option_under_cursor = "<CR>";
  toggle_options_focus = "<C-s>";
  toggle_side = "<Tab>";
}

Declared by:

plugins.muren.settings.options_width

Width of the options panel.

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

Default: null

Plugin default: 20

Declared by:

plugins.muren.settings.order

Specify the order of options in the UI.

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

Default: null

Plugin default:

[
  "buffer"
  "dir"
  "files"
  "two_step"
  "all_on_line"
  "preview"
]

Declared by:

plugins.muren.settings.patterns_height

Height of the patterns panel.

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

Default: null

Plugin default: 10

Declared by:

plugins.muren.settings.patterns_width

Width of the patterns panel.

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

Default: null

Plugin default: 30

Declared by:

plugins.muren.settings.preview

Show a preview of the replacements.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.muren.settings.preview_height

Height of the preview panel.

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

Default: null

Plugin default: 12

Declared by:

plugins.muren.settings.two_step

Enables two-step replacements for non-recursive replacements.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.muren.settings.vertical_offset

Vertical offset relative to the anchor.

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

Default: null

Plugin default: 0

Declared by: