Vim

De Wiki doc

Vim est un éditeur de texte, bifurcation de vi, signifiant "VI aMélioré" permettant d'éditer des documents de type texte (notamment des fichiers de configuration) dans un terminal ou une console (shell). Il ne nécessite pas d'interface graphique pour être exécuté, ce qui en fait un excellent outil sur un serveur, dépourvu d'environnements de bureau.

Installation

apt install vim

Comportement

Vim possède 5 modes :

  1. Le mode interactif
  2. Le mode insertion
  3. Le mode commande
  4. Le mode visuel
  5. Le mode recherche

Mode interactif

Lorsque Vim est exécuté, il est par défaut en mode interactif. Ce mode permet d'utiliser des combinaisons de touche pour interagir avec le texte du document en cours d'édition. Il est par exemple possible, en une combinaison, de couper 4 lignes de texte et de les coller dans un autre emplacement du document, voir dans un autre document.

Mettre un tableau avec les touches qu'on utilise souvent avec le mode interactif

Mode insertion

Le mode insertion est le mode classique d'édition de texte. C'est celui dans lequel on tape du texte comme dans n'importe quel autre éditeur.

Pour revenir au mode interactif, il faut presser la touche <Echap>.

Mode commande

Ce mode permet d’interagir avec Vim par l'intermédiaire de commandes. Ces dernières vont permettre d'enregistrer le document, quitter Vim, importer un document dans un autre, passer des expressions régulières, activer des options et bien d'autres choses...

On entre une commande en étant au préalable en mode interactif et en tapant :.

Quelque commandes

Activer l'affichage des numéros de lignes

se nu

désactiver l'affichage des numéros de lignes

se nu!

Activer la coloration syntaxique

syn on

Désactiver la coloration syntaxique

syn off

Afficher la ligne où se trouve le curseur

set cursorline

Masquer le trait de soulignement

set cursorline!

Commenter plusieurs lignes

,+4 s/^/#/g

Dé-commenter plusieurs lignes

.,+4 s/^#//g

Plus simple, pour commenter (après une sélection des lignes à commenter en mode visuel bloc <maj>+<v> et un appui sur :)

s/^/#

Dé-commenter (après sélection <maj>+<v> + :)

s/#//

ou <maj>+<v> puis <x>.

Ajouter en fin de ligne (après sélection <maj>+<v> + :)

s/$/\ :\ 
s/$/;

Ajouter au niveau du curseur (après sélection <ctrl>+<v> + :)

s/\%V/\ :
s/\%V/^I

vim ajouter à partir du curseur (À trouver) http://andrewradev.com/2011/05/08/vim-regexes/

Placer des curseur là ou on veut pour pouvoir utiliser les regex d'en haut de façon ultra puissante

Remplacer un mot par un autre

%s/Mot_initial/Nouveau_mot/g

Changer encodage caractère

set fileencoding=latin1
set fileencoding=utf-8

Auto complétion CSS (une fois renseigné, faire <ctrl>+<x> + <ctrl>+<o>)

set omnifunc=csscomplete#CompleteCSS

Exécuter une commande Bash sans quitter Vim

!Commande_À_Exécuter

Importer un fichier depuis Vim

r Chemin_fichier

Indentation automatique

se ai

Permettre un copier/coller respectant l'indentation avec se ai

se paste

Activer/désactiver se paste en appuyant sur <F2>

set pastetoggle=<F2>

Insensibilité à la casse (utile pour le mode recherche notamment)

se ic

Activer le curseur de sélection avec la souris

se mouse=a

Désactiver le curseur de sélection avec la souris

se mouse=

Scinder l'écran pour ouvrir un autre fichier horizontalement

split [Nom_fichier] ou :sp

En vertical

vspli ou :vsp

INFORMATION

Le couple <ctrl-w> + flèche permet de passer d'un fichier à l'autre.

Redéfinir l'espace de l'indentation (pour passer de 8 espaces à 3)

set tabstop=3
set shiftwidth=3
set softtabstop=3

Convertir des indentation "espace" en indentation "tabulation"

%retab!

Créer et gérer des onglets

tabnew [nom_fichier]

Se déplacer dans les onglets

En avant : gt, en arrière : gT.

Ouvrir plusieurs fichiers dans un onglet chacun (à exécuter dans Bash) :

vim -p fichier1 fichier2 fichier3

Convertir du texte en majuscule ou en minuscule

  • Inverser la casse : sélectionner le texte avec ctrl+v et faire un ~

ou

  • On peut utiliser U pour mettre en majuscule ou u pour mettre en minuscule

Masquer les commentaires d'un fichier (à ajouter dans un fichier de configuration)

set fdm=expr
set fde=getline(v:lnum)=~'^\\s*#'?1:getline(prevnonblank(v:lnum))=~'^\\s*#'?1:getline(nextnonblank(v:lnum))=~'^\\s*#'?1:0

Pour déplier temporairement un bloc de commentaires (un bloc correspondant dans ce cas à plusieurs lignes consécutives commençant par le caractère #), placez votre curseur sur le pli correspondant au bloc compacté et tapez zo (ou pressez simplement sans sélection pour agir sur tout le document), et zm pour le replier. Si vous avez déplié plusieurs blocs, vous pouvez tous les replier d'un coup avec zM ; à l'inverse, vous pouvez déplier tous les blocs d'un seul coup avec zi.

Utiliser Vim en tant qu'éditeur hexadécimale (source)

%!xxd

Revenir à la normal

%!xxd -r

ATTENTION

Un enregistrement en mode hexadécimale enregistrera le texte comme tel, il faudra alors désactiver ce mode et réenregistrer le document pour revenir à la normal.

Garder la position du curseur là où il était à la fermeture du fichier

if has("autocmd")
	au BufReadPost * if line("'\"") > 0 && line("'\"") <= line("$") | exe "normal! g'\"" | endif
endif

Désactiver les fonctions agaçantes

Avec les mises à jour de Vim, de plus en plus de fonctions inutiles et contres-productives sont installées par défaut (Debian Stretch, si tu m'entends...). Ce qui suit a pour but de rendre Vim de nouveau utilisable comme dans le bon vieux temps.

Désactiver l'ajout automatique de commentaires (source)

set formatoptions-=cro

Désactiver la gestion de la souris (qui empêche le copier/coller !)

set mouse=

Corrections de bogues

Corriger le problème des flèches qui affichent A B C D

De façon totalement aléatoire et sur certaines configurations, l'utilisation des flèches au clavier enclenche automatiquement le monde insertion et tape les lettres A, B, C ou D en fonction de la flèche pressée. Il semble que la façon de régler ce problème diffère selon les configurations. Une liste impressionnante de palliatifs est trouvable ici. La solution n°24 a réglée celui rencontré sur une Debian 12 installée via PXE comme des centaines d'autres chaque années dans mon infrastructure (celle-là a décidée de me faire chier).

Il faut re-cartographier les touches fléchées en ajoutant ceci dans le ~/.vimrc :

nnoremap <silent> <ESC>OA <UP>
nnoremap <silent> <ESC>OB <DOWN>
nnoremap <silent> <ESC>OC <RIGHT>
nnoremap <silent> <ESC>OD <LEFT>
inoremap <silent> <ESC>OA <UP>
inoremap <silent> <ESC>OB <DOWN>
inoremap <silent> <ESC>OC <RIGHT>
inoremap <silent> <ESC>OD <LEFT>

Presses papiers

Vim possèdes plusieurs presses papiers appelés registres (register ou buffers) qui peuvent être exploités afin de maintenir plusieurs copier/coller en mémoires. Il y en a un par lettre de l'alphabet. Ils s'utilisent en mode interactif avec les touches <">+<lettre>+<raccourci> de cette manière :

ATTENTION

Le contenu des presses papiers est sauvegardé même après avoir quitté Vim (ces informations sont stockés dans le fichier ~/.viminfo). Ceci peut avoir des conséquences en terme de confidentialité des informations. Au besoin, pensez à utiliser le registre poubelle ainsi que la suppression du contenu des registres expliqué plus bas.

Copier des lignes dans des presses papiers différents

"ayy, "byy, "cyy.

Coller des lignes depuis des presses papiers différents

"ap, "bp, "cp.

Pour ajouter une ligne à un presse papier, il faut préciser la lettre du presse papier voulu, en majuscule "Byy.

Pour copier/coller en prenant en compte le presse papier par défaut (celui que l'on à lors d'un simple yy)

"+yy copie une ligne pour le presse papier par défaut, et "+p colle le presse papier par défaut (ceci n'a aucun intérêt...).

Registre poubelle (équivalent du /dev/null). Permet de supprimer des lignes sans les conserver dans un registre "_dd

Pour vider le contenu d'un registre, il faut utiliser la commande :let @a = en remplaçant la lettre par celle de votre registre ( utiliser " pour le registre par défaut).

Historique

L'historique de l'éditeur est parsemé dans le fichier ~/.viminfo.

Pour purger intégralement celui des recherches, il est possible de faire :call histdel('/'). Pour celui des commandes, on fera :call histdel(':').

Il est également possible de ne supprimer qu'une entrée en particulier via un motif: :call histdel(":", "MOT_CLÉ_CONTENU_DANS_VOTRE_COMMANDE").

Macros

Définir l'intérêt des macros...

Créer des macros q+<lettre> pour passer en mode enregistrement.

q pour terminer l'enregistrement.

@+<lettre> pour la jouer (ça fait comme un presse papier).

Fichiers de configuration

Les fichiers de configuration de Vim permettent de définir des paramètres activés à chaque lancement de l'éditeur. Il en existe deux types :

  • Un général, actif pour tout les utilisateurs du système : /etc/vim/vimrc
  • Un courant, pour chaque utilisateurs en particulier : ~/.vimrc

Il suffit de renseigner des commandes Vim (sans les :) dans ces fichiers pour que leur effet soit permanent.

Pour exécuter Vim tout en ignorant les fichiers de configuration :

vim -u NONE

Greffons

Il est possible d'ajouter des fonctionnalités supplémentaires à Vim par l'intermédiaire de greffons (plugins). Il sont à mettre (selon le même principe que le vimrc) dans le répertoire général /etc/vim/ ou dans ~/.vim/ pour les rendre spécifiques à chaque utilisateur.

Greffons que j'utilise

Pour une configuration adaptée à un développement WEB, les informations de ce dépôt peuvent-êtres utiles.

Emmet

Orienté programmation web, le greffon Emmet (anciennement Zen Coding) permet, en utilisant une syntaxe (très) raccourcie, d'écrire du code HTML et CSS de façon extrêmement efficace. De plus, il est disponible sur une multitude d'éditeurs. Il s'installe de la façon suivante :

  1. Télécharger Emmet depuis les sources
  2. Décompresser les répertoires autoload et plugin dans ~/.vim/


Pour utiliser Emmet, il faut écrire dans un fichier les différentes expressions possibles et faire la combinaison de touches (en mode interactif) <c-y>, (faire ctrl + y et ensuite sur ,).

IndentLine

IndentLine permet d'afficher une ligne verticale marquant le niveau d'indentation de votre code. Il est très utile notamment lorsque les bloques de code sont imbriqués sur énormément de niveau (rendant le repérage visuel extrêmement difficile). Il s'installe de la façon suivante :

  1. Télécharger IndentLine depuis les sources
  2. Décompresser le répertoire plugin dans ~/.vim/
  3. Ajouter dans le .vimrc ce paramètre (l'espace de fin est important) : set list lcs=tab:\|\

Gestionnaire de greffons

Vim-plug

Télécharger le greffon

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

Ajouter les greffons à installer et ajouter dans le vimrc

call plug#begin()
Plug 'junegunn/vim-easy-align'
Plug 'vim-airline/vim-airline'
Plug 'vim-airline/vim-airline-themes'
Plug 'hzchirs/vim-material'
call plug#end()

On trouve les noms de ces greffons sur leur page GIT.

Installer les greffons mis dans le vimrc (aller dans vim)

:PlugInstall

INFORMATION

Tout est mis dans .vim. Le paquet git est nécessaire.

Un exemple de .vimrc

se nu
se termguicolors
set pastetoggle=<F2>

"L'indentation passe à 3 caractères
set tabstop=3
set shiftwidth=3
set softtabstop=3

"Activer les greffons
call plug#begin()
   Plug 'junegunn/vim-easy-align'
   Plug 'vim-airline/vim-airline'
   Plug 'vim-airline/vim-airline-themes'
   Plug 'hzchirs/vim-material'
call plug#end()

"Appliquer le thème vim-matérial
colorscheme vim-material
let g:airline_theme='material'

Sources de la section

Couleurs 24bits

Pour avoir des couleurs plus sympas avec Vim (remplace le syn on), il faut utiliser se termguicolors. Attention, il faut que le terminal utilisé soit compatible. Cette page Github peut aider à déterminer si c'est le cas.

Sources