lin.vim is a highly configured vim/neovim distribution integrated tons of utilities for development, inspired by spf13-vim.

• Introduction
  • Screenshots
  • Feature
• Installation
  • UNIX/Linux/MacOS
  • Windows
• User Guide
  • Hot Key
  • UI
    • File Explorer
    • Buffers/Tabs
    • Font
  • IDE-like Editing Features
    • Code Complete
    • Jumps
    • Symbols
    • Code Format
    • Code Actions
    • Code Lens
    • Git
  • Search
    • Text Search
    • File Search
    • Git Search
    • Other Search
    • Coc.nvim Search
  • Editing Enhancement
    • Enhanced Copy Paste
    • Fast Cursor Movement
    • Word Movement
    • Fast Repeat
    • Fast Quotes Operation
    • Match Brackets and HTML Tags
    • Auto Close Brackets and HTML Tags
    • Easy Comment
  • Customization
• Embeded Language Servers
• Reference
• Contribute

Aim to be out of box, IDE-like editing experience, high performance, light weight and friendly to most users. Focus on and only on editing, no compile/package/debug.

Solve below issues:

• Time-costing study and configure vim scripts - All behaviors configured follow vim community's best practice or most popular modern editors(just like vscode).
• Lack of programming language support or IDE-like features - coc.nvim and a set of plugins are installed, with a bunch of language servers embeded.
• Don't know how to install/choose/configure plugins: All plugins are selected carefully and well cooperated with each other. Provide best performance and user experience, cover most modern editor features(again, just like vscode).
• Time-costing repeat installation on different machines and OS - All done by one-line command (not on Windows for now), all behaviors are the same(the only difference is use cmd-key on macOS instead of alt-key on Windows/Linux).
• Naive UI-looking and lack of icons/colorschemes - Pretty colorschemes, icons, opened tabs, file explorer, file status integrated.
• Special customization - Open and edit ~/.vimrc ~/.vim/plugin.vim ~/.vim/setting.vim, or add a new language server with coc configuration ~/.vim/coc-settings.json.

• One-line command installation (not on windows for now).
• Work on multiple OS platforms:
  • Windows.
  • macOS.
  • Linux(Ubuntu/Debian/Fedora/Manjaro).
• Support both vim and neovim, neovim 0.7+ is strongly recommended for best performance and experience.
• Modern editor UI features:
  • File explorer.
  • Icons.
  • Color schemes (see Color Schemes - Reference) randomly selected on start.
  • Status line.
  • Tab line and buffer explorer.
  • Outline/Tags.
• IDE-like editing features supported by coc.nvim, a bunch of language servers(see Embeded Language Servers) embeded by default:
  • Code complete.
  • Diagnostic.
  • Lint.
  • Code format.
  • Jump between symbols.
  • Code Actions.
  • Code Lens.
• Search engine features supported by fzf.vim:
  • Text search on text/lines/tags/search-histories/command-histories/yank-histories.
  • File search on files/buffers/history-files.
  • Git search on commits/uncommit-changes.
  • Coc.nvim integrated search on symbols/outline/diagnostics/yank.
  • Other enhancement search on vim-marks/vim-key-mappings/vim-commands/help-tags.
• Other editing enhancements (see Editing Enahncement).
• Custom configuration.

Before installation, please make sure access of below domains are available:

• github.com.
• raw.githubusercontent.com.
• www.rust-lang.org.
• crates.io.
• go.dev.
• storage.googleapis.com.

install.sh will automatically install below softwares with system package managers:

• git.
• vim and neovim.
• clang(for macOS) or gcc(for linux), make, pkg-config, cmake, linux also need autoconf and automake.
• python3 (python 2.x is not support) and some pip packages.
• node.js and some npm packages.
• golang.
• rust and some modern commands.
• curl and wget.
• universal-ctags.
• hack nerd font.

For now supported platforms are:

• Debian/ubuntu based linux: use apt as software installer.
• Fedora/centos based linux: use dnf as software installer.
• Archlinux based linux: use pacman as software installer.
• MacOS: use brew as software installer, please install Xcode and homebrew as pre-requirements.

Other *NIX systems such as gentoo, bsd are not supported yet.

    $ git clone https://github.com/linrongbin16/lin.vim ~/.vim && cd ~/.vim && ./install.sh

The goal of installation on windows is to install native executable file, no WSL nor MYSY2 for below reasons:

• Native executable file has better performance, WSL (actually a virtual machine) is quite slow and heavy.
• Git for Windows already contains MYSY2 and provide Unix/Linux builtin commands, we could leverage that.

1. Install Visual Studio with below 3 components checked:

   • .NET Desktop Development
   • Visual C++ Desktop Development (Desktop development with C++)
   • Common Windows Platform Development (Universal Windows Platform development)

2. Install 64-bit Git for Windows Setup with especially below 3 options checked:

   1. In the Select Components step, check Associate .sh files to be run with Bash.
   2. In the Adjusting your PATH environment step, choose Use Git and optional Unix tools from the Command Prompt.
   3. In the Configuring the terminal emulator to use with Git Bash step, choose Use Windows's default console window.

This will add both git.exe and linux builtin commands (such as bash.exe, cp.exe, mv.exe, cd.exe, ls.exe, etc) in $env:Path, turn command prompt and powershell to a linux-like shell, thus help (neo)vim plugins running correctly.

3. Install other dependencies (x64 is preferred):

   • vim-win32-installer: add gvim.exe to $env:Path
   • neovim: add nvim.exe to $env:Path
   • cmake: add cmake.exe to $env:Path
   • make-for-win32: add make.exe to $env:Path
   • python3: since python3 installer don't provide python3.exe and pip3.exe, manually copy python.exe as python3.exe, copy pip.exe as pip3.exe, then add to $env:Path.
   • rust: add rustc.exe, cargo.exe to $env:Path
   • golang: add go.exe to $env:Path
   • nodejs: add node.exe, npm.exe to $env:Path
   • universal-ctags: add ctags.exe, readtags.exe to $env:Path

Use package manager (such as chocolatey and scoop) could be a better choice, just make sure they're available in $env:Path.

4. Install Hack NF:

   • Hack Bold Nerd Font Complete Mono Windows Compatible.ttf
   • Hack Bold Italic Nerd Font Complete Mono Windows Compatible.ttf
   • Hack Italic Nerd Font Complete Mono Windows Compatible.ttf
   • Hack Regular Nerd Font Complete Mono Windows Compatible.ttf

5. Finally run below commands in powershell:

    $ git clone https://github.com/linrongbin16/lin.vim $env:UserProfile\.vim
    $ cd $env:UserProfile\.vim
    $ .\install.ps1

1. If you are using WSL, C:\Windows\System32\bash.exe could lead you to WSL instead of the bash.exe provided by Git for Windows. Make sure git environment path is ahead of C:\Windows\System32 (wsl.exe could connect to WSL as well, so no need to worry about losing bash.exe), so git bash will be first detected on $env:Path.

2. Python3 version must be compatible with gvim's libpython3.so version, or it will not been loaded. Latest vim 8.2-9 is compiled with python3.10. Please use gvim --version to find its libpython3.so version.

3. Don't use old-version vim.exe provided by Git for Windows, use gvim.exe provided by vim-win32-installer. Or you could move gvim.exe environment path ahead of Git for Windows, this could make sure vim.exe from vim-win32-installer be first detected on $env:Path.

4. Disable Windows App alias python.exe or python3.exe, this could lead you to the wrong python provide by windows application store. Please see: Manage App Execution Aliases on Windows10 and Default app aliases in windows.

In this section, vim editing mode are specified with:

• 🄽 - Normal Mode
• 🅅 - Visual Mode
• 🄸 - Insert Mode

Vim key are specified with:

• D - Meta-Key (Command-Key on macOS, Alt-Key on other os).

• F1 🄽 - toggle(open/close) file explorer, see Simple but pretty UI.
• F2 🄽 - toggle(open/close) undo tree.
• F3 🄽 - toggle(open/close) vista outline/tags, see Code complete for C++.
• F4 🄽 - switch between C/C++ header and source files.
• F8 🄽 - open markdown preview.
• F9 🄽 - change color theme randomly, see Screenshots.
• F10/SHIFT-F10 🄽 - open/close(toggle) opened buffers explorer.

You could configure these keys in ~/.vim/setting.vim.

Navigation:

• h 🄽 - collapse directory.
• l 🄽 - open or expand directory.
• <CR> 🄽 - open file or cd into directory.
• <BS> 🄽 - leave directory and goto upper directory.
• e 🄽 - open file in split.
• E 🄽 - open file in vsplit.
• t 🄽 - open file in new tab.

Create/Delete/Copy/Paste/Cut:

• a/A 🄽 - create new file/directory.
• m/r 🄽 - move/rename file/directory.
• <C-c> 🄽 - copy file/directory into internal clipboard just like in Windows.
• <C-x> 🄽 - cut file/directory into internal clipboard just like in Windows.
• <C-v> 🄽 - paste internal clipboard file/directory to current directory just like in Windows.
• d 🄽 - trash file/directory to system trash-bin, only works on Windows/macOS.
• D 🄽 - force delete file/directory, possiblely implemented with rm.
• R 🄽 - refresh file explorer.

Resize Width:

• <D-Right>/<D-.> 🄽 - make explorer bigger.
• <D-Left>/<D-,> 🄽 - make explorer smaller.

Others:

• s 🄽 - open file in system file manager(such as Finder in macOS).
• ? 🄽 - open/close(toggle) help.

For neovim 0.7+ only:

• P 🄽 - preview file content.
• I 🄽 - preview file info.
• H 🄽 - toggle dotfiles hidden.
• y 🄽 - copy file name string.
• Y 🄽 - copy absolute file path string.

Support by fern.vim (switched to nvim-tree.lua on neovim 0.7+), you could use key mappings on the file explorer left side:

You could editing ~/.vim/setting/lambdalisue/fern.vim.vim (or ~/.vim/setting/kyazdani42/nvim-tree.lua.vim) to customize key mappings. Please refer to fern.vim - wiki - Mappings (or nvim-tree.lua - README) for more key mappings.

• <leader><tab>/<D-Right>/<D-.> 🄽 - go to next buffer on the right.
• <leader><s-tab>/<D-Left>/<D-,> 🄽 - go to previous buffer on the left(Notice some terminal/GUI could eat Alt+, Alt+. and Command+, Command+.).
• <leader>bd 🄽 - close current buffer (and go to a nearest buffer) without closing vim window.
• F10/SHIFT-F10 🄽 - open/close(toggle) opened buffers explorer.

Meta-1 ~ Meta-9 (on macOS it's Command-Key, on others it's Alt-Key) are mapped to 1~9 buffers, Meta-0 are mapped to navigate to the last buffer.

• <D-1> 🄽 - go to buffer-1.
• <D-2> 🄽 - go to buffer-2.
• <D-3> 🄽 - go to buffer-3.
• <D-4> 🄽 - go to buffer-4.
• <D-5> 🄽 - go to buffer-5.
• <D-6> 🄽 - go to buffer-6.
• <D-7> 🄽 - go to buffer-7.
• <D-8> 🄽 - go to buffer-8.
• <D-9> 🄽 - go to buffer-9.
• <D-0> 🄽 - go to the last buffer.

For neovim 0.5+ only:

• <D-S-Right> 🄽 - move current buffer to next position(right side).
• <D-S-Left> 🄽 - move current buffer to previous position(left side).
• <LeftMouse> 🄽 - go to target buffer.
• <MiddleMouse> 🄽 - close target buffer.

Support by vim-buffet(switched to barbar.nvim on neovim 0.5+).

lin.vim use Hack Nerd Font by default. Please manually install other nerd fonts and configure in ~/.vim/setting.vim for other options.

• <c-n>/<down> 🄸 - navigate to next suggestion.
• <c-p>/<up> 🄸 - navigate to previous suggestion.
• <tab>/<cr> 🄸 - confirm current suggestion or snippet.
• <esc>/<c-[> 🄸 - close suggestion.
• <c-f> 🄸 - jump to next snippet position.
• <c-b> 🄸 - jump to previous snippet position.
• <c-k> 🄸 - force trigger suggestion.

• [d 🄽 - go to previous diagnostic location.
• ]d 🄽 - go to next diagnostic location.
• gd 🄽 - go to definition.
• gy 🄽 - go to type(function) definition.
• gi 🄽 - go to implemention.
• gr 🄽 - go to references.

• K 🄽 - show hover(symbol definition).
• <leader>rs 🄽 - rename symbol.

• <leader>cf 🄽🅅 - format code on current buffer or visual-selected code.

• <leader>ca 🄽🅅 - run code actions on current cursor position or visual-selected code.
• <leader>qf 🄽 - apply quick fix on current line.

• <leader>cl 🄽 - run code lens on current line.

• ]c 🄽 - go to next git chunk in current buffer.
• [c 🄽 - go to previous git chunk in current buffer.
• <leader>gs 🄽 - show git chunk info on current line.
• <leader>gc 🄽 - show git commit info on current line.

For neovim 0.5+ only:

• <leader>gb 🄽 - toggle git blame info on current line.

Search engine use fzf.vim and integrated with coc.nvim with coc-fzf, all fzf commands are configured with prefix Fzf, for example :Files are renamed to :FzfFiles, :Rg are renamed to :FzfRg.

• <space>gr 🄽 - search text by :FzfRg.
• <space>l 🄽 - search lines on opened buffers by :FzfLines.
• <space>t 🄽 - search tags by :FzfTags.
• <space>y 🄽 - search yank history by :CocFzfList yank.
• <space>sh 🄽 - search search history by :FzfHistory/.
• <space>ch 🄽 - search vim command history by :FzfHistory:.

• <space>f/<c-p> 🄽 - search files by :FzfFiles.
• <space>b 🄽 - search opened buffers by :FzfBuffers.
• <space>hf 🄽 - search history files (v:oldfiles) and opened buffers by :FzfHistory.

• <space>gc 🄽 - search git commits by :FzfCommits.
• <space>gf 🄽 - search git files rby :FzfGFile.
• <space>gs 🄽 - search git status(also diff files by preview) by :FzfGFiles?.

• <space>mk 🄽 - search marks by :FzfMarks.
• <space>mp 🄽 - search normal mode vim key mappings by :FzfMaps.
• <space>vc 🄽 - search vim commands by :FzfCommands.
• <space>ht 🄽 - search help tags by :FzfHelptags.

Key mappings are configured with prefix char c after <space>.

• <space>cs 🄽 - search symbols by :CocFzfList symbols.
• <space>cd 🄽 - search diagnostics by :CocFzfList diagnostics.
• <space>co 🄽 - search outline/tags by :CocFzfList outline.
• <space>cc 🄽 - search commands by :CocFzfList commands.
• <space>cl 🄽 - search location by :CocFzfList location.

Please visit fzf.vim and coc-fzf for more information.

when you want copy/paste between different vim instances. Use enhanced copy-paste to stored text content in a file cache:

• <leader>y 🅅 - copy visual-selected text to ~/.vim/.enhanced-copy-paste-cache.
• <leader>p 🄽 - paste text saved from ~/.vim/.enhanced-copy-paste-cache.

You could configure these key mappings in ~/.vim/setting/linrongbin16/enhanced-copy-paste.vim.

See Fast cursor movement.

• <leader>f{char} 🄽 - move to a single {char}.
• <leader>s{char}{char} 🄽 - move to consequent two {char}{char}.
• <leader>w 🄽 - move to word.
• <leader>l 🄽 - move to line.

Support by vim-easymotion(switched to hop.nvim on neovim 0.5+).

Better word movement enhancement.

• W 🄽 - move forward to a single word.
• B 🄽 - move backward to a single word.
• E 🄽 - move forward to the end of a single word.
• gE 🄽 - move backward to the end of a single word.

Support by vim-wordmotion.

Enhancement for . operation.

Support by vim-repeat.

Enhancement for add/remove quotes operation.

Support by vim-surround

Enhancement for brackets(pairs) and html tags.

Support by vim-matchup.

Enhancement for auto close brackets(pairs) and html tags.

Support by auto-pairs (switched to nvim-autopairs on neovim 0.5+) and vim-closetag.

Normal mode:

• gcc 🄽 - toggle current line using linewise comment.
• gc{motion} 🄽 - toggle from current line with motion (jkhl) using linewise comment.
• gc<Count>{motion} 🄽 - toggle from current line with motion repeat times using linewise comment.

Virual Mode:

• gc 🅅 - toggle visual-selected code using linewise comment.

Support by tcomment_vim (switched to Comment.nvim on neovim).

Please add plugins in ~/.vim/plugin.vim, add settings in ~/.vim/setting.vim and ~/.vim/coc-settings.json.

These language servers are installed by default:

• c/c++
• python3 (python2 is not supported)
• rust
• go
• html/xml/markdown
• css/sass/scss/less
• json
• javascript/typescript/jsx/tsx

• Nerd font cheat sheet: https://www.nerdfonts.com/cheat-sheet.
• IDE-like defaults for neovim: LunarVim.
• Color Schemes:
  • solarized.
  • monokai.
  • dracula.
  • neodark.
  • srcery.
  • palenight.
  • onedark.
  • rigel.
  • base16.
  • edge.
  • gruvbox-material.
  • everforest.
  • sonokai.
  • material.
  • nightfox (for neovim 0.5+).
  • tokyonight (for neovim 0.5+).
  • github (for neovim 0.5+).
  • kanagawa (for neovim 0.6+).

Please open issue/PR for anything about lin.vim.

Like lin.vim? Consider

Or