Skip to content

IdeaVim Plugins

IdeaVim Bot edited this page Mar 28, 2025 · 18 revisions

IdeaVim Plugins

IdeaVim plugins work like the original Vim plugins. If you want to turn any of them on, you have to enable it via this command in your ~/.ideavimrc:

Plug '<plugin-github-reference>'

If you reuse your existing .vimrc file using source ~/.vimrc, IdeaVim can parse and enable plugins that are defined using vim-plug or vundle. No additional set commands in ~/.ideavimrc are required.
If you'd like to disable some plugin that's enabled in .vimrc, you can use set no<extension-name> in ~/.ideavimrc. E.g. set nosurround.

Available plugins:

argtextobj: Provides a text-object 'a' argument

Original plugin: argtextobj.vim.

Summary:

This plugin provides a text-object 'a' (argument). You can d(elete), c(hange), v(select)... an argument or inner argument in familiar ways.

That is, such as 'daa'(delete-an-argument) 'cia'(change-inner-argument) 'via'(select-inner-argument). What this script does is more than just typing

F,dt,

because it recognizes inclusion relationship of parentheses.

Setup:

  • Add the following command to ~/.ideavimrc: Plug 'vim-scripts/argtextobj.vim'
    Alternative syntax Plugin 'vim-scripts/argtextobj.vim'
    Plug 'https://github.com/vim-scripts/argtextobj.vim'
    Plug 'argtextobj.vim'
    Plug 'https://www.vim.org/scripts/script.php?script_id=2699'
    set argtextobj

Instructions

By default, only the arguments inside parenthesis are considered. To extend the functionality to other types of brackets, set g:argtextobj_pairs variable to a comma-separated list of colon-separated pairs (same as VIM's matchpairs option), like let g:argtextobj_pairs="(:),{:},<:>". The order of pairs matters when handling symbols that can also be operators: func(x << 5, 20) >> 17. To handle this syntax parenthesis, must come before angle brackets in the list.

https://www.vim.org/scripts/script.php?script_id=2699

commentary: Adds mapping for quickly commenting stuff out

By Daniel Leong
Original plugin: commentary.vim.

Summary:

Comment stuff out. Use gcc to comment out a line (takes a count), gc to comment out the target of a motion (for example, gcap to comment out a paragraph), gc in visual mode to comment out the selection, and gc in operator pending mode to target a comment. You can also use it as a command, either with a range like :7,17Commentary, or as part of a :global invocation like with :g/TODO/Commentary. That's it.

Setup:

  • Add the following command to ~/.ideavimrc: Plug 'tpope/vim-commentary'
    Alternative syntax Plugin 'tpope/vim-commentary'
    Plug 'https://github.com/tpope/vim-commentary'
    Plug 'vim-commentary'
    Plug 'tcomment_vim'
    set commentary

Instructions

https://github.com/tpope/vim-commentary/blob/master/doc/commentary.txt

easymotion: Simplifies some motions

Original plugin: vim-easymotion.

Summary:

EasyMotion provides a much simpler way to use some motions in vim. It takes the <number> out of <number>w or <number>f{char} by highlighting all possible choices and allowing you to press one key to jump directly to the target.

Setup:

  • Install IdeaVim-EasyMotion and AceJump plugins.
  • Add the following command to ~/.ideavimrc: Plug 'easymotion/vim-easymotion'
    Alternative syntax Plugin 'easymotion/vim-easymotion'
    Plug 'https://github.com/easymotion/vim-easymotion'
    Plug 'vim-easymotion'
    set easymotion

Instructions

All commands with the mappings are supported. See the full list of supported commands.

exchange: Easy text exchange operator

By fan-tom
Original plugin: vim-exchange.

Summary:

Easy text exchange operator for Vim.

Setup:

  • Add the following command to ~/.ideavimrc: Plug 'tommcdo/vim-exchange'
    Alternative syntax Plugin 'tommcdo/vim-exchange'
    Plug 'https://github.com/tommcdo/vim-exchange'
    Plug 'vim-exchange'
    set exchange

Instructions

https://github.com/tommcdo/vim-exchange/blob/master/doc/exchange.txt

FunctionTextObj: Adds text objects for manipulating functions/methods

By Julien Phalip

Summary:

An extension for IdeaVim that adds text objects for manipulating functions/methods in your code. Similar to how iw operates on words or i" operates on quoted strings, this plugin provides if and af to operate on functions

Setup

Add set functiontextobj to your ~/.ideavimrc file, then run :source ~/.ideavimrc or restart the IDE.

Instructions

https://plugins.jetbrains.com/plugin/25897-vim-functiontextobj

highlightedyank: Highlights the yanked region

By KostkaBrukowa
Original plugin: vim-highlightedyank.

Summary:

Make the yanked region apparent!

Setup:

  • Add the following command to ~/.ideavimrc: Plug 'machakann/vim-highlightedyank'
    Alternative syntax Plugin 'machakann/vim-highlightedyank'
    Plug 'https://github.com/machakann/vim-highlightedyank'
    Plug 'vim-highlightedyank'
    set highlightedyank

Instructions

If you want to optimize highlight duration, assign a time in milliseconds:
let g:highlightedyank_highlight_duration = "1000"
A negative number makes the highlight persistent.

If you want to change background color of highlight you can provide the rgba of the color you want e.g.
let g:highlightedyank_highlight_color = "rgba(160, 160, 160, 155)"

If you want to change text color of highlight you can provide the rgba of the color you want e.g.
let g:highlightedyank_highlight_foreground_color = "rgba(0, 0, 0, 255)"

https://github.com/machakann/vim-highlightedyank/blob/master/doc/highlightedyank.txt

indent-object: Adds text objects for manipulating sentences/paragraphs/etc...

By Shrikant Sharat Kandula
Original plugin: vim-indent-object.

Summary:

Vim text objects provide a convenient way to select and operate on various types of objects. These objects include regions surrounded by various types of brackets and various parts of language (ie sentences, paragraphs, etc).

Setup:

  • Add the following command to ~/.ideavimrc: Plug 'michaeljsmith/vim-indent-object'
    Alternative syntax Plugin 'michaeljsmith/vim-indent-object'
    Plug 'https://github.com/michaeljsmith/vim-indent-object'
    Plug 'vim-indent-object'
    set textobj-indent

Instructions

https://github.com/michaeljsmith/vim-indent-object/blob/master/doc/indent-object.txt

matchit.vim: Extends the % key functionality

By Martin Yzeiri Original plugin: matchit.vim.

Summary:

In Vim, as in plain vi, the percent key, |%|, jumps the cursor from a brace, bracket, or paren to its match. This can be configured with the 'matchpairs' option. The matchit plugin extends this in several ways...

Setup:

  • Add the following command to ~/.ideavimrc: packadd matchit
    Alternative syntax Plug 'vim-matchit'
    Plug 'chrisbra/matchit'
    set matchit

Instructions

https://github.com/adelarsq/vim-matchit/blob/master/doc/matchit.txt

Mini.ai: Extend and create a/i textobjects (IMPORTANT: The plugin is not related with artificial intelligence)

Summary:

Extend and create a/i textobjects

Features:

Provides additional text object motions for handling quotes and brackets. The following motions are included:

  • aq: Around any quotes.
  • iq: Inside any quotes.
  • ab: Around any parentheses, curly braces, and square brackets.
  • ib: Inside any parentheses, curly braces, and square brackets.

Original plugin: mini.ai.

Setup:

  • Add the following command to ~/.ideavimrc: set mini-ai

multiple-cursors: Extends multicursor support

Original plugin: vim-multiple-cursors.

Setup:

  • Add the following command to ~/.ideavimrc: Plug 'terryma/vim-multiple-cursors'
    Alternative syntax Plugin 'terryma/vim-multiple-cursors'
    Plug 'https://github.com/terryma/vim-multiple-cursors'
    Plug 'vim-multiple-cursors'
    set multiple-cursors

Instructions

At the moment, the default key binds for this plugin do not get mapped correctly in IdeaVim (see VIM-2178). To enable the default key binds, add the following to your .ideavimrc file...

" Remap multiple-cursors shortcuts to match terryma/vim-multiple-cursors
nmap <C-n> <Plug>NextWholeOccurrence
xmap <C-n> <Plug>NextWholeOccurrence
nmap g<C-n> <Plug>NextOccurrence
xmap g<C-n> <Plug>NextOccurrence
xmap <C-x> <Plug>SkipOccurrence
xmap <C-p> <Plug>RemoveOccurrence

" Note that the default <A-n> and g<A-n> shortcuts don't work on Mac due to dead keys.
" <A-n> is used to enter accented text e.g. ñ
" Feel free to pick your own mappings that are not affected. I like to use <leader>
nmap <leader><C-n> <Plug>AllWholeOccurrences
xmap <leader><C-n> <Plug>AllWholeOccurrences
nmap <leader>g<C-n> <Plug>AllOccurrences
xmap <leader>g<C-n> <Plug>AllOccurrences

NERDTree: Adds NERDTree navigation to the project panel

Original plugin: NERDTree.

Summary:

Adds NERDTree navigation to the project panel.

Setup:

  • Add the following command to ~/.ideavimrc: Plug 'preservim/nerdtree'
    Alternative syntax Plugin 'preservim/nerdtree'
    Plug 'https://github.com/preservim/nerdtree'
    Plug 'nerdtree'
    set NERDTree

Instructions

See here.

paragraph-motion: Extends the { and } motions to ignore whitespace on otherwise empty lines

Original plugin: vim-paragraph-motion.

Summary:

Normally the { and } motions only match completely empty lines. With this plugin lines that only contain whitespace are also matched.

Setup:

  • Add the following command to ~/.ideavimrc: Plug 'dbakker/vim-paragraph-motion'
    Alternative syntax Plugin 'dbakker/vim-paragraph-motion'
    Plug 'https://github.com/dbakker/vim-paragraph-motion'
    Plug 'vim-paragraph-motion'
    Plug 'https://github.com/vim-scripts/Improved-paragraph-motion'
    Plug 'vim-scripts/Improved-paragraph-motion'
    Plug 'Improved-paragraph-motion'
    set vim-paragraph-motion

Instructions

https://github.com/dbakker/vim-paragraph-motion#vim-paragraph-motion

Peekaboo: Extends " @ CTRL-r to show a popup of the register contents

By Julien Phalip
Original plugin: vim-peekaboo.

Summary:

Peekaboo extends " and @ in normal mode and in insert mode so you can see the contents of the registers.

Setup

Add set peekaboo to your ~/.ideavimrc file, then run :source ~/.ideavimrc or restart the IDE.

Instructions

https://plugins.jetbrains.com/plugin/25776-vim-peekaboo

quick-scope: Always-on highlight for a unique character in every word on a line to help use f, F, etc.

Original plugin: quick-scope.

Summary:

An always-on highlight for a unique character in every word on a line to help you use f, F and family.

This plugin should help you get to any word on a line in two or three keystrokes with Vim's built-in f (which moves your cursor to ).

Setup:

  • Install IdeaVim-Quickscope plugin.
  • Add the following command to ~/.ideavimrc: set quickscope

Instructions

https://plugins.jetbrains.com/plugin/19417-ideavim-quickscope

ReplaceWithRegister: Adds two-in-one command that replaces text with the contents of a register.

By igrekster
Original plugin: ReplaceWithRegister.

Summary:

This plugin offers a two-in-one command that replaces text covered by a {motion}, entire line(s) or the current selection with the contents of a register; the old text is deleted into the black-hole register, i.e. it's gone. (But of course, the command can be easily undone.)

Setup:

  • Add the following command to ~/.ideavimrc: Plug 'vim-scripts/ReplaceWithRegister'
    Alternative syntax Plugin 'vim-scripts/ReplaceWithRegister'
    Plug 'ReplaceWithRegister'
    Plug 'https://github.com/inkarkat/vim-ReplaceWithRegister'
    Plug 'inkarkat/vim-ReplaceWithRegister'
    Plug 'vim-ReplaceWithRegister'
    Plug 'https://www.vim.org/scripts/script.php?script_id=2703'
    set ReplaceWithRegister

Instructions

https://github.com/vim-scripts/ReplaceWithRegister/blob/master/doc/ReplaceWithRegister.txt

sneak: Jump to any location specified by two characters

icon

By Mikhail Levchenko
Original repository with the plugin: https://github.com/Mishkun/ideavim-sneak
Original plugin: vim-sneak.

Summary:

Jump to any location specified by two characters.

Setup:

  • Add the following command to ~/.ideavimrc: Plug 'justinmk/vim-sneak'

Instructions

  • Type s and two chars to start sneaking in forward direction
  • Type S and two chars to start sneaking in backward direction
  • Type ; or , to proceed with sneaking just as if you were using f or t commands

surround: Adds provides mappings to easily delete, change, and add surroundings in pairs

Original plugin: vim-surround.

Summary:

Surround.vim is all about "surroundings": parentheses, brackets, quotes, XML tags, and more. The plugin provides mappings to easily delete, change and add such surroundings in pairs.

Setup:

  • Add the following command to ~/.ideavimrc: Plug 'tpope/vim-surround'
    Alternative syntax Plugin 'tpope/vim-surround'
    Plug 'https://www.vim.org/scripts/script.php?script_id=1697'
    Plug 'vim-surround'
    set surround

Instructions

https://github.com/tpope/vim-surround/blob/master/doc/surround.txt

Switch: Switch some text under the cursor based on regex patterns

By Julien Phalip
Original plugin: switch.vim.

Summary:

The purpose of the plugin is to switch some text under the cursor based on regex patterns. The main entry point is a single command, :Switch. When the command is executed, the plugin looks for one of a few specific patterns under the cursor and performs a substitution depending on it.

Setup

Add set switch to your ~/.ideavimrc file, then run :source ~/.ideavimrc or restart the IDE.

Instructions

https://plugins.jetbrains.com/plugin/25899-vim-switch

textobj-entire: Adds mapping for selecting entire contents of file regardless of cursor position

By Alexandre Grison
Original plugin: vim-textobj-entire.

Summary:

vim-textobj-entire is a Vim plugin to provide text objects (ae and ie by default) to select the entire content of a buffer. Though these are trivial operations (e.g. ggVG), text object versions are more handy, because you do not have to be conscious of the cursor position (e.g. vae).

Setup:

  • Add the following command to ~/.ideavimrc: Plug 'kana/vim-textobj-entire'
    Alternative syntax Plugin 'kana/vim-textobj-entire'
    Plug 'vim-textobj-entire'
    Plug 'https://www.vim.org/scripts/script.php?script_id=2610'
    set textobj-entire

Instructions

https://github.com/kana/vim-textobj-entire/blob/master/doc/textobj-entire.txt

Which-Key: Displays available keybindings in popup

Original plugin: vim-which-key.

Summary:

vim-which-key is vim port of emacs-which-key that displays available keybindings in popup.

Setup:

  • Install Which-Key plugin.
  • Add the following command to ~/.ideavimrc: set which-key

Instructions

https://github.com/TheBlob42/idea-which-key?tab=readme-ov-file#installation

Clone this wiki locally