Vimscript spiekbriefje · Cheat Sheets

Vimscript is de ingebouwde scripttaal voor het aanpassen en uitbreiden van de Vim-teksteditor.

Aan de slag

let name = "John"
echo "Hello, " . name

U kunt deze code in een scriptbestand (script.vim) plaatsen en laden met (:source script.vim), of commando's rechtstreeks uitvoeren via :let en :echo.

Leren aan de hand van voorbeelden

function! SuperTab()
  let l:part = strpart(getline('.'), col('.') - 2, 1)
  if (l:part =~ '^\W\?$')
    return "\<Tab>"
  else
    return "\<C-n>"
  endif
endfunction

imap <Tab> <C-R>=SuperTab()<CR>

Variabelen

Definitie

let var = "hello"

Variabele scope-voorvoegsels

let g:ack_options = '-s -H'    " g: global
let s:ack_program = 'ack'      " s: local (to script)
let l:foo = 'bar'              " l: local (to function)
let a:arg = 'baz'              " a: function argument

Het voorvoegsel s: kan ook worden gebruikt voor scriptlokale functienamen. Zie :help local-variables.

Andere scopes

let w:foo = 'bar'    " w: window local
let b:state = 'on'   " b: buffer local
let t:state = 'off'  " t: tab page local
echo v:version       " v: vim internal variable

let @/ = ''          " @  register
echo $PATH           " $  environment variable

Vim-opties

echo 'tabstop is ' . &tabstop
if &insertmode
echo &g:option
echo &l:option

Plaats & vóór optienamen om ze in expressies te lezen of te wijzigen.

Rekenkundige & String-operatoren

a + b             " Numbers only!
'hello ' . name   " String concatenation

let var -= 2
let var += 5
let var .= 'string'

Tekenreeksen (Strings)

String-syntaxis

let str = "String"
let str = "String with \n newline"

let literal = 'literal, no \ escaping'
let literal = 'that''s enough'

echo "result = " . res

String-functies

strlen(str)
len(str)
strchars(str)

split("one two three")       "=> ['one', 'two', 'three']
split("one.two.three", '.')  "=> ['one', 'two', 'three']

join(['a', 'b'], ',')        "=> 'a,b'

tolower('Hello')
toupper('Hello')

Functies

Functiedefinitie

function! s:Initialize(cmd, args)
  echo "Command: " . a:cmd
  return 1
endfunction

Functies overschrijven

function! MyFunc()
  echo "Function defined or replaced"
endfunction

Het gebruik van function! (met !) vervangt elke eerder gedefinieerde functie met dezelfde naam zonder fouten.

Namespaces & Autoloading

function! myplugin#hello()
  " autoload/myplugin.vim
endfunction

Functies aanroepen

call s:Initialize()
call s:Initialize("hello", 123)

Retourwaarden opvangen

let result = s:Initialize()

Afbreken bij fouten (Abort)

function! MyFunction() abort
endfunction

Variadische argumenten

function! Infect(...)
  echo a:0
  echo a:1
  echo a:2

  for item in a:000
    echon ' ' . item
  endfor
endfunction

call Infect('jake', 'bella')

Lussen & Besturingsstroom

Lussen (Loops)

for s in list
  echo s
  continue
  break
endfor

while x < 5
  let x += 1
endwhile

Aangepaste commando's (Custom Commands)

Commando's definiëren

command! Save :set fo=want tw=80 nowrap

Door de gebruiker gedefinieerde commando's moeten met een hoofdletter beginnen. Met ! kunt u bestaande commando's overschrijven.

Functies aanroepen in commando's

command! Save call <SID>Foo()

function! s:Foo()
endfunction

Commando-argumenten

command! -nargs=? Save call script#foo(<args>)

Argumentspecificatie	Beschrijving
`-nargs=0`	0 argumenten (standaard)
`-nargs=1`	Precies 1 argument (mag spaties bevatten)
`-nargs=?`	0 of 1 argument
`-nargs=*`	0 of meer door spaties gescheiden argumenten
`-nargs=+`	1 of meer door spaties gescheiden argumenten

Voorwaarden (Conditionals)

If / Elseif / Else

let char = getchar()
if char == "\<LeftMouse>"
elseif char == "\<RightMouse>"
else
endif

Waarheidswaarden (Truthiness)

if 1       "=> True
if 0       "=> False
if "1"     "=> True
if "456"   "=> True
if "xfz"   "=> False

Vimscript heeft geen apart booleaans type: 0 is onwaar en gehele getallen ongelijk aan nul zijn waar.

Vergelijkingsoperatoren

if 3 > 2
if a && b
if (a && b) || (c && d)
if !c

Hoofdlettergevoeligheid in strings

if name ==# 'John'     " case-sensitive
if name ==? 'John'     " case-insensitive
if name == 'John'      " &ignorecase

Identiteitsvergelijking

if a is b
if a isnot b

Controleert of a en b naar exact dezelfde gegevensinstantie verwijzen.

Reguliere expressie-overeenkomsten

"hello" =~ 'xx*'
"hello" !~ 'xx*'
"hello" =~ '\v<\d+>'

\v activeert 'very magic'-syntaxis waardoor speciale tekens zonder extra escaping werken.

Enkelregelige instructies

if empty(a:path) | return [] | endif
let status = a ? b : c

Gebruik | om meerdere instructies op één regel te koppelen.

Gegevensstructuren

Lijsten (Lists)

let mylist = [1, "two", 3, "four"]

let first = mylist[0]
let last  = mylist[-1]

let second = get(mylist, 1)
let fallback = get(mylist, 10, "NONE")

Lijstbewerkingen

len(mylist)
empty(mylist)

let sortedlist = sort(copy(mylist))

let shortlist = mylist[2:-1]
let shortlist = mylist[2:]
let single = mylist[2:2]

let longlist = mylist + [5, 6]
let mylist += [7, 8]
call add(mylist, 9)

Functionele lijstmethoden

call map(files, "bufname(v:val)")
call filter(files, 'v:val != ""')

Woordenboeken (Dictionaries)

let colors = {
  \ "apple": "red",
  \ "banana": "yellow"
}

echo colors["apple"]
echo get(colors, "apple")

Woordenboekbewerkingen

call remove(colors, "apple")

if has_key(dict, 'foo')
if empty(dict)
let k = keys(dict)
let v = values(dict)
let n = len(dict)

echo max(dict)
echo min(dict)

call extend(s:fruits, { "cherry": "red" })

for key in keys(mydict)
  echo key . ': ' . mydict[key]
endfor

Scope-voorvoegsels (s:, g:, l:, b:) zijn zelf toegankelijk als woordenboekobjecten:

let script_keys = keys(s:)

Getallen & Rekenkunde

let int = 1000
let hex = 0xff
let oct = 0755
let fl = 100.1
let sci = 5.4e4

3 / 2     "=> 1
3 / 2.0   "=> 1.5

sqrt(100)
floor(3.5)
ceil(3.3)
abs(-3.4)

Vim-specifieke functionaliteit

Dynamische commando-uitvoering (execute)

execute "vsplit"
execute "edit " . fnameescape(filename)

Normale modus toetsaanslagen (normal)

normal G
normal! G

execute "normal! gg/foo\<cr>dd"

Bestandsnaamexpansie (expand)

echo expand("%")      " path/file.txt
echo expand("%:t")    " file.txt
echo expand("%:p:h")  " /home/user/path
echo expand("%:r")    " path/file
echo expand("%:e")    " txt

Uitvoerbeheer & Berichten

silent g/pattern/p

echo 'Simple text'
echomsg 'Persistent text recorded in :messages'
echoerr 'Error message'

echohl WarningMsg | echomsg "=> Warning!" | echohl None

Configuratie-opties

set number
set nonumber
set number!
set numberwidth=5
set guioptions+=e

Introspectie & Functiedetectie

has("clipboard")
executable("python3")
globpath(&rtp, "syntax/c.vim")

exists("$ENV")
exists(":command")
exists("variable")
exists("+option")

Toetstoewijzingen (Key Mappings)

Modi

[nvixso](nore)map

Veelvoorkomende mapping-flags

Flag	Betekenis
`<buffer>`	Alleen lokaal voor huidige buffer
`<silent>`	Commando niet weergeven in statusregel
`<nowait>`	Direct uitvoeren zonder wachten op langere combinaties

Syntaxiskleuring & Conceal

Markeringsgroepen

hi Comment term=bold gui=bold ctermfg=4 guifg=#80a0ff
hi def link markdownH1 htmlH1

Bestandstypedetectie (Filetype Detection)

augroup filetypedetect
  au! BufNewFile,BufRead *.json setf javascript
augroup END

au Filetype markdown setlocal spell

Tekstverberging (Conceal)

set conceallevel=2
syn match newLine "<br>" conceal cchar=}
hi newLine guifg=green

Include-guards

if exists('g:loaded_myplugin')
  finish
endif
let g:loaded_myplugin = 1