Vimscript Spickzettel · Cheat Sheets

Vimscript ist die integrierte Skriptsprache zum Anpassen und Erweitern des Vim-Texteditors.

Erste Schritte

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

Sie können diesen Code in eine Datei (script.vim) schreiben und mit (:source script.vim) laden oder Befehle direkt im Normal-Modus über :let und :echo ausführen.

Lernen am Beispiel

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>

Variablen

Definition

let var = "hello"

Variablen-Scope-Präfixe

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

Das Präfix s: kann auch für skriptlokale Funktionsnamen verwendet werden. Siehe :help local-variables.

Weitere Gültigkeitsbereiche

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-Optionen

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

Stellen Sie Optionsnamen ein & voran, um sie in Ausdrücken zu lesen oder zu ändern.

Arithmetische & String-Operatoren

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

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

Zeichenketten (Strings)

String-Syntax

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

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

echo "result = " . res

String-Funktionen

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')

Funktionen

Funktionsdefinition

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

Funktionen überschreiben

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

Die Verwendung von function! (mit !) ersetzt eine zuvor definierte Funktion gleichen Namens ohne Fehler.

Namespaces & Autoloading

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

Funktionen aufrufen

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

Rückgabewerte erfassen

let result = s:Initialize()

Abbruch bei Fehlern (Abort)

function! MyFunction() abort
endfunction

Variadische Argumente (Variable Parameter)

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

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

call Infect('jake', 'bella')

Schleifen & Kontrollfluss

Schleifen

for s in list
  echo s
  continue
  break
endfor

while x < 5
  let x += 1
endwhile

Benutzerdefinierte Befehle (Custom Commands)

Befehle definieren

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

Benutzerdefinierte Befehle müssen mit einem Großbuchstaben beginnen. Das Ausrufezeichen ! erlaubt das Überschreiben bestehender Befehle.

Funktionen in Befehlen aufrufen

command! Save call <SID>Foo()

function! s:Foo()
endfunction

Befehlsargumente

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

Argument-Spezifikation	Beschreibung
`-nargs=0`	0 Argumente (Standard)
`-nargs=1`	Genau 1 Argument (kann Leerzeichen enthalten)
`-nargs=?`	0 oder 1 Argument
`-nargs=*`	0 oder mehr durch Leerzeichen getrennte Argumente
`-nargs=+`	1 oder mehr durch Leerzeichen getrennte Argumente

Bedingungen (Conditionals)

If / Elseif / Else

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

Wahrheitswerte (Truthiness)

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

Vimscript hat keinen eigenständigen booleschen Typ: 0 ist falsch und Zahlen ungleich null sind wahr.

Vergleichsoperatoren

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

Groß-/Kleinschreibung bei Strings

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

Identitätsvergleich

if a is b
if a isnot b

Prüft, ob a und b dieselbe Dateninstanz im Speicher referenzieren.

Reguläre Ausdrücke (Regex Matches)

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

\v aktiviert die 'very magic'-Syntax, wodurch Sonderzeichen ohne zusätzliches Escaping genutzt werden können.

Einzeilige Anweisungen

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

Verwenden Sie |, um mehrere Anweisungen auf einer Zeile zu verketten.

Datenstrukturen

Listen (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")

Listen-Operationen

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)

Funktionale Listen-Methoden

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

Wörterbücher (Dictionaries)

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

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

Dictionary-Operationen

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-Präfixe (s:, g:, l:, b:) sind selbst als Dictionary-Objekte ansprechbar:

let script_keys = keys(s:)

Zahlen & Arithmetik

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-Besonderheiten

Befehle dynamisch ausführen (execute)

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

Normal-Modus Tastenanschläge ausführen

normal G
normal! G

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

Dateinamen-Erweiterung (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

Ausgabesteuerung & Meldungen

silent g/pattern/p

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

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

Konfigurationsoptionen

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

Introspektion & Feature-Erkennung

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

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

Tasten-Mappings

Modi

[nvixso](nore)map

Häufige Mapping-Flags

Flag	Bedeutung
`<buffer>`	Nur für den aktuellen Puffer gültig
`<silent>`	Befehl nicht in der Statuszeile ausgeben
`<nowait>`	Sofort auslösen ohne auf längere Mappings zu warten

Syntax-Highlighting & Conceal

Highlight-Gruppen

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

Dateityp-Erkennung (Filetype Detection)

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

au Filetype markdown setlocal spell

Text-Verschleierung (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