Description

This plugin helps to replace all instances of selected sequence in the buffer in absolutely literal way. It doesn't use any of Vimscript search commands, so no magic, no backslashes, no nothing. You replace exactly what you've selected.

Installation

Install via your preferred package manager:

• deponian/nvim-scalpelua
• deponian/mini.map for integration with mini.map (optional) (see below)

You can check current version in changelog or on releases page.

Examples for some package managers:

vim-plug

Plug 'deponian/nvim-scalpelua'
Plug 'deponian/mini.map' " optional

lazy

Importing file below or directory it is contained on lazy setup.

return {
  "deponian/nvim-scalpelua",
  version = "*",
  dependencies = {
    "deponian/mini.map",
  },
  config = function()
    require("scalpelua").setup()
  end,
}

Usage

Map <Plug>(Scalpelua) to replace selected sequence or <Plug>(ScalpeluaMultiline) to replace something inside selected sequence.

vim.keymap.set('v', "<leader>r", "<Plug>(Scalpelua)")
vim.keymap.set('v', "<leader>R", "<Plug>(ScalpeluaMultiline)")

or

vmap <Leader>r <Plug>(Scalpel)
vmap <Leader>R <Plug>(ScalpelMultiline)

Configuration

These are default options. You can run empty require('scalpelua').setup() if these options suit you.

require("scalpelua").setup({
  -- enable/disable integration with mini.map plugin (see below)
  minimap_enabled = false,
  -- separator between pattern and replacement in command line
  separator = "»",
  -- names of highlighting groups
  highlighting = {
    regular_search_pattern = "Search",
    current_search_pattern = "WildMenu",
    minimap_integration = "Constant",
  },
  -- choose some dim highlighting group for surrounding lines
  -- to make current pattern more visible
  -- highlight {range} lines before and {range} lines after current line with {group}
  dehighlighting = {
    enabled = false,
    group = "LineNr",
    range = 3
  },
  -- save pattern to "/" register (see :h quote/)
  -- it's useful if you want to run n, N, * and
  -- other search related commands after replacement
  save_search_pattern = true
})

mini.map integration

You can enable integration with mini.map plugin by setting minimap_enabled = true in your configuration. This way you will see all found instances of the pattern in your mini.map window and it will be updated every time you replace new pattern pressing y key.

Notice: original mini.map plugin doesn't expose some internal functions that are necessary during the replacement process, so I've created highly complicated fork with three (!) new lines of code. Use it if you want to enable mini.map integration with Scalpelua plugin.

Acknowledgements

Thanks to Greg Hurrell and his Scalpel plugin that I've been using for the past few years.

Thanks to Evgeni Chasnovski and his great mini.map plugin.