vim

This repo contains everyday vim usage method and .vimrc for future reference.

.vimrc

syntax on

se noerrorbells
se tabstop=4 softtabstop=4
se shiftwidth=4
se expandtab " turns tab into spaces
se smartindent
se nowrap
se noswapfile
se nobackup
se undodir=~/.vim/undodir
se undofile
se incsearch

se colorcolumn=80
highlight ColorColumn ctermbg=0 guibg=lightgrey

se nu " set line number
se history=1000 " set history line to 100
se hls " hightlight search
se rnu " set relative number for better editing experience

let mapleader = "\<Space>" " Set /space as the leader key

" Search and Replace
nnoremap <Leader>r :%s///gc<Left><Left><Left>

" Save all file
nnoremap <Leader>w :wa<CR>

"Save and quit
nnoremap <Leader>x :x<CR>

"Before edit
nnoremap <Leader>e :e!<CR>

" Toogle text wrap
function! ToogleTextWrap()
  if (&wrap == 1)
    se nowrap | echo "Toggle text wrap OFF"
  else
    se wrap | echo "Toggle text warp ON"
  endif
endfunction

nnoremap <Leader><Leader>z :call ToogleTextWrap()<CR>

" Toggle line numbers
function! ToggleNumber()
  if (&relativenumber == 1)
    se nonu | se nornu | echo "Toggle line numbers OFF"
  else
    se nu | se rnu | echo "Toggle line numbers ON"
  endif
endfunction

nnoremap <Leader>n :call ToggleNumber()<CR>

" Toggle highlight search
function! ToggleHighlight()
  if (&hls == 1)
    se nohls | echo "Toggle highlight search OFF"
  else
    se hls | echo "Toggle hightlight search ON"
  endif
endfunction

nnoremap <Leader>h :call ToggleHighlight()<CR>

" Between vim panes
nnoremap <leader>h :wincmd h<CR>
nnoremap <leader>j :wincmd j<CR>
nnoremap <leader>k :wincmd k<CR>
nnoremap <leader>l :wincmd l<CR>

" Toggle undo-tree
nnoremap <leader>u :UndotreeShow<CR>

" Visual Drag Keys
vmap  <expr>  <S-LEFT>   DVB_Drag('left')
vmap  <expr>  <S-RIGHT>  DVB_Drag('right')
vmap  <expr>  <S-DOWN>   DVB_Drag('down')
vmap  <expr>  <S-UP>     DVB_Drag('up')
vmap  <expr>  D          DVB_Duplicate()
" Remove any introduced trailing whitespace after moving
let g:DVB_TrimWS = 1

call plug#begin('~/.vim/plugged')

" Git Function
Plug 'tpope/vim-fugitive'

" Fuzzy Search
Plug 'junegunn/fzf', { 'do': { -> fzf#install() } }
Plug 'junegunn/fzf.vim'

" CPP Highlighting
Plug 'octol/vim-cpp-enhanced-highlight'

" Undo List
Plug 'mbbill/undotree'

" Manpages
Plug 'vim-utils/vim-man'

" Visual Drag
Plug 'jondkinney/dragvisuals.vim'

call plug#end()

Creating Undo folder:

mkdir -p ~/.vim/undodir

To install plugin:

curl -fLo ~/.vim/autoload/plug.vim --create-dirs \
    https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim

curl -o .vimrc https://raw.githubusercontent.com/BruceChanJianLe/vim/master/.vimrc

vi +PlugInstall +qa

vscodevim settings.json

{
    "python.defaultInterpreterPath": "/usr/bin/python3",
    "window.zoomLevel": 0,
    "editor.lineNumbers": "relative",
    "cmake.configureOnOpen": true,
    "cmake.buildDirectory": "${workspaceFolder}/build-vscode",
    "testMate.cpp.log.userId": "82cdd95340a0c3075fb44e7c043c393e1bdb7a70",
    "testMate.cpp.log.logSentry": "disable_3",
    "vim.leader": "<space>",
    "vim.vimrc.path": "/home/chanjl/.vimrc",
    "scm.defaultViewMode": "tree",
    "vim.normalModeKeyBindingsNonRecursive": [
            {
                "before": ["<leader>", "w"],
                "commands": ["workbench.action.files.saveFiles"]
            },
            {
                "before": ["<leader>", "x"],
                "commands": ["workbench.action.files.saveFiles","workbench.action.closeActiveEditor"]
            },
            {
                "before": ["<leader>", "r"],
                "after": ["%s///gc<Left><Left><Left>"]
            },
            {
                "before": ["<leader>", "<leader>", "r"],
                "after": ["%s///g<Left><Left>"]
            },
            {
                "before": ["<leader>", "e"],
                "after": [":e!"]
            },
            {
                "before": ["<leader>", "q"],
                "commands": ["workbench.action.closeActiveEditor"]
            },
            {
                "before": ["<leader>", "z"],
                "commands": ["workbench.action.toggleEditorWidths"] 
            },
            {
                "before": ["<leader>", "h"],
                "commands": ["workbench.action.navigateLeft"]
            },
            {
                "before": ["<leader>", "j"],
                "commands": ["workbench.action.navigateDown"]
            },
            {
                "before": ["<leader>", "k"],
                "commands": ["workbench.action.navigateUp"]
            },
            {
                "before": ["<leader>", "l"],
                "commands": ["workbench.action.navigateRight"]
            },
            {
                "before": ["<leader>", ","],
                "commands": ["workbench.action.previousEditorInGroup"]
            },
            {
                "before": ["<leader>", "."],
                "commands": ["workbench.action.nextEditorInGroup"]
            }
        ]
}

Plug-in

Currently, we are using Plug Vim from plugin_github_link. To install the plugin please type this inside of vim :PlugInstall. For more information please visit the link above.

Common Problems

How to save vim without sudo
:w !sudo tee %
Info

:w – Write a file (actually buffer).
!sudo – Call shell with sudo command.
tee – The output of write (vim :w) command redirected using tee.
% – The % is nothing but current file name. In this example, it is /etc/apache2/conf.d/mediawiki.conf. In other words tee command is run as root and it takes standard input (or the buffer) and write it to a file represented by %. However, this will prompt to reload file again (hit L to load changes in vim itself)
Reference

How to set vim as terminal default editor
sudo update-alternatives --config editor
Info

Select vim as the default editor by providing the corresponding number to the terminal and hitting enter.

How to copy content of website to file
:-1 r !curl https://raw.githubusercontent.com/brucechanjianle/tmux_setup/master/.tmux.conf
Info

:-1 – Start from the first line (without entering).
r – Read command (refer to below).
!curl – Call shell with curl command.
https...tmux.conf – Provide the url link.

You may also want to use the curl command alone.
curl -o .tmux.conf https://raw.githubusercontent.com/brucechanjianle/tmux_setup/master/.tmux.conf
Reference

Open file with cursor at the end
vim "+normal G" file.txt
Reference

Read commands from shell into vim
:r !ls
Info
Learn more from the external command video from Linkedin Learning.
Reference

Go to a file inside vim
gf
Info
Just hit gf and you vim will open the right file for you, provided that the file path is correct.
Reference

Tab edit inside vim
:tabe file.txt Tab edit file.txt.
gt Go to next tab.
gT Go to previous tab.
<number>gt Go to tab.
Use this method to edit several files in different tab.
Reference

Source .vimrc in vim :so $MYVIMRC
Reference

Info

Abbreviation

long	short
set	se
highlightsearch	hls
number	nu
relativenumber	rnu
syntax	syn

Cheat Sheet

Global

:help keyword - open help for keyword
:saveas file - save file as
:close - close current pane
K - open man page for word under the cursor

Cursor movement

h - move cursor left
j - move cursor down
k - move cursor up
l - move cursor right
H - move to top of screen
M - move to middle of screen
L - move to bottom of screen
w - jump forwards to the start of a word
W - jump forwards to the start of a word (words can contain punctuation)
e - jump forwards to the end of a word
E - jump forwards to the end of a word (words can contain punctuation)
b - jump backwards to the start of a word
B - jump backwards to the start of a word (words can contain punctuation)
% - move to matching character (default supported pairs: '()', '{}', '[]' - use :h matchpairs in vim for more info)
0 - jump to the start of the line
^ - jump to the first non-blank character of the line
$ - jump to the end of the line
g_ - jump to the last non-blank character of the line
gg - go to the first line of the document
G - go to the last line of the document
5G - go to line 5
fx - jump to next occurrence of character x
tx - jump to before next occurrence of character x
Fx - jump to previous occurence of character x
Tx - jump to after previous occurence of character x
; - repeat previous f, t, F or T movement
, - repeat previous f, t, F or T movement, backwards
} - jump to next paragraph (or function/block, when editing code)
{ - jump to previous paragraph (or function/block, when editing code)
zz - center cursor on screen
Ctrl + e - move screen down one line (without moving cursor)
Ctrl + y - move screen up one line (without moving cursor)
Ctrl + b - move back one full screen
Ctrl + f - move forward one full screen
Ctrl + d - move forward 1/2 a screen
Ctrl + u - move back 1/2 a screen

Tip Prefix a cursor movement command with a number to repeat it. For example, 4j moves down 4 lines.

Insert mode - inserting/appending text

i - insert before the cursor
I - insert at the beginning of the line
a - insert (append) after the cursor
A - insert (append) at the end of the line
o - append (open) a new line below the current line
O - append (open) a new line above the current line
ea - insert (append) at the end of the word
Esc - exit insert mode

Editing

r - replace a single character
J - join line below to the current one with one space in between
gJ - join line below to the current one without space in between
gwip - reflow paragraph
cc - change (replace) entire line
C - change (replace) to the end of the line
c$ - change (replace) to the end of the line
ciw - change (replace) entire word
cw - change (replace) to the end of the word
s - delete character and substitute text
S - delete line and substitute text (same as cc)
xp - transpose two letters (delete and paste)
u - undo
Ctrl + r - redo
. - repeat last command

Marking text (visual mode)

v - start visual mode, mark lines, then do a command (like y-yank)
V - start linewise visual mode
o - move to other end of marked area
Ctrl + v - start visual block mode
O - move to other corner of block
aw - mark a word
ab - a block with ()
aB - a block with {}
ib - inner block with ()
iB - inner block with {}
Esc - exit visual mode

Visual commands

> - shift text right
< - shift text left
y - yank (copy) marked text
d - delete marked text
~ - switch case

Registers

:reg - show registers content
"xy - yank into register x
"xp - paste contents of register x

Tip Registers are being stored in ~/.viminfo, and will be loaded again on next restart of vim.
Tip Register 0 contains always the value of the last yank command.

Marks

:marks - list of marks
ma - set current position for mark A
`a - jump to position of mark A
y`a - yank text to position of mark A

Macros

qa - record macro a
q - stop recording macro
@a - run macro a
@@ - rerun last run macro

Cut and paste

yy - yank (copy) a line
2yy - yank (copy) 2 lines
yw - yank (copy) the characters of the word from the cursor position to the start of the next word
y$ - yank (copy) to end of line
p - put (paste) the clipboard after cursor
P - put (paste) before cursor
dd - delete (cut) a line
2dd - delete (cut) 2 lines
dw - delete (cut) the characters of the word from the cursor position to the start of the next word
D - delete (cut) to the end of the line
d$ - delete (cut) to the end of the line
x - delete (cut) character

Exiting

:w - write (save) the file, but don't exit
:w !sudo tee % - write out the current file using sudo
:wq or :x or ZZ - write (save) and quit
:q - quit (fails if there are unsaved changes)
:q! or ZQ - quit and throw away unsaved changes
:wqa - write (save) and quit on all tabs

Search and replace

/pattern - search for pattern
?pattern - search backward for pattern
\vpattern - 'very magic' pattern: non-alphanumeric characters are interpreted as special regex symbols (no escaping needed)
n - repeat search in same direction
N - repeat search in opposite direction
:%s/old/new/g - replace all old with new throughout file
:%s/old/new/gc - replace all old with new throughout file with confirmations
:noh - remove highlighting of search matches

Search in multiple files

:vimgrep /pattern/ {`{file}`} - search for pattern in multiple files

e.g. :vimgrep /foo/ */

:cn - jump to the next match
:cp - jump to the previous match
:copen - open a window containing the list of matches

Working with multiple files

:e file - edit a file in a new buffer
:bnext or :bn - go to the next buffer
:bprev or :bp - go to the previous buffer
:bd - delete a buffer (close a file)
:ls - list all open buffers
:sp file - open a file in a new buffer and split window
:vsp file - open a file in a new buffer and vertically split window
Ctrl + ws - split window
Ctrl + ww - switch windows
Ctrl + wq - quit a window
Ctrl + wv - split window vertically
Ctrl + wh - move cursor to the left window (vertical split)
Ctrl + wl - move cursor to the right window (vertical split)
Ctrl + wj - move cursor to the window below (horizontal split)
Ctrl + wk - move cursor to the window above (horizontal split)

Tabs

:tabnew or :tabnew {page.words.file} - open a file in a new tab
Ctrl + wT - move the current split window into its own tab
gt or :tabnext or :tabn - move to the next tab
gT or :tabprev or :tabp - move to the previous tab
#gt - move to tab number #
:tabmove # - move current tab to the #th position (indexed from 0)
:tabclose or :tabc - close the current tab and all its windows
:tabonly or :tabo - close all tabs except for the current one
:tabdo command - run the command on all tabs (e.g. :tabdo q - closes all opened tabs)

Reference
Search&Replace
LeaderKey
LeaderKeyAs/
Tutorial Missing Semester on Vim
Vimscripting: link1 link2 link3 link4 link5
vimrc_setup

yuda226 / vim Goto Github PK

vim's Introduction

vim