IdeaVim
IdeaVim is a Vim engine for JetBrains IDEs.
Contact maintainers:
Resources:
Compatibility
IntelliJ IDEA, PyCharm, GoLand, CLion, PhpStorm, WebStorm, RubyMine, DataGrip, DataSpell, Rider, Cursive,
Android Studio, and other JetBrains IDEs.
Setup
-
IdeaVim can be installed via Settings | Plugins.
See the detailed instructions.
-
Use Tools | Vim in the menu to enable or disable vim.
-
Use the ~/.ideavimrc file as an analog of ~/.vimrc (learn more). The XDG standard is supported, as well.
-
Shortcut conflicts can be resolved by using:
- On Linux & Windows:
File | Settings | Editor | Vim & File | Settings | Keymap,
- On macOS:
Preferences | Editor | Vim & Preferences | Keymap,
- Regular Vim mappings in the
~/.ideavimrc file.
Get Early Access
Would you like to try new features and fixes? Join the Early Access Program and
receive EAP builds as updates!
- Click the IdeaVim icon
in the status bar |
Early Access Program | Subscribe to EAP
Or subscribe to EAP updates manually:
- Open
Settings | Plugins
- Click the gear icon :gear:, select
Manage Plugin Repositories, and add the following url:
https://plugins.jetbrains.com/plugins/eap/ideavim
See the changelog for the list of unreleased features.
It is important to distinguish EAP builds from traditional pre-release software.
Please note that the quality of EAP versions may at times be way below even
usual beta standards.
You can always leave your feedback with:
Summary of Supported Vim Features
Here are some examples of supported vim features and commands:
- Normal / insert / visual / select / etc. modes
- Motion / deletion / change / window / etc. commands
- Key mappings
- Marks / Macros / Digraphs / Registers
- Some set commands
- Full Vim regexps for search and search/replace
- Vim web help
~/.ideavimrc configuration file- Vim script, including some builtin functions
- IdeaVim plugins
See also:
Files
~/.ideavimrc
- Your IdeaVim-specific Vim initialization commands
""" Map leader to space ---------------------
let mapleader=" "
""" Plugins --------------------------------
set surround
set multiple-cursors
set commentary
set argtextobj
set easymotion
set textobj-entire
set ReplaceWithRegister
""" Plugin settings -------------------------
let g:argtextobj_pairs="[:],(:),<:>"
""" Common settings -------------------------
set showmode
set so=5
set incsearch
set nu
""" Idea specific settings ------------------
set ideajoin
set ideastatusicon=gray
set idearefactormode=keep
""" Mappings --------------------------------
map <leader>f <Plug>(easymotion-s)
map <leader>e <Plug>(easymotion-f)
map <leader>d <Action>(Debug)
map <leader>r <Action>(RenameElement)
map <leader>c <Action>(Stop)
map <leader>z <Action>(ToggleDistractionFreeMode)
map <leader>s <Action>(SelectInProjectView)
map <leader>a <Action>(Annotate)
map <leader>h <Action>(Vcs.ShowTabbedFileHistory)
map <S-Space> <Action>(GotoNextError)
map <leader>b <Action>(ToggleLineBreakpoint)
map <leader>o <Action>(FileStructurePopup)
Here is also a list of the suggested options from defaults.vim
" Show a few lines of context around the cursor. Note that this makes the
" text scroll if you mouse-click near the start or end of the window.
set scrolloff=5
" Do incremental searching.
set incsearch
" Don't use Ex mode, use Q for formatting.
map Q gq
You can read your ~/.vimrc file from ~/.ideavimrc with this command:
source ~/.vimrc
Also note that if you have overridden the user.home JVM option, this
will affect where IdeaVim looks for your .ideavimrc file. For example, if you
have -Duser.home=/my/alternate/home then IdeaVim will source
/my/alternate/home/.ideavimrc instead of ~/.ideavimrc.
Alternatively, you can set up initialization commands using XDG standard.
Put your settings to $XDG_CONFIG_HOME/ideavim/ideavimrc file.
You can also set a custom path for your .ideavimrc file using the
IDEA_VIM_CUSTOM_VIMRC environment variable. If set, IdeaVim will use this path
instead of the default locations.
IdeaVim Plugins
See doc/IdeaVim Plugins.md
This is the beginning of the README. Read the rest at the original. Read the full README ↗
