Lister les lignes trop longues (via Occur)

Il est très courant de programmer avec un nombre de caractères maximum par lignes. Par exemple, comme je travaille essentiellement sur un écran 13 pouces, le code que j'écris — sur mes projets personnels, pour les projets professionnels, je m'adapte à la convention en vigueur — ne dépasse jamais 80 caractères, me permettant d'avoir, sur un seul écran, deux buffers verticaux adjacents.

Mise en contexte

Comme les formaters/linters de code sont devenu légion dans l'industrie informatique (permettant aux développeurs de ne plus se soucier de ce genre de détails), il est assez rare de s'embarrasser de ce genre de détails. Cependant, il arrive que pour certains projets, pour des raisons divers et variées, aucun formatteur de code n'est mis en place. Comme j'ai perdu l'habitude de réfléchir au formattage de mon code (utilisant, en OCaml, l'excellent ocamlformat), limiter la taille de mes lignes n'est plus un automatisme !

En ce moment, je travaille, professionnellement, sur Merlin, et la base de code n'utilise pas ocamlformat, j'ai donc soumis un patch en n'oubliant de vérifier que je n'introduisais pas de ligne trop longue.

Pour éviter de vérifier chaque ligne (je suis aussi très nul avec grep), j'ai cherché une solution dans Emacs, et je suis tombé sur la page Find Long Lines expliquant très précisemment comment trouver les lignes trop longues. Cependant, à la lecture des propositions, je me suis rendu compte que ... je ne comprenais pas les solutions que l'on me proposait ... (la honte). La raison de mon incompréhension était que je n'avais aucune idée de ce qu'était le paramètre universel.

Le paramètre universel

Le paramètre universel — un très mauvais nom, selon moi — invoqué au moyen de la commande C-u +nombre +command permet essentiellement deux choses :

• facilement passer un argument numérique à une commande. Et le traitement de ce nombre dépend de la commande (sigh). Très souvent, cela répète la commande n fois (si le nombre passé est n)
• faire alterner le comportement d'une commande (l'altération dépendandra, elle aussi, de la commande)

Comme il semblerait que ce soit généralement les commandes qui décident de ce qu'elle font d'un argument numérique, ce paramètre peut sembler compliqué à utiliser efficacement. Par exemple, utilisé avant C-y (pour coller) cela naviguera dans l'historique du presse-papier.

Répéter un caractère

Cependant, couplé avec un caractère : C-u +nombre +caractère va insérer n fois le caractère. Par exemple: C-u 12 f produira ce résultat : ffffffffffff.

Occur

J'étais largement plus familier à la commande occur (M-x occur ou M-s o), qui permet de chercher un motif et énumérer les lignes capturées par le motif, de manière interactive (rendant possible depuis l'énumération de sauter vers la location d'une ligne), dans un buffer *Occur*. En général, c'est au-dessus de cette commande que sont implantées les fonctions qui reposent sur de la recherche d'identifiants.

Comme il est possible de chercher des lignes qui capturent un motif (donc une expression régulière), on voudrait capturer une ligne contenant au moins 81 caractères arbitraires, ce qui pourrait s'écrire : .\{81,\}. Ça fonctionne parfaitement mais, c'est un peu laborieux à écrire.

Solution

Nous allons utiliser le paramètre universel, couplé avec occur pour énumérer toutes les lignes faisant plus de 80 caractères. Donc plutôt que d'utiliser une expression régulière compliquée, nous allons simplement générer 81 points :

• M-s o, on invoque occur
• C-u 81 . on rempli le motif avec 81 points
• [RET] on exécute la commande.

Et voila ! Expliqué de cette manière, ma solution semble parfaitement stupide, je vous l'accorde. Mais elle est, de mon point de vue, largement plus rapide à écrire que celle invoquant l'expression régulière et j'ai enfin, partiellement, utilisé le paramètre universel.

Alternative

Quand on a, enfin, compris comment utiliser le paramètre universelle, on peut aussi expérimenter une autre solution, elle aussi proposée sur la page Find Long Lines qui, plutôt que d'utiliser occur pour recenser les lignes trop longue, les surlignes :

• M-s h r qui invoque le surlignage de ligne
• C-u 81 . qui rempli le motif avec 81 points
• [RET] qui exécute la commande.

Personnellement, je préfère l'utilisation de occur, que je trouve plus agréable à utiliser, mais chacun ses préférences.

Pour conclure

C'était un tout petit article qui témoigne de l'immensité des progrès que je dois faire avec Emacs ! Mais c'est très amusant de voir comment les commandes s'enchainent et je me réjouis de découvrir d'autres petites astuces comme celle-là !