smoka7 / multicursors.nvim

A multi cursor plugin for Neovim.

Multicursors.nvim

The Multicursor Plugin for Neovim extends the native Neovim text editing capabilities, providing a more intuitive way to edit repetitive text with multiple selections. With this plugin, you can easily create and manage multiple selections, perform simultaneous edits, and execute commands on all selections at once.

Requirements

• Neovim >= 0.9.0

Installation

Install with your preferred package manager:

-- lazy.nvim:
{
    "smoka7/multicursors.nvim",
    event = "VeryLazy",
    dependencies = {
        'smoka7/hydra.nvim',
    },
    opts = {},
    cmd = { 'MCstart', 'MCvisual', 'MCclear', 'MCpattern', 'MCvisualPattern', 'MCunderCursor' },
    keys = {
            {
                mode = { 'v', 'n' },
                '<Leader>m',
                '<cmd>MCstart<cr>',
                desc = 'Create a selection for selected text or word under the cursor',
            },
        },
}

Default Configuration

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
    mode_keys = {
        append = 'a',
        change = 'c',
        extend = 'e',
        insert = 'i',
    }, -- set bindings to start these modes
    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
    -- -4 fun(heads: Head[]): string - provide your own hints
    generate_hints = {
        normal = true,
        insert = true,
        extend = true,
        config = {
             -- determines how many columns are used to display the hints. If you leave this option nil, the number of columns will depend on the size of your window.
            column_count = nil,
            -- maximum width of a column.
            max_hint_length = 25,
        }
    },
}

Usage

Command	Description
MCstart	Select the word under the cursor and start listening for the actions. In visual mode, it acts like MCvisual.
MCvisual	Select the last visual mode selection and start 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	Select the char under the cursor and start listening for the actions.
MCclear	Clears all the selections.

To enter Multicursor mode, use one of the above commands.

Multi cursor mode

Important

Keys that aren't mapped do not affect other selections .

Click to see mappings.

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
<C-a>	Creates selections for all the matches
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
<C-n>	Creates a selection for the char under the cursor
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
r	Replaces the text inside selections with content of unnamed register
p	Puts the text inside unnamed register before selections
P	Puts the text inside unnamed register after selections
y	Yanks the text inside selections to unnamed register
Y	Yanks the text from the start of selection till the end of the line to unnamed register
yy	Yanks the line of selection to unnamed register
gu	changes selections case to lowercase
gU	changes selections case to UPPERCASE
z	Aligns selections by adding space before selections
Z	Aligns selections by adding space at the start of the line
d	Deletes the text inside selections
D	count Deletes the text from the start of selections till the end of the line
dd	count Deletes line of selections
@	Executes a macro at the start of selections
.	Repeats last change at the start of selections
,	Clears All Selections except the main one
:	Prompts for a normal command and Executes it at the start of selections
u	Undo changes
<C-r>	Redo changes

Insert, Append and Change mode:

Click to see mappings.

Key	Description
<Esc>	Returns to multicursor normal mode
<C-c>	Returns 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 from the start of selections till the start of line

Extend mode

Once you enter the Extend mode, you can expand or shrink your selections using Vim motions or Treesitter nodes. At first, the left side of the selections stays put, and selections get extended from the right side. But you can change which side of selections stay put by pressing o.

Click to see mappings.

Key	Description
<Esc>	Returns to multicursor normal mode
c	Prompts user for a motion and performs it
o	Toggles the anchor side
O	Toggles the anchor side
w	[count] word forward
e	[count] forward 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 the selected node
r	Shrinks the selection to the first child of the selected node
y	Shrinks the selection to the last child of the selected node
u	Undo Last selections extend or shrink
$	[count] to end of line
^	To the first non-blank character of the line

Recipes

Custom mappings

Create custom mapping for editing selections.

 require('multicursors').setup {
    normal_keys = {
        -- to change default lhs of key mapping change the key
        [','] = {
            -- assigning nil to method exits from multi cursor mode
            -- assigning false to method removes the binding
            method = N.clear_others,
            -- you can pass :map-arguments here
            opts = { desc = 'Clear others' },
        },
        ['<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' },
        },
    },
}

Status Line module

Disable the hint window and show 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 },
 }

Vertical hints

A configuration like this can be used to show hints in a vertical window similar to helix.

 require('multicursors').setup {
    hint_config = {
        border = 'rounded',
        position = 'bottom-right',
    },
    generate_hints = {
        normal = true,
        insert = true,
        extend = true,
        config = {
            column_count = 1,
        },
    },
}

Highlight Groups

The following groups are used by multicursors.nvim and can be overriden:

Name	Description
MultiCursor	Multicursor selections.
MultiCursorMain	Main selection in which multicursor began.

Acknowledgment

vim-visual-multi hydra.nvim