Шпаргалка по Vimscript

Vimscript — это встроенный язык сценариев для настройки и расширения возможностей текстового редактора Vim.

Начало работы

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

Вы можете сохранить этот код в файл (script.vim) и загрузить его командой (:source script.vim), либо выполнять отдельные команды прямо в нормальном режиме через :let и :echo.

Обучение на примерах

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>

Переменные

Определение

let var = "hello"

Префиксы областей видимости переменных

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

Префикс s: также может использоваться для функций, локальных для текущего скрипта. См. :help local-variables.

Другие области видимости

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

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

Добавьте префикс & к имени опции, чтобы прочитать или изменить её значение в выражениях.

Арифметические и строковые операторы

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

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

Строки (Strings)

Синтаксис строк

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

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

echo "result = " . res

Строковые функции

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

Функции

Определение функций

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

Переопределение функций

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

Использование function! (с !) заменяет любую ранее определенную функцию с таким же именем без ошибки.

Пространства имен и автозагрузка (Autoload)

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

Вызов функций

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

Получение возвращаемых значений

let result = s:Initialize()

Прерывание при ошибке (Abort)

function! MyFunction() abort
endfunction

Переменное число аргументов (Variadic Arguments)

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

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

call Infect('jake', 'bella')

Циклы и управление потоком

Циклы (Loops)

for s in list
  echo s
  continue
  break
endfor

while x < 5
  let x += 1
endwhile

Пользовательские команды (Custom Commands)

Определение команд

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

Пользовательские команды должны начинаться с заглавной буквы. Знак ! позволяет заменить существующую команду.

Вызов функций в командах

command! Save call <SID>Foo()

function! s:Foo()
endfunction

Аргументы команд

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

Спецификатор аргумента	Описание
`-nargs=0`	0 аргументов (по умолчанию)
`-nargs=1`	Ровно 1 аргумент (может содержать пробелы)
`-nargs=?`	0 или 1 аргумент
`-nargs=*`	0 или более аргументов через пробел
`-nargs=+`	1 или более аргументов через пробел

Условные конструкции (Conditionals)

If / Elseif / Else

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

Истинность (Truthiness)

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

В Vimscript нет отдельного булева типа: 0 считается ложью, а ненулевые целые числа — истиной.

Операторы сравнения

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

Регистрозависимость строк

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

Сравнение идентичности

if a is b
if a isnot b

Проверяет, ссылаются ли a и b на один и тот же объект в памяти.

Сопоставление регулярных выражений

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

\v включает режим 'very magic', избавляя от необходимости частого экранирования спецсимволов.

Однострочные конструкции

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

Используйте | для объединения нескольких инструкций в одну строку.

Структуры данных

Списки (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")

Операции со списками

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)

Функциональные методы списков

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

Словари (Dictionaries)

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

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

Операции со словарями

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

Префиксы областей видимости (s:, g:, l:, b:) сами по себе доступны как объекты-словари:

let script_keys = keys(s:)

Числа и арифметика

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

Динамическое выполнение команд (execute)

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

Нажатия клавиш нормального режима (normal)

normal G
normal! G

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

Раскрытие имен файлов (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

Управление выводом и сообщениями

silent g/pattern/p

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

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

Опции конфигурации

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

Интроспекция и проверка возможностей

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

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

Маппинги клавиш (Key Mappings)

Режимы

[nvixso](nore)map

Основные флаги маппинга

Флаг	Значение
`<buffer>`	Только для текущего буфера
`<silent>`	Не выводить команду в строку состояния
`<nowait>`	Срабатывать мгновенно, не дожидаясь продолжения

Подсветка синтаксиса и скрытие (Conceal)

Группы подсветки

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

Определение типа файла (Filetype Detection)

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

au Filetype markdown setlocal spell

Скрытие и замена символов (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