Guia de referência do Vimscript

O Vimscript é a linguagem de script integrada para personalizar e estender o editor de texto Vim.

Primeiros Passos

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

Você pode salvar este código em um arquivo (script.vim) e carregá-lo com (:source script.vim), ou executar comandos no modo normal via :let e :echo.

Aprendendo com Exemplos

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>

Variáveis

Definição

let var = "hello"

Prefixos de Escopo de Variáveis

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

O prefixo s: também pode ser usado para nomes de funções locais ao script. Consulte :help local-variables.

Outros Escopos

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

Opções do Vim

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

Adicione o prefixo & aos nomes das opções para lê-las ou modificá-las em expressões.

Operadores Aritméticos e de Strings

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

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

Strings (Cadeias de Caracteres)

Sintaxe de Strings

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

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

echo "result = " . res

Funções de Strings

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

Funções

Definição de Funções

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

Sobrescrevendo Funções

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

Usar function! (com !) substitui qualquer função definida anteriormente com o mesmo nome sem lançar erros.

Namespaces e Autoloading

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

Invocando Funções

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

Capturando Valores de Retorno

let result = s:Initialize()

Interrupção em Caso de Erro (Abort)

function! MyFunction() abort
endfunction

Argumentos Variádicos

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 e Controle de Fluxo

Loops

for s in list
  echo s
  continue
  break
endfor

while x < 5
  let x += 1
endwhile

Comandos Personalizados (Custom Commands)

Definindo Comandos

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

Comandos definidos pelo usuário devem começar com letra maiúscula. O ponto de exclamação ! permite substituir um comando existente.

Chamando Funções em Comandos

command! Save call <SID>Foo()

function! s:Foo()
endfunction

Argumentos de Comandos

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

Especificador de Argumento	Descrição
`-nargs=0`	0 argumentos (padrão)
`-nargs=1`	Exatamente 1 argumento (pode conter espaços)
`-nargs=?`	0 ou 1 argumento
`-nargs=*`	0 ou mais argumentos separados por espaço
`-nargs=+`	1 ou mais argumentos separados por espaço

Condicionais

If / Elseif / Else

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

Validação Booleana (Truthiness)

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

O Vimscript não possui um tipo booleano dedicado: 0 é falso e inteiros diferentes de zero são verdadeiros.

Operadores de Comparação

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

Sensibilidade a Maiúsculas em Strings

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

Comparação de Identidade

if a is b
if a isnot b

Verifica se a e b apontam para a mesma instância exata na memória.

Correspondência com Expressões Regulares

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

\v ativa a sintaxe 'very magic', facilitando caracteres especiais sem necessidade de escapes excessivos.

Instruções em Linha Única

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

Use | para encadear múltiplas instruções em uma única linha.

Estruturas de Dados

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

Operações com Listas

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)

Métodos Funcionais de Listas

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

Dicionários (Dictionaries)

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

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

Operações com Dicionários

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

Prefixos de escopo (s:, g:, l:, b:) são acessíveis como dicionários:

let script_keys = keys(s:)

Números e Aritmética

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)

Especificidades do Vim

Execução Dinâmica de Comandos (execute)

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

Executando Teclas em Modo Normal (normal)

normal G
normal! G

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

Expansão de Nomes de Arquivo

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

Controle de Saída e Mensagens

silent g/pattern/p

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

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

Opções de Configuração

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

Introspecção e Detecção de Recursos

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

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

Mapeamento de Teclas (Key Mappings)

Modos

[nvixso](nore)map

Opções Comuns de Mapeamento

Opção (Flag)	Significado
`<buffer>`	Local apenas ao buffer atual
`<silent>`	Não exibir comando na linha de status
`<nowait>`	Executar imediatamente sem esperar sequências mais longas

Realce de Sintaxe e Conceal

Grupos de Destaque

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

Detecção de Tipo de Arquivo

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

au Filetype markdown setlocal spell

Ocultação de Texto (Conceal)

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

Guardas de Inclusão

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