Cette brève est destinée aux utilisateurs de Neovim qui utilisent la quickfix list. Oui je sais, y a juste des bots IA qui vont la lire.
C'est pas grave.
J'avais un peu envie de parler de ma transition vers vim comme éditeur ou démarrer une série "Vous n'avez pas besoin de plugin pour faire X" mais ce sera pas pour tout de suite.
Ce que j'explique s'applique aussi à vim sauf que mes exemples de config seront en lua mais vous pouvez demander à une IA de les traduire en vimscript.
QUICKFIX LIST??
Ben ouais, qui utilise ce truc?
De ce que je crois comprendre, cette fonctionnalité a été créé il y a bien longtemps, dans un monde parallèle lointain où le choix de son éditeur de texte avait une certaine importance et où les gens devaient écrire eux-mêmes chaque ligne de code (ou la copier coller d'autre code — On va pas s'en priver).
Elle était liée à d'autres commandes vim oubliées comme :make.
Quand on travaillait sur un projet en C, utiliser :make lançait... La commande make et récupérait toutes les erreurs de compilation et avertissements pour peupler automatiquement une liste spéciale interne à vim: la quickfix list.
On l'appelle comme ça parce qu'il s'agit ensuite de parcourir chaque entrée pour corriger toutes les erreurs de compilation d'une traite, ou bien de tomber sur un gros morceau qui écrase tout espoir de la notion que ça allait être quick.
Du coup, non seulement personne n'utilise cette quickfix truc mais en plus personne ne connaît la commande :make et personne n'écrit de nouveaux projets en C/C++ non plus. Ah oui et aussi, vim ne fait pas vraiment partie des choix sérieux d'environnement de développement pour le programmeur moderne.
Nous voilà face à un sacré carrefour de reliques sorties tout droit d'un musée rempli de vieilles momies de barbus.
Ce qui en dit pas mal aussi sur la largeur de l'audience présumée de cet article.
Cet article serait encore plus inutile s'il n'existait pas d'autres moyens de remplir la dit quickfix list.
Et oui, d'autres moyens il y a!
Disposer d'une liste d'emplacements à examiner dans différents fichiers du projet est somme toute un cas d'utilisation courant.
Qui n'a jamais utilisé la "recherche dans les fichiers" (je sais pas comment ça s'appelle en Français) dans VS Code?
Cette recherche ignore naturellement ce qui est dans votre .gitignore. Et ça, c'est pas mal important.
Pour donner un exemple, si vous cherchez dans un bon vieux projet JavaScript avec 1GB de node_modules, utiliser grep ou une recherche "classique" (la recherche Windows? Plusieurs de mes poils de nez se sont détachés rien qu'à y penser) va tranquillement aller regarder tous les fichiers qui sont dans node_modules et bourrer tout un tas de résultats inutiles, en plus de consommer des ressources pour rien.
La quickfix list, c'est un peu comme le panneau de résultats de "RECHERCHE DANS LES FICHIERS" de VS Code mais navigable avec des raccourcis clavier et offrant des possibilités intéressantes d'application de recherche/remplacement ou macros à chaque ligne concernée (pouvant se trouver dans des fichiers différents, je rappelle).
On peut pas utiliser grep?
Ben, si. Les IA agentiques utilisent grep tout le temps. Beaucoup trop. Et pas toujours très efficacement (principalement parce qu'ils ont appris de stackoverflow où tout n'est pas optimal croyez le ou non).
Essayer de comprendre ces commandes issues par un modèle reste toutefois intéressant pour voir comment un vrai maniaque de la ligne de commande rechercherait du texte dans tout le projet. En ignorant manuellement ce qui doit l'être via arguments supplémentaires ou passage dans d'autres commandes tirant profit de la toute puissance du shell que je vais tenter de ne pas évoquer aujourd'hui.
Déjà que j'ai pu parler de vim et citer JavaScript. Faut se contenter des choses simples dans cet article que personne ne va lire.
Alors c'est quoi le problème avec grep?
En soi, aucun. Sauf ceux-ci:
- La recherche inclut tout ce qui est dans .gitignore à moins de lui dire manuellement d'ignorer les éléments de .gitignore un par un ou utiliser d'autres combinaisons de commande mystiques (par exemple en utilisant find avant grep);
- Il faut tout le temps ajouter "-r" pour spécifier qu'on veut une recherche récursive dans les sous-répertoires du projet;
- L'utilitaire cherche dans TOUS les fichiers, y compris les images, les programmes compilés, les fichiers compressés, les chansons de Clara Morgane, ... Ce qui est presque toujours une perte de temps ;
- La sortie par défaut de grep n'affiche pas les numéros de ligne et ne sépare pas clairement chaque fichier.
On peut ajouter un argument (-I) pour que grep ignore les fichiers binaires en regrettant que ça ne soit pas le cas par défaut mais on arrive un peu tard pour radicalement modifier un programme qui date des années 70.
Peut-être devrais-je aussi mentionner que grep n'existe pas sous Windows. Enfin, pas tout à fait.
Powershell a une commande maléfique avec la même finalité: Select-String. Ben ouais, c'est logique (???).
Le problème: Powershell est orienté objet. C'est-à-dire que ce sont des objets qui entrent et sortent des commandes là où tous les autres shell traditionnels utilisent du... TEXTE.
Du coup c'est même pas possible de chercher récursivement dans tous les fichiers du répertoire courant. Non j'exagère pas, c'est impossible. Ou alors j'ai raté quelque chose, je vous attends dans les commentaires comme d'habitude.
Pour une recherche récursive on part plutôt sur ce genre de plan:
Get-ChildItem -Recurse -File | Select-String -Pattern "your text"
Ou, en plus compact:
gci -r -file | sls "bash"
Le seul cas d'utilisation "simple" s'applique sur la sortie de la commande ls (concrètement défini comme un alias vers un bidule du genre Get-Items ou Get-The-Stuff-Forcing-Me-To-Type-Ginormous-Commands), parce qu'on peut envoyer la sortie de ls dans sls et récupérer les fichiers qui contiennent un certain motif.
Sauf que je viens de le réessayer et ça marche plus du tout, ça cherche dans les fichiers:
Alors que j'ai la preuve formelle d'un comportement différent en photo:
Je trouve ça plutôt audacieux d'opérer de tels changements de comportements drastiques (breaking changes comme on dit dans le métier) mais je capte rien à Powershell et j'imagine que personne ne l'utilise comme shell en fait, donc c'est pas grave? Soit.
En bidouillant pour cette article j'ai aussi découvert l'existence du grep pour Windows originel: findstr.
Ce programme existerait depuis Windows 2000 (voire NT4, je vais pas vérifier) et fonctionne vaguement comme grep sauf que la recherche se fait uniquement en ASCII.
Par conséquent, chercher des caractères accentués ou afficher du Français ça le fait pas du tout, ce qui fait de findstr un genre de grep raciste américano-centriste. C'est mieux que rien je suppose?
Ce n'est évidemment pas non plus une commande (COMMANDELETTE??) Powershell bien qu'on puisse l'invoquer depuis Powershell (comme tout autre programme).
Si on regarde la page d'aide sur l'option grepprg dans vim et Neovim, on voit qu'ils utilisent findstr sous Windows par défaut. Mais bon... Autant utiliser :vimgrep et avoir une recherche qui fonctionne avec tous les caractères spéciaux.
Pour reprendre la question qui était le titre de cette section: on peut tout à fait utiliser grep associé à d'autres commandes shell (sed, awk, perl, voire un interpréteur de script comme node) pour réaliser un gros refactoring de texte dans tout le projet.
Ceci dit, contrôler précisément chaque changement devient difficile, on est obligés de quitter l'éditeur et l'espace mental de "je suis en train d'éditer du code" et si vous avez déjà utilisé sed (ou awk ou perl lol) vous sachez que ça va être plus douloureux qu'une bouteille de 5l de Cristaline dans les gonades, pour différentes raisons.
Pour rester dans l'ère du temps, vous pouvez demander à une IA de générer une commande shell infernale qui réalise votre changement. Mais alors autant juste demander à une IA de réaliser le changement.
Attendez une minute... Pourquoi on fait pas juste ça? PARCE QUE C'EST PAS CHOUETTE. Voilà, j'ai osé le dire. Purée ça fait du bien.
Dans vim, on peut intégrer les résultats de grep dans la quickfix list en utilisant la commande :grep, qui en fait appelle un programme configurable (comme :make) ouvrant ainsi une multitude de possibilitudes.
J'ai aussi volontairement omis une autre possibilité: la commande :vimgrep qui représente simplement une méthode pour rechercher dans plusieurs fichiers intégrée à vim/neovim (en intégrant bien entendu les résultats en quickfix list).
Du coup vimgrep fonctionne sous Windows. Sa syntaxe n'est pas la même que celle de grep parce qu'il utilise les regex de vim et, en gros, la même syntaxe que la recherche dans vim en règle générale.
Par exemple, un grep récursif s'écrit comme ceci:
:vimgrep /ce-que-je-cherche/ **/*
Cette fonction interne à vim charge tous les résultats en mémoire et est relativement lente. Pas juste à cause de sa situation mono-thread, je le trouve toujours plus lent que la commande grep quand il y a beaucoup de fichiers.
Peut-être que c'est juste dans ma tête hein.
Pour une raison obscure, l'alias de :vimgrep est :vim. C'est-à-dire qu'on utilise la commande... :vim... Pour chercher dans les fichiers. OK peut-être je suis le seul à trouver ça bizarre. Peut-être je suis le seul ici à utiliser vim tout court.
Un de ses avantages potentiels réside dans sa capacité à détecter différents types d'encodage texte puisque les fichiers sont plus ou moins "ouverts dans vim".
Les autres utilitaires de recherche ont du mal à détecter du texte dans des fichiers encodés de différentes manières (particulièrement UTF-16).
Bon et aussi, la syntaxe de recherche de vim peut s'avérer troublante quand on a l'habitude de taper des regex d'autres langages. Par exemple, pour rendre la recherche insensible à la casse il faut ajouter le fameux "\c":
:vimgrep /ce-que-je-cherche\c/ **/*
On peut évidemment fournir une liste de fichiers ou un motif pour les fichiers dans lesquels il s'agit de chercher le texte à rechercher. Purée je parle bien.
Exemples:
:vimgrep /ce-que-je-cherche\c/ **/*.js
Plusieurs extensions:
:vimgrep /ce-que-je-cherche\c/ **/*.{js,ts}
Une alternative à grep: ripgrep
J'insiste sur la mention "une alternative", il y en a d'autres qui étaient là avant ripgrep, qui correspond à la commande rg bien courte, efficace, appétissante.
On pourrait catégoriser rg parmi les nombreuses re-écritures en Rust de différents utilitaires sauf que l'IA n'était pas dispo à l'époque et c'était même pas encore la "mode" du Rust.
Son comportement par défaut correspond nettement plus à l'utilisation humaine la plus courante:
- La recherche est récursive par défaut ;
- Les fichiers cachés, binaires, et tout ce qui est dans .gitignore est ignoré par défaut (des options permettent évidemment de les inclure si besoin et le programme lit aussi le contenu de .ignore et .rgignore si besoin — je pense qu'on peut aussi en définir un global pour tous vos projets et cette parenthèse est en train de devenir extrêmement longue donc je vais m'arrêter là) ;
- La sortie par colorisée par défaut, même sous Windows (où rg fonctionne super bien soit dit en passant) et affiche les numéros de lignes ainsi qu'une séparation plus claire des différents fichiers où le motif a été trouvé.
Accessoirement, rg utilise plusieurs fils d'exécution pour sa recherche et d'autres optimisations qui le rendent particulièrement rapide.
Au plus vous disposez d'une machine puissante et d'un stockage rapide, au plus rg ressemble à de la magie noire et vous fait questionner le sens de la vie des systèmes de base de données, des index fulltext et des arbres binaires noirs et blancs multimodaux à induction.
Son avantage est décuplé sous Windows qui a toujours eu du mal avec la recherche entre le service d'indexation et explorer.exe qui troue son slip et le menu démarrer qui chercher aussi sur BING alors que vous cherchez juste à ouvrir Word, un utilitaire de recherche ultra rapide est le bienvenu.
On peut l'installer en ligne de commande avec winget de nos jours:
winget install ripgrep
Intégrer ripgrep à vim
Ben écoutez y a plus qu'à ajouter ça à votre vimrc:
if executable('rg')
set grepprg=rg\ --vimgrep\ --hidden
set grepformat=%f:%l:%c:%m
endif
On peut omettre la seconde ligne. Elle permet juste d'ajouter la colonne où le contenu a été trouvée en plus de la ligne, ce qui permet à vim de se déplacer directement sur le motif lorsqu'on parcourt la quickfix list.
J'en profite pour souligner que cette commande grep ne se comporte pas comme la commande par défaut puisqu'on ignore les fichiers binaires et tout ce qui est dans .gitignore, la commande est récursive par défaut, l'argument cible n'est pas nécessaire, ...
On change non seulement la sortie mais la syntaxe de la commande est celle de rg et plus de grep.
On cherche tout de même dans les fichiers cachés sauf s'ils sont dans un .gitignore. Notez ce détail sur un PostIt quelque part où ça va vous mordre les doigts dans un future proche.
Avec cette config je peux chercher dans tout mon projet en utilisant:
:grep circoncis
Je peux ensuite ouvrir la quickfix list (ou pas, on peut aussi juste naviguer d'un résultat à l'autre), avec :copen. Retenez le "c" pour quickfix (???).
En vrai si vous avez vraiment envie d'utiliser :grep avec un mono-fichier parce que vous adorez la quickfix list (je peux comprendre), il s'agit simplement de mentionner le fichier:
:grep "circoncis" la_bible.txt
Voire plus classe (% étant le buffer en cours):
:grep "circoncis" %
Rien ne vous empêche de mentionner plusieurs fichiers et autres GLOBS.
On peut aussi ajouter à la quickfix list plutôt que de la remplacer avec chaque nouvelle commande en utilisant :grepadd ou vimgrepadd. Autant vous dire tout de suite que vraiment personne au monde ne fait ça.
A propos, je vous partage un truc qui impressionne les filles à tous les coups: utiliser la local list.
C'est comme la quickfix list mais... Locale à la fenêtre en cours si vous utilisez plusieurs fenêtres au sens de vim qui sont en réalité des vues ou PARTITIONS D'ÉCRAN sur des buffers, à ne pas confondre avec les buffers. Je me suis chié dessus, je reviens. OK donc la commande c'est :lgrep au lieu de :grep puis ce sont les mêmes commandes que la quickfix list mais avec un l devant au lieu du c (lopen, etc.).
Par exemple, si vous aimez bien avoir vim en plein écran avec deux fichiers ouverts en même temps sur un écran divisé en deux horizontalement, ben vous pouvez avoir une liste "locale" de chaque côté de l'écran.
Perso je trouve que ça reviens à beaucoup trop diviser son cerveau mais on est tous un peu différents. Je crois? Mis à part que ma manière de travailler est probablement la meilleure.
Lors de l'exécution de :grep, la sortie de rg va chaque fois s'afficher en plein écran d'abord (suivie d'un sympathique "APPUYEZ SUR ENTER") et finalement j'apprécie ce comportement parce que ça me permet d'avorter rg si je vois qu'il est en train de chercher dans beaucoup trop de trucs ou dans mes fanfics de Bob l'Éponge.
J'ai vu des gens qui utilisent du gros vimscript des familles pour détecter s'ils sont dans un REPOSITOIRE git, auquel cas ils utilisent git grep au lieu du grep standard.
La commande git grep cherche simplement dans les fichiers qui sont suivis par git pour le projet en cours.
Demandez à une IA si vous voulez ce genre de config moi je garde rg.
Notons tant qu'on y est que la page de manuel de rg se montre un peu frileuse par rapport à l'argument --vimgrep en cela qu'il peut démultiplier la mémoire nécessaire par rapport à la taille des données d'entrée. On peut le limiter en baissant le nombre max de threads.
Nous on va pas le faire parce qu'on est riches et on a plein de RAM.
Et pour Neovim?
Neovim utilise déjà rg par défaut s'il est présent pour sa commande grep. Par contre il lui donne les options "-uu" qui activent la recherche dans les fichiers du .gitignore.
On peut voir la config par défaut exacte avec un petit :help grepprg:
Ces options par défaut ne correspondent néanmoins pas trop à mes besoins.
Bon ben y a plus qu'à changer la config. Après tout, qui utilise Neovim sans toucher à sa config?
En gros c'est la même chose qu'avant mais en Lua, donc mieux (en fait Neovim est compatible avec le vimscript):
if vim.fn.executable("rg") == 1 then
vim.opt.grepprg = "rg --vimgrep --hidden"
vim.opt.grepformat = "%f:%l:%c:%m"
end
Et c'est parti pour la recherche dans le projet sans plugins et avec la quickfix list. Tout ça avec pas mal de possibilités pour aller plus loin, par exemple avec un raccourci clavier qui entre déjà la commande :grep pour vous avec certains arguments.
Parlons tout de même brièvement des plugins qui répondent aussi à ce cas d'utilisation:
- Telescope a un sélecteur qui utilise rg en direct et montre immédiatement les résultats — Utiliser Ctrl+q ajoute les résultats dans la quickfix list (Telescope est exclusif à Neovim);
- Il y a une série d'autres plugins de type sélecteur et le plus simple fzf qui fonctionne aussi dans vim.
Suis censé faire quoi avec cette QUICKFIX LIST?
Allez, je suis sympa, je vais donner les bases.
- copen — "cope" en version courte, ouvre la quickfix list en tant que fenêtre séparée;
- ccl — "cclose" en version longue... Oui j'utilise la version courte pour celui-là mais pas pour ouvrir — Ferme la quickfix list;
- cn — (abrévié de "cnext") se rend à l'emplacement suivant dans la liste (peut changer de fichier, la quickfix list ne doit pas être ouverte pour que ça fonctionne je précise au cas où);
- cp — Se rend à l'emplacement précédent;
- cfirst — Se rend au premier emplacement;
- clast — Se rend au dernier emplacement.
La quickfix list ne boucle pas quand on arrive à la fin. Normalement ça signifie qu'on a tout passé en revue, on a fini, on est content.
Pour la fameuse LISTE LOCALE que personne n'utilise, on supplante simplement le "c" par un "l" dans ces commandes, par exemple lopen et lclose.
Ceux et celles qui utilisent souvent les listes vont définir un raccourci clavier pour ces différentes choses et particulièrement le suivant et précédent.
La chance, un tel raccourci est déjà défini dans Neovim (pas dans vim):
- ]q — Element suivant de la quickfix list;
- [q — Element précédent de la quickfix list.
Le raccourci s'avère assez maladroit pour les utilisateurs d'Azerty dont je fais partie. Mais j'ai pris l'habitude des positions bizarres de pouce sur AltGr.
La touche "[" et son copain sont accessibles directement sans shift sur un clavier QWERTY. Mais bon, si vous êtes réellement un utilisateur vim de francophonie vous savez déjà ce que ça fait d'avoir l'impression que le monde n'a pas été créé pour vous.
Dur.
Appliquer une opération sur chaque entrée de la liste
Le truc le plus classe que les magiciens de vim vont te montrer avec la quickfix list, c'est cdo.
Cette commande applique une commande Ex (le plus simplement un recherche/remplacement par ex. mais tout est possible) à chaque entrée de la liste, automatiquement.
Toute l'histoire d'utiliser ces listes pour du refactoring vient de l'existence de cdo.
Par exemple, pour renommer la variable patate en pommeDeTerre partout dans le projet, on peut commencer par :grep "patate\b" (j'ajoute le \b pour ne pas sélectionner des mots comme "patateur", ne fonctionne qu'avec la config rg de cette brève ou la syntaxe est différente) puis on lance ce type de commande:
cdo s/patate/pommeDeTerre/g
Où le flag "g" n'est pas vraiment nécessaire avec notre config. Mais ça coûte rien de l'ajouter. Me demandez pas pourquoi je sais pas vraiment pourquoi lol.
Après avoir pressé Entrée on se retrouve avec la quickfix list inchangée mais pourtant tout a bien été modifié.
Par contre rien n'a été sauvegardé. Vous devez lancer un bon gros :wa pour ça (et peut-être tout passer en revue avant, les buffers modifiés seront tous ouverts dans la session en cours).
Pour rester dans la recherche/remplacement, le flag /c est souvent utilisé et vous demande de confirmer le remplacement pour chaque entrée de la quickfix list. Très utile pour les frileux du MODE YOLO.
Aussi, si vous utilisez vraiment Neovim comme environnement de développement pour du vrai sérieux officiel (on est au moins deux alors) vous savez que les LSP existent et offrent des fonctions de renommage (d'office c'est pas un vrai mot "renommage") d'objets de langage en tout genre.
Utiliser le LSP pour ce genre de choses est toujours préférable. Sauf si le LSP et/ou votre travail est pourri. Par exemple si vous devez modifier des projets PHP5 des années 2000 comme moi. Alors oubliez le LSP.
Tant qu'on parle des LSP, ils offrent généralement la possibilité de chercher toutes les références d'un élément (variable ou fonction par exemple) peut popu... Populer? Peupler? La quickfix list avec ces entrées.
Mais bon, sur un vieux container Docker dégeulasse ou un serveur vous n'allez pas avoir accès à tous ces artifices qui n'existaient pas quand j'étais jeune, et comme on applique tous et toutes la bonne pratique d'éditer le code directement sur le serveur, c'est bien de savoir comment utiliser :grep (ou :vimgrep hein) et cdo.
Contrairement à ce qu'on voit dans tous les tutos au monde, cdo ne se limite pas à chercher/remplacer.
Par exemple, moi j'aime bien utilisé norm qui indique de passer en "NORMAL MODE" et appliquer diverses commandes de positionnement horizontal puis d'édition ou suppression. Vous pouvez même ajouter la séquence correspondant à Esc dans l'histoire et avoir quelque chose de très complexe.
Oui, je vois ce que vous pensez, c'est exactement la même chose qu'un macro (une macro? Un maquerau?) sauf que vous l'écrivez au lieu de l'enregistrer (enfin, c'est possible d'écrire un macro aussi mais je pense qu'on va un peu se calmer PARCE QUE TOUT EST POSSIBLE DANS VIM).
Imaginons un cas d'utilisation récent lié à une des 80000 bonnes grosses failles de sécurité qu'on se tape tous les trois jours depuis quelques mois: Nginx2Root.
Les failles les plus dangereuses de cette découverte ont besoin que le protocole HTTP/2 soit activé. Sur les "vieux" Nginx (les paquets Debian quoi) ça ressemble à ce genre de lignes:
server {
listen 443 ssl http2;
listen [::]:443 ssl http2;
# Reste de la config...
}
Je peux ouvrir mon vieux vim dans le répertoire avec les sites actifs (/etc/nginx/sites-enabled sous Debian) et ensuite lancer un :grep "http2" (faut changer la syntaxe si c'est vim de base sans rg ou utiliser vimgrep).
Avec ma quickfix list prête, reste plus qu'à virer la mention "http2" en tapant:
:cdo norm t;daw
Ce qui correspond à:
- Positionner le curseur un caractère avant le ";"
- Effacer le mot et les espaces qui l'entourent (daw)
Et hop, toutes vos config de sites n'ont plus d'HTTP/2.
Pour exécuter un macro sur chaque entrée de la quickfix list, on peut aussi utiliser norm:
:cdo norm @a
On applique ici le macro qui se trouve dans le registre de macro "a".
Je vais m'arrêter là mais il y a vraiment tout un tas de possbilité. Je parlais de "commandes Ex" plus haut en référence à l'ancètre de vim (oui vi/vim ont un ancètre) et, par exemple, la commande d va juste effacer toutes les lignes qui sont dans la quickfix list avec:
:cdo d
Difficile de faire plus simple n'est-ce pas?













Commentaires
Il faut JavaScript activé pour écrire des commentaires ici