Capítulo 21: Vimrc

En los capítulos anteriores has aprendido cómo usar el editor de texto Vim. Esto es genial, pero no es todo. Para usar Vim de una manera efectiva, vas a necesitar aprender cómo configurarlo. El mejor lugar para empezar es tu archivo vimrc. En los capítulos anteriores aprendiste a usar Vim. En este capítulo, vas a aprender cómo organizar y configurar vimrc.

Cómo encuentra Vim el archivo vimrc

El uso convencional de vimrc es agregar el archivo de configuración .vimrc en la carpeta de usuario ~/.vimrc (en el caso de sistemas operativos basados en Unix. Puede ser diferente dependiendo del sistema operativo).

Sin que sea percibido por el usuario, Vim busca en muchos lugares para encontrar el archivo vimrc. Estos son los lugares que revisa:

  • $VIMINIT

  • $HOME/.vimrc

  • $HOME/.vim/vimrc

  • $EXINIT

  • $HOME/.exrc

  • $VIMRUNTIME/default.vim

Cuando inicias Vim, verificará estos 6 lugares en ese orden, buscando el archivo vimrc. El primer lugar con este archivo va a ser usado y los posteriores son ignorados.

Primero Vim va a buscar $VIMINIT. Si no hay nada ahí, Vim va a buscar $HOME/.vimrc. Si no hay nada ahí, Vim va a buscar $HOME/.vim/vimrc. Si Vim lo encuentra va a dejar de buscar y usará $HOME/.vim/vimrc.

La primer ubicación, $VIMINIT, es una variable de entorno. No esta definido de manera predeterminada. Se puede usar ~/dotfiles/testvimrc como variable $VIMINIT, puedes crearte una variable de entorno con la ubicación de este archivo. Después de ejecutar export VIMINIT='let $MYVIMRC="$HOME/dotfiles/testvimrc" | source $MYVIMRC', Vim va a usar el archivo ~/dotfiles/testvimrc como tu archivo vimrc.

La segunda ubicación, $HOME/.vimrc, es la ruta usada por muchos usuarios de Vim de manera convencional. $HOME es en muchos casos el directorio del usuario raíz (~). Si existe ~/.vimrc, Vim usará este como su archivo vimrc.

El tercer lugar es para $HOME/.vim/vimrc, esta alojado dentro del directorio ~/.vim. Podrías tener el directorio ~/.vim ya para tus complementos, scripts personalizados o archivos de vistas. Ten en cuenta que no hay un punto delante del nombre del archivo vimrc ($HOME/.vim/.vimrc no funcionará, pero $HOME/.vim/vimrc sí lo hará).

El cuarto, $EXINIT funciona de manera similar a $VIMINIT.

El quinto, $HOME/.exrc trabaja de manera similar a $HOME/.vimrc.

El sexto, $VIMRUNTIME/defaults.vim es el predeterminado al compilar Vim. En mi caso, tengo instalado Vim 8.2 usando Homebrew (en MAC), por lo que la ruta es (/usr/local/share/vim/vim82). Si Vim, en ninguna de las seis ubicaciones encuentra el archivo vimrc, entonces usará este archivo.

Para lo que queda de este capitulo, estamos asumiendo que Vim utiliza el archivo en la ruta ~/.vimrc.

¿Qué poner en mi Vimrc?

La pregunta que me hice cuando me inicié fue: "¿Qué debería poner en mi archivo vimrc?"

La respuesta es, "cualquier cosa que quieras". La tentación de copiar y pegar el vimrc de otras personas es real, pero debes evitar esto. Si insistes en usar el vimrc de alguien más, revisa que sabes lo que hace, porqué y cómo él/ella usa esto, y lo más importante, si es relevante para ti. Solo porque alguien mas lo use no quiere decir que tú también lo tengas que utilizar.

Contenido básico de vimrc

En resumen, un archivo vimrc es una colección de:

  • Complementos

  • Configuraciones

  • Funciones personalizadas

  • Comandos personalizados

  • Mapeos

Hay otras cosas que he mencionado, pero en general, esto cubre la mayoría de los casos.

Complementos (Plugins)

En los capítulos anteriores, mencionamos diferentes complementos, como fzf.vim, vim-mundo y vim-fugitive.

Hace 10 años, gestionar los complementos era una pesadilla. Sin embargo, con la llegada de los gestores modernos de complementos, instalarlos hoy se puede hacer en segundos. Actualmente utilizo vim-plug como mi gestor de complementos, por eso lo usaré en esta sección. El concepto es similar al de otros gestores de complementos populares. La recomendación es que revises los disponibles, como por ejemplo:

Hay mas gestores que los listados arriba, siéntete libre en buscar información sobre ellos. Para instalar vim-plug, si utilizas Unix, ejecuta:

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

Para agregar nuevos complementos, escribe el nombre del mismo (Plug 'github-username/repository-name') entre las líneas call plug#begin() y call plug#end(). Por ejemplo, si quiere instalar emmet-vim y nerdtree, agrega las siguientes líneas en tu archivo vimrc:

call plug#begin('~/.vim/plugged')
Plug 'mattn/emmet-vim'
Plug 'preservim/nerdtree'
call plug#end()

Guarda los cambios, vuelve a leer el archivo de configuración (con el comando :source %) y ejecuta :PlugInstall para instalar ambos.

En el futuro, si necesitas eliminar los complementos que no utilizas, solo necesita eliminar el complemento del bloque escrito anteriormente, guardar, volver a leer el archivo de configuración y ejecutar el comando :PlugClean para eliminarlo de su equipo.

Vim 8 tiene su propio gestor de paquetes. Puedes consultar la ayuda con :h packages para mas información. En el próximo capítulo, vamos a mostrar como usarlo.

Configuraciones

Es común ver muchas opciones que empiezan con set en cualquier vimrc. Si ejecutas la línea en el modo línea de comandos, esta configuración no será permanente. Se perderán las mismas al cerrar Vim. Por ejemplo, en vez de ejecutar :set relativenumber number desde el modo línea de comandos cada vez que inicias Vim, se puede agregar dentro del archivo .vimrc:

set relativenumber number

Algunas veces es necesario pasar algún valor, como por ejemplo set tabstop=2. Revisa la página de ayuda para cada configuración para aprender qué tipo de valores acepta.

También se puede usar let en lugar de set (verifique anteponer el mismo con &). Con let, se pueden usar expresiones como un valor. Por ejemplo, para configurar la opción 'dictionary' a un directorio solo si ese directorio existe:

let s:english_dict = "/usr/share/dict/words"
if filereadable(s:english_dict)
let &dictionary=s:english_dict
endif

Aprenderás sobre cómo hacer scripts con Vim para asignar valores y condicionales en los próximos capítulos.

Para ver una lista de todas las posibles opciones de Vim, consulta :h E355.

Funciones personalizadas

Vimrc es un buen lugar para las funciones personalizadas. Aprenderás cómo escribir tus propias funciones de Vim en capítulos posteriores.

Comandos personalizados

Se pueden crear un comando personalizado para la línea de comandos con command.

Para crear el comando GimmeDate para mostrar el día actual:

:command! GimmeDate echo call("strftime", ["%F"])

Cuando ejecutes :GimmeDate, Vim va a mostrar la fecha como "2021-01-1".

Para crear un comando que reciba argumentos, se puede usar <args>. Si se le quiere pasar un formato específico de fecha y hora a GimmeDate:

:command! GimmeDate echo call("strftime", [<args>])
:GimmeDate "%F"
" 2020-01-01
:GimmeDate "%H:%M"
" 11:30

Si se quiere restringir el número de argumentos, se puede pasar la opción -nargs. Utiliza -nargs=0 para que no se puedan pasar argumentos, -nargs=1 para pasar un argumento, -nargs=+ para pasar por lo menos un argumento, -nargs=* para pasar cualquier cantidad de argumentos, y -nargs=? para pasar 0 ó un argumento. Si quiere pasar n argumentos, usa -nargs=n (donde n es un entero).

<args> tiene dos variantes: <f-args> y <q-args>. La primera es para pasar argumentos a una función VimScript. La última es usada para convertir la entrada del usuario en cadenas de texto.

Usando args:

:command! -nargs=1 Hola echo "Hola " . <args>
:Hola "Iggy"
" devuelve 'Hola Iggy'
:Hola Iggy
" Da un error de que la variable no ha sido definida.

Usando q-args:

:command! -nargs=1 Hola echo "Hola " . <q-args>
:Hola Iggy
" Devuelve 'Hola Iggy'

Usando f-args:

:function! PrintHola(persona1, persona2)
: echo "Hola " . a:persona1 . " y " . a:persona2
:endfunction
:command! -nargs=* Hola call PrintHola(<f-args>)
:Hello Iggy1 Iggy2
" Devuelve "Hola Iggy1 and Iggy2"

La función de arriba va a tener mucho mas sentido una vez que llegues al capítulo de las funciones Vimscripts.

Para aprender más acerca de los comandos y argumentos, consulta :h command y :args.

Mapeos

Si te ves a ti mismo haciendo de manera repetitiva la misma tarea compleja, este es un buen indicador para querer crear un mapeo para esta tarea.

Por ejemplo, tenemos estos dos mapeos en el archivo vimrc:

nnoremap <silent> <C-f> :GFiles<CR>
nnoremap <Leader>tn :call ToggleNumber()<CR>

En el primero, se mapea la combinación de teclas Ctrl-F para el complemento fzf.vim al comando :Gfiles (que busca rápidamente por archivos en un repositorio git). En el segundo, se mapea la combinación <Leader>tn para llamar a la función personalizada ToggleNumber (que cambia entre si las opciones norelativenumber y relativenumber). La combinación Ctrl-F mapea y sobreescribe la función nativa de Vim para moverse en la pantalla. El mapeo va a sobreescribir los controles de Vim si entran en conflicto. En mi caso, como nunca uso esta característica, he decidido que es conveniente sobreescribirla.

Por cierto, ¿qué es eso de tecla "leader" en <Leader>tn?

Vim tiene una tecla "líder" llamada leader para ayudarte a la hora de crear mapeados de teclas propios. Por ejemplo, he mapeado <Leader>tn para que ejecute la función ToggleNumber(). Sin la tecla leader, podría utilizar tn, pero Vim ya tiene utiliza la tecla t para acciones propias como es mover el cursor hasta antes de una ocurrencia o búsqueda.

Con la tecla leader, ahora puedo presionar la tecla asignada como leader y después tn sin que esto interfiera con el uso predeterminado de la tecla t. La tecla leader es una tecla que puedes configurar para crear tus atajos de teclado personalizados.

De manera predeterminada Vim utiliza la barra invertida como tecla leader. Por lo que <Leader>tn se convertiría en \tn.

A mi personalmente me gusta usar la tecla espaciadora que se escribe como <Space> como mi tecla para llamar a estos mapeos en vez de la barra invertida. Para usarla, agrega esto en el archivo vimrc:

let mapleader = "\<space>"

El comando nnoremap usado anteriormente se puede descomponer en tres partes:

  • n representa el modo normal.

  • nore quiere decir no-recursivo.

  • map es el nombre del comando para mapear.

Como mínimo, se podría haber usado nmap en vez de nnoremap (nmap <silent> <C-f> :Gfiles<CR>). Igualmente, es una buena práctica el usar la variante que no es recursiva para prevenir potenciales bucles infinitos al ejecutar el comando.

Esto es lo que podría haber pasado si no se usa el mapeo no recursivo. Supongamos que se quiere agregar el mapeo B para agregar el punto y coma (;) al final de la línea, luego, saltar una palabra hacia atrás (volvemos a ejecutar B que en el modo normal salta para atrás una palabra tal como necesitamos).

nmap B A;<esc>B

Cuando se presiona B ... ¡vaya! Vim agrega de manera descontrolada ; (se puede interrumpir presionando Ctrl-C). ¿Por qué pasó esto? Porque en el mapeo A;<esc>B, la letra B no hace referencia a la función nativa de Vim que es saltar una palabra hacia atrás, porque se esta refiriendo a la función mapeada que actualmente es:

A;<esc>A;<esc>A;<esc>A;esc>...

Para resolver este problema, se tiene que agregar la opción para que no sea recursivo:

nnoremap B A;<esc>B

Ahora, intente llamar a B. Esta vez si va a agregar al final de la linea ; y volver una palabra antes. El B en este mapeo representa al mapeo original de Vim al llamar a la función B.

Vim tiene diferentes mapeos para diferentes modos. Si quieres crear un mapeo para el modo insertar para salir del mismo cuando pulses jk:

inoremap jk <esc>

Los otros modos son: map (para el modo normal, visual, selección y pendiente de operador), vmap (para modos visual y selección), smap (selección), xmap (visual), omap (pendiente de operador), map! (modo insertar y línea de comandos), lmap (insertar, línea de comandos y argumentos de lenguaje), cmap (línea de comandos) y tmap (trabajo en la terminal). No vamos a entrar en detalle en todos. Para aprender más de ellos ejecuta :h map.txt.

Crea un mapeo que sea lo más intuitivo, consistente y fácil de recordar.

Organizando Vimrc

Con el paso del tiempo, tu vimrc va a crecer y se va a volver confuso. Hay varias maneras de mantener tu vimrc y que tenga un aspecto limpio:

  • Separar el archivo vimrc en varios archivos.

  • Plegando tu archivo vimrc.

Separando tu vimrc

Puedes separar tu vimrc en múltiples archivos usando el comando de Vim source. Este comando lee los comandos que hay en el archivo utilizado como argumento.

Vamos a crear dentro de la carpeta ~/.vimy vamos a llamarla /settings (~/.vim/settings). El nombre en sí es arbitrario y lo puedes llamar como quieras.

Lo vamos a separar en 4 componentes:

  • Componentes de terceros (complementos) (~/.vim/settings/plugins.vim).

  • Configuraciones generales (~/.vim/settings/configs.vim).

  • Funciones personalizadas (~/.vim/settings/functions.vim).

  • Mapeos de teclado (~/.vim/settings/mappings.vim) .

Dentro del archivo ~/.vimrc:

source $HOME/.vim/settings/plugins.vim
source $HOME/.vim/settings/configs.vim
source $HOME/.vim/settings/functions.vim
source $HOME/.vim/settings/mappings.vim

Dentro del archivo ~/.vim/settings/plugins.vim:

call plug#begin('~/.vim/plugged')
Plug 'mattn/emmet-vim'
Plug 'preservim/nerdtree'
call plug#end()

Dentro del archivo ~/.vim/settings/configs.vim:

set nocompatible
set relativenumber
set number

Dentro del archivo ~/.vim/settings/functions.vim:

function! ToggleNumber()
if(&relativenumber == 1)
set norelativenumber
else
set relativenumber
endif
endfunc

Dentro del archivo ~/.vim/settings/mappings.vim:

inoremap jk <esc>
nnoremap <silent> <C-f> :GFiles<CR>
nnoremap <Leader>tn :call ToggleNumber()<CR>

Tu archivo vimrc funcionará como hasta siempre, ¡pero ahora solo tiene 4 líneas de largo!

Con esta configuración, fácilmente ahora ves a donde hay que ir. Si necesita agregar mapeos, agregarlos en el archivo /mappings.vim. En el futuro, siempre se puede agregar mas directorios mientras el archivo vimrc crece. Por ejemplo si se necesita crear una configuración para el color del tema, se puede agregar al archivo ~/.vim/settings/themes.vim.

Manteniendo un solo archivo vimrc

Si la preferencia es tener un solo archivo vimrc para que se pueda llevar a otros equipos, se puede usar el plegado para mantener todo organizado. Agregue esto al inicio de su archivo vimrc:

" setup folds {{{
augroup filetype_vim
autocmd!
autocmd FileType vim setlocal foldmethod=marker
augroup END
" }}}

Vim puede detectar qué tipo de archivo hay en el buffer actual (con :set filetype? puede comprobarlo). Si este es un archivo del tipo vim, se puede usar el método de plegado. El método de plegado utiliza {{{ y }}} para indicar el inicio y el final de un grupo que se esta plegando.

Agregue {{{ y }}} para plegar al resto de su vimrc (no se olvide de comentar estas lineas con "):

" Configuracion de Plegado {{{
augroup filetype_vim
autocmd!
autocmd FileType vim setlocal foldmethod=marker
augroup END
" }}}
" Complementos {{{
call plug#begin('~/.vim/plugged')
Plug 'mattn/emmet-vim'
Plug 'preservim/nerdtree'
call plug#end()
" }}}
" Configuraciones {{{
set nocompatible
set relativenumber
set number
" }}}
" Funciones {{{
function! ToggleNumber()
if(&relativenumber == 1)
set norelativenumber
else
set relativenumber
endif
endfunc
" }}}
" Mapeos {{{
inoremap jk <esc>
nnoremap <silent> <C-f> :GFiles<CR>
nnoremap <Leader>tn :call ToggleNumber()<CR>
" }}}

Tu archivo vimrc debería tener un aspecto como este:

+-- 6 lines: Configuración de plegado -----
+-- 6 lines: Complementos ---------
+-- 5 lines: Configuraciones ---------
+-- 9 lines: Funciones -------
+-- 5 lines: Mapeos --------

Ejecutar Vim con o sin vimrc y complementos

Si necesita ejecutar Vim sin vimrc ni los complementos, ejecute:

vim -u NONE

Si necesita iniciar Vim sin vimrc pero si con complementos, ejecute:

vim -u NORC

Si quiere ejecutar Vim con vimrc pero sin complementos:

vim --noplugin

Si lo que necesita es ejecutar Vim con un vimrc diferente, digamos ~/.vimrc-backup, ejecute:

vim -u ~/.vimrc-backup

Configure vimrc de la manera más inteligente

Vimrc es un componente importante de la configuración de Vim. Una buena manera de empezar a crear su vimrc es leyendo los vimrcs de otras personas y de manera gradual ir creando el suyo a través del tiempo. El mejor vimrc no es el que usa el desarrollador X, es el que está configurado de la manera que mejor encaja a tu pensamiento y a tu forma personal de editar.