Vérifier vos fautes dans Neovim
Quand j'écris du LaTeX, du Markdown ou du Python j'utilise Neovim. Neovim est un logiciel ayant refactoré le code de Vim pour être plus accessible et plus extensible (tout en restant compatible avec la plupart des plug-ins de Vim). Basiquement, Neovim peut être vu comme une version améliorée de Vim. Allez sur la page officielle du projet pour plus de détails. Après avoir écrit votre texte ou documentation, les correcteurs automatiques sont utiles pour vous faire gagner du temps de relecture. Dans cet article de blogue, je vous partage ma configuration Neovim pour faire cette relecture automatique.
Correction d'orthographe#
Pour avoir une vérification orthographique dans neovim, vous avez à ajouter dans le fichier ~/.config/nvim/init.vim les lignes suivantes:
" spell languages
set spelllang=fr
nnoremap <silent> <C-s> :set spell!<cr>
inoremap <silent> <C-s> <C-O>:set spell!<cr>
Utilisation#
Une fois dans Neovim, appuyer sur Ctrl+S pour mettre en évidence les mots mal orthographiés.
Il vous suffit de rappuyer sur Ctrl+S pour désactiver cette fonctionnalité.
Pour avoir accès à une suggestion de mots, il vous faut appuyer Ctrl+X puis S lorsque vous êtes en mode insertion.
En mode normal, taper z= lorsque le curseur est sur un mot surligné pour afficher la suggestion de mots
Note
Je sais que ma configuration inhibe le signal utilisateur Ctrl+S et c'est justement mon objectif, car je veux éviter toute interruption lorsque je suis dans Neovim.
Correction de grammaire#
Pour faire une première relecture, j'utilise la suite LanguageTool. Elle est disponible gratuitement en version hors-ligne et en ligne. Le code de l'outil de correction hors-ligne est ouvert (c'est la raison principale de mon utilisation). Dans cet article, je vais vous aider à l'installer et vous aider à l'utiliser avec Neovim.
Installation de LanguageTool#
LanguageTool nécessite un environnement Java pour fonctionner. Ici je choisis OpenJDK comme environnement Java. Puis j'installe curl pour télécharger LanguageTool.
Pour Fedora#
sudo dnf -y install java curl
Pour Ubuntu#
sudo apt -y install default-jre curl
Ensuite, sur les deux distributions#
Les commandes qui suivent téléchargent LanguageTool et l'installe dans /usr/local:
curl https://languagetool.org/download/LanguageTool-stable.zip > /tmp/LanguageTool-stable.zip
sudo unzip /tmp/LanguageTool-stable.zip -d /usr/local/LanguageTool
sudo mv /usr/local/LanguageTool/LanguageTool-*/* /usr/local/LanguageTool/
rm /tmp/LanguageTool-stable.zip
Configuration de Neovim#
J'utilise le manager de plug-in vim-plug pour Neovim. C'est pourquoi je vais utiliser ce manager pour installer le plug-in de vigoux (l'utilisation d'autre manager est possible). Avant de continuer, je vous recommande d'utiliser une version récente de Neovim (≥ 0.4.2) pour utiliser ce plug-in (puisqu'il utilise des changements récents faits dans Neovim).
Dans votre ~/.config/nvim/init.vim entre l'appel call plug#begin(<plugging_folderpath>) et l'appel call plug#end() vous devez rajouter les lignes suivantes:
" Language tool integration
Plug 'vigoux/LanguageTool.nvim'
Ensuite, en dehors des appels à vim-plug vous devez ajouter les lignes suivantes:
" grammar checking
autocmd Filetype markdown LanguageToolSetUp
autocmd Filetype tex LanguageToolSetUp
let g:languagetool_server_jar='/usr/local/LanguageTool/languagetool-server.jar'
Utilisation#
Pour utiliser ce plug-in, vous devez faire un appel à lui dans vos documents en mode normal grâce à la commande :LanguageToolSetUp (cette commande est lancée automatiquement pour les fichiers tex et markdown).
Ensuite, le plug-in propose les commandes suivantes:
:LanguageToolCheck: pour surligner les erreurs détectées, vous devez réutiliser cette commande lorsque vous changer votre code/texte.:LanguageToolSummary: pour afficher des détails sur les mots surlignés dans une sous-fenêtre.:LanguageToolClear: pour enlever les affichages de LanguageTool.
Pour plus d'options allez sur la page du plug-in.
Note
J’ai souvent alterné entre l’utilisation de LanguageTool et Antidote. Finalement, j’ai choisi LanguageTool car il s’intègre parfaitement à mon environnement de développement et à mes workflows.
J’espère que cela aidera certains d’entre vous. Si vous avez une meilleure configuration ou voulez améliorer la mienne, n'hésitez pas à contribuer.
À bientôt, Vincent.