Skip to content

Latest commit

 

History

History
144 lines (103 loc) · 5.59 KB

README.md

File metadata and controls

144 lines (103 loc) · 5.59 KB
Raw

Vimfiles

This is my current vim (and gvim) setup files.

There are many like it but this one is mine. This is not intended as a distribution. Therefore, you can expect things to change on a whim. Feel free to look around and steal ideas though.

I have explained about this setup in a blog post. The plugins are managed with 'vim-plug' and the setup is tested only on Vim > v9.0 on Linux.

I have a separate configuration setup for Neovim in the repository neovimfiles because I set it up with additional features.

How to use

If you still want to use these vimfiles, this is how you can do so.

First, you'll need to clone this repository. 
$ git clone https://github.com/gaveen/vimfiles.git

Then, you could create symbolic links to the .vim directory and .vimrc file. Assuming the location where you cloned the repository is ~/Apps/vimfiles, you can do something like: 
$ ln -s ~/Apps/vimfiles/.vim ~/.vim 
$ ln -s ~/Apps/vimfiles/.vimrc ~/.vimrc

Finally, launch vim and install the plugins. (Note: :PlugUpgrade will update vim-plug itself) 
:PlugUpdate will install/update plugins

The Leader key is set as the Space character.

Dependencies

  • A relatively newer version of vim/gvim
  • An internet connection (to install/update plugins)
  • git used by vim-plug to keep plugins up-to-date
  • wl-copy used for copying to clipboard (over Wayland)
  • wmctrl used for gvim toggle full-screen

Usage tips & tricks

Before we begin tricks, there are few key concepts you need to know if you are new to vim.

To summarize:

  • Vim has multiple modes (e.g., Normal Mode, Insert Mode, Visual Mode)
  • Vim buffers are different editing spaces, whereas vim tab pages are not
  • You can define your own shortcuts
  • Vim is extensible with plugins
  • Editing with Vim is like programming your text

You can read the full details at: https://gaveen.me/2020/02/my-vim-story/

 

With those out of the way, here are some of the tricks you can do with this particular setup of vimfiles. Some of the following are enabled through plugins.

Please note: <leader> = in this vimfiles setup

Function Key Action
F2 Toggle auto-indenting when pasting
F3 Toggle focus-highlighting
F4 Toggle spell checking (default lang: en_US)
F10 Trigger showing a margin (with user input)
F11 Toggle fullscreen in gvim (if supported)

 

Buffer Shortcut Action
<leader>bl List open buffers
<leader>bg Trigger jump to buffer (with user input)
<leader>bv Go to previous buffer
<leader>bn Go to next buffer
<leader>bd Close buffer and jump to previous one

 

Clipboard Shortcut* Action
<leader>y Copy to clipboard
<leader>x Cut to clipboard
<leader>p Paste from clipboard
* Only on supported systems

 

Motion Shortcut Action
<leader><leader>w Trigger jump to word motion
<ctrl>p Fuzzy find pattern in files, buffers, etc.
<tab> Jump to matching other of a pair (same as %)

 

Visual Cue Shortcut Action
<leader>, Compare the changes since the last save
<leader>/ Clear the highlighting of last searched pattern
<leader>l Toggle displaying non-printable characters
<leader>v Select the text that was pasted immediately before
za Toggle code folding based on syntax

 

UI Element Shortcut Action
<leader>d Toggle directory tree pane
<leader>q Toggle displaying the quickfix window

 

Text Manipulation Shortcut Action
<leader>c<space> Toggle commenting the selected text
<leader>j= Toggle soft-wrapping text (fit to screen)
<leader>gq Hard-wrap lines in the current paragraph
<leader>J Un-wrap the current paragraph (join lines)
<leader>W Remove trailing whitespaces in current file
z= Spelling suggestion for the word under cursor
:w!! Save a file with 'sudo' privileges

 

Insert Mode Shortcut* Action
<ctrl>n Auto-complete words repeating words
<ctrl>x<ctrl>o Auto-complete code keywords
* Entered while in Insert Mode

 

Here are some other useful things enabled for you.

  • Automatic completion of matching pairs (e.g., (), [], {}, '', "", etc.)
  • Auto-editing of matching pairs (For examples, see: tpope/vim-surround)
  • Use _ and + keys to increase and decrease the range of text selection blocks
  • Better text aligning support (For examples, see: Vimcasts - Aligning text with Tabular.vim)
  • Show non printable characters such as: tab, trailing spaces
  • List and indicate open/active buffers in the bottom status bar

 

Finding more help

Since Vim is an advanced editor and plugins add even more features, it doesn't make sense for me to include all the support in the scope of this document.

Vim comes with extensive help documentation. To find out more about a given topic, you can access the vim help by typing :h {topic}. For example, to find about Vim's text folding features, type :h folding.

At least some of the plugins also come with documentation. Therefore, please try to refer the relevant documetation the same way. For example, to find more about motion shortcuts enabled by EasyMotion plugin, type :h easymotion.