plugins.inc-rename.settings

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

Type: attribute set of anything

Default: { }

Example:

{
  input_buffer_type = "dressing";
  preview_empty_name = false;
  show_message = {
    __raw = ''
      function(msg)
        vim.notify(msg, vim.log.levels.INFO, { title = "Rename" })
      end
    '';
  };
}

Declared by:

plugins.inc-rename.settings.cmd_name

The name of the command.

Type: null or string or raw lua code

Default: null

Plugin default: "IncRename"

Declared by:

plugins.inc-rename.settings.hl_group

The highlight group used for highlighting the identifier’s new name.

Type: null or string or raw lua code

Default: null

Plugin default: "Substitute"

Declared by:

plugins.inc-rename.settings.input_buffer_type

The type of the external input buffer to use.

Type: null or value “dressing” (singular enum)

Default: null

Plugin default: null

Declared by:

plugins.inc-rename.settings.post_hook

Callback to run after renaming, receives the result table (from LSP handler) as an argument.

Type: null or raw lua code

Default: null

Plugin default: null

Declared by:

plugins.inc-rename.settings.preview_empty_name

Whether an empty new name should be previewed; if false the command preview will be cancelled instead.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.inc-rename.settings.save_in_cmdline_history

Whether to save the IncRename command in the commandline history. Set to false to prevent issues with navigating to older entries that may arise due to the behavior of command preview).

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.inc-rename.settings.show_message

Whether to display a Renamed m instances in n files message after a rename operation.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by: