The Multicursor Plugin for Neovim extends the native Neovim text editing capabilities, providing a more intuitive way to edit repetitive text with multiple cursors. With this plugin, you can easily create and manage multiple cursors, perform simultaneous edits, and execute commands on all cursors at once.
- Neovim >= 0.9.0
Install with your preferred package manager:
{
"smoka7/multicursors.nvim",
event = "VeryLazy",
dependencies = {
'nvim-treesitter/nvim-treesitter',
'smoka7/hydra.nvim',
},
opts = function()
local N = require 'multicursors.normal_mode'
local I = require 'multicursors.insert_mode'
return {
normal_keys = {
-- to change default lhs of key mapping change the key
[','] = {
-- assigning nil to method exits from multi cursor mode
method = N.clear_others,
-- you can pass :map-arguments here
opts = { desc = 'Clear others' },
},
},
insert_keys = {
-- to change default lhs of key mapping change the key
['<CR>'] = {
-- assigning nil to method exits from multi cursor mode
method = I.Cr_method,
-- you can pass :map-arguments here
opts = { desc = 'New line' },
},
},
}
end,
cmd = { 'MCstart', 'MCvisual', 'MCclear', 'MCpattern', 'MCvisualPattern', 'MCunderCursor' },
keys = {
{
mode = { 'v', 'n' },
'<Leader>m',
'<cmd>MCstart<cr>',
desc = 'Create a selection for selcted text or word under the cursor',
},
},
}Click me
{
DEBUG_MODE = false,
create_commands = true, -- create Multicursor user commands
updatetime = 50, -- selections get updated if this many milliseconds nothing is typed in the insert mode see :help updatetime
nowait = true, -- see :help :map-nowait
normal_keys = normal_keys,
insert_keys = insert_keys
extend_keys = extend_keys
-- see :help hydra-config.hint
hint_config = {
border = 'none',
position = 'bottom',
},
-- accepted values:
-- -1 true: generate hints
-- -2 false: don't generate hints
-- -3 [[multi line string]] provide your own hints
generate_hints = {
normal = false,
insert = false,
extend = false,
},
}| Command | Description |
|---|---|
| MCstart | Selects the word under cursor and starts listening for the actions. In visual mode it acts like MCvisual |
| MCvisual | Selects the last visual mode selection and starts listening for the actions. |
| MCpattern | Prompts for a pattern and selects every match in the buffer. |
| MCvisualPattern | Prompts for a pattern and selects every match in the visual selection. |
| MCunderCursor | Selects the char under cursor and starts listening for the actions. |
| MCclear | Clears all the selection. |
To enter multi cursor mode, use the one of above commands.
Note that keys which aren't mapped do not affect other selections .
Click me
| Key | Description |
|---|---|
<Esc> |
Clear the selections and go back to normal mode |
<C-c> |
Clear the selections and go back to normal mode |
i |
Enters insert mode |
a |
Enters append mode |
e |
Enters extend mode |
c |
Deletes the text inside selections and starts insert mode |
n |
[count] Finds the next match after the main selection |
N |
[count] Finds the previous match before the main selection |
q |
[count] Skips the current selection and finds the next one |
Q |
[count] Skips the current selection and finds the previous one |
] |
[count] Swaps the main selection with next selection |
[ |
[count] Swaps the main selection with previous selection |
} |
[count] Deletes the main selection and goes to next |
{ |
[count] Deletes the main selection and goes to previous |
j |
[count] Creates a selection on the char below the cursor |
J |
[count] Skips the current selection and Creates a selection on the char below |
k |
[count] Creates a selection on the char above the cursor |
K |
[count] Skips the current selection and Creates a selection on the char above |
p |
Puts the text inside unnamed register before selections |
P |
Puts the text inside unnamed register after selections |
y |
Yanks the text inside selection to unnamed register |
Y |
Yanks the text from start of selection till end of line to unnamed register |
yy |
Yanks the line of selection to unnamed register |
z |
Aligns selections by adding space before selections |
Z |
Aligns selections by adding space at beginning of line |
d |
Deletes the text inside selections |
D |
count Deletes the text from start of selection till end of line |
dd |
count Deletes line of selections |
@ |
Executes a macro at beginning of every selection |
. |
Reapets last change at the beginning of every selection |
, |
Clears All Selections except the main one |
: |
Prompts for a normal command and Executes it at beginning of every selection |
u |
Undo changes |
<C-r> |
Redo changes |
Click me
| Key | Description |
|---|---|
<Esc> |
Goes back to multicursor normal mode |
<C-c> |
Goes back to multicursor normal mode |
<BS> |
Deletes the char before the selections |
<Del> |
Deletes the char under the selections |
<Left> |
Moves the selections one char Left |
<Up> |
Moves the selections one line Up |
<Right> |
Moves the selections one char Right |
<Down> |
Moves the selections one line Down |
<C-Left> |
Moves the selections one word Left |
<C-Right> |
Moves the selections one word Right |
<Home> |
Moves the selections to start of line |
<End> |
Moves the selections to end of line |
<CR> |
Insert one line below the selections |
<C-j> |
Insert one line below the selections |
<C-v> |
Pastes the text from system clipboard |
<C-r> |
Insert the contents of a register |
<C-w> |
Deletes one word before the selections |
<C-BS> |
Deletes one word before the selections |
<C-u> |
Deletes froms start of selections till start of line |
Once you enter the Extend mode, you have the ability to expand or shrink your selections using Vim motions. The anchor represents one side of the selection and stays put, while the other side moves based on the performed motion.
Click me
| Key | Description |
|---|---|
<Esc> |
Goes back to multicursor normal mode |
c |
Prompts user for a motion and performs it |
o |
Toggles the anchor's side |
O |
Toggles the anchor's side |
w |
[count] word foreward |
e |
[count] foreward to end of word |
b |
[count] word backward |
h |
[count] char left |
j |
[count] char down |
k |
[count] char up |
l |
[count] char right |
t |
Extends the selection to the parent of selected node |
r |
Shrinks the selection to first child of selected node |
y |
Shrinks the selection to last child of selected node |
u |
Undo Last selections extend or shrink |
$ |
[count] to end of line |
^ |
To the first non-blank character of the line |
Create custom mapping for editing selections.
require('multicursors').setup {
normal_keys = {
['<C-/>'] = {
method = function()
require('multicursors.utils').call_on_selections(function(selection)
vim.api.nvim_win_set_cursor(0, { selection.row + 1, selection.col + 1 })
local line_count = selection.end_row - selection.row + 1
vim.cmd('normal ' .. line_count .. 'gcc')
end)
end,
opts = { desc = 'comment selections' },
},
},
}Disable hint window and show the multicursor mode in your status line.
require('multicursors').setup {
hint_config = false,
}
local function is_active()
local ok, hydra = pcall(require, 'hydra.statusline')
return ok and hydra.is_active()
end
local function get_name()
local ok, hydra = pcall(require, 'hydra.statusline')
if ok then
return hydra.get_name()
end
return ''
end
---for lualine add this component
lualine_b = {
{ get_name, cond = is_active },
}