https://github.com/deponian/nvim-scalpelua
Distant relative of Greg Hurrell's Scalpel
https://github.com/deponian/nvim-scalpelua
minimap neovim neovim-plugin replace-text scalpel
Last synced: 15 days ago
JSON representation
Distant relative of Greg Hurrell's Scalpel
- Host: GitHub
- URL: https://github.com/deponian/nvim-scalpelua
- Owner: deponian
- License: mit
- Created: 2023-05-13T21:40:15.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-09-15T23:35:29.000Z (9 months ago)
- Last Synced: 2025-09-16T01:18:46.404Z (9 months ago)
- Topics: minimap, neovim, neovim-plugin, replace-text, scalpel
- Language: Lua
- Homepage:
- Size: 1000 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
### 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](https://neovim.io/doc/user/options.html#'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](./CHANGELOG.md) or on [releases page](https://github.com/deponian/nvim-scalpelua/releases).
Examples for some package managers:
#### vim-plug
```vim
Plug 'deponian/nvim-scalpelua'
Plug 'deponian/mini.map' " optional
```
#### lazy
Importing file below or directory it is contained on lazy setup.
```lua
return {
"deponian/nvim-scalpelua",
version = "*",
dependencies = {
"deponian/mini.map",
},
config = function()
require("scalpelua").setup()
end,
}
```
### Usage
Map `(Scalpelua)` to replace selected sequence or `(ScalpeluaMultiline)` to replace something inside selected sequence.
```lua
vim.keymap.set('v', "r", "(Scalpelua)")
vim.keymap.set('v', "R", "(ScalpeluaMultiline)")
vim.keymap.set('n', "r", "(Scalpelua)")
```
or
```vim
vmap r (Scalpelua)
vmap R (ScalpelMultiline)
nmap r (Scalpelua)
```
### Configuration
These are default options. You can run empty `require('scalpelua').setup()` if these options suit you.
```lua
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",
},
-- 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
-- save pattern and replacement strings to use them
-- as defaults in the next :Scalpelua command
pattern_register = "p",
replacement_register = "r"
})
```
### mini.map integration
You can enable integration with [mini.map plugin](https://github.com/echasnovski/mini.map) 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](https://github.com/deponian/mini.map) 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](https://github.com/wincent/scalpel) plugin that I've been using for the past few years.
Thanks to Evgeni Chasnovski and his great [mini.map](https://github.com/echasnovski/mini.map) plugin.