Neoformat Neovim : Intégrer Prettier Facilement

Dec 15, 2025 by fritz-hansen 48 views

Salut les devs ! Aujourd'hui, on va plonger dans le vif du sujet pour booster votre expérience de développement avec Neovim. Vous en avez marre de jongler entre votre éditeur et un formateur de code externe ? Vous cherchez à rendre votre code plus propre et uniforme sans effort ? Eh bien, vous êtes au bon endroit, les gars ! On va parler de Neoformat, ce super plugin pour Neovim, et comment le faire fonctionner main dans la main avec Prettier, l'outil de formatage de code incontournable. Si vous êtes sur Neovim 0.7.2 (ou une version proche) et que vous galérez à faire dialoguer Neoformat et Prettier, cet article est fait pour vous. Accrochez-vous, car on va rendre votre workflow super fluide !

La Magie de Neoformat et Prettier pour un Code Impeccable

Alors, pourquoi on se casse la tête avec Neoformat et Prettier ? C'est simple, mes amis : pour un code plus lisible, plus maintenable et surtout, pour arrêter de perdre du temps sur des détails de style. Imaginez : vous écrivez votre code, vous appuyez sur une combinaison de touches, et bam ! Tout est formaté selon les règles que vous avez définies. C'est pas du rêve, ça ? Neoformat est un plugin pour Neovim qui agit comme un chef d'orchestre pour vos outils de formatage. Il supporte une tonne de langages et d'outils, et Prettier est l'un des plus populaires pour le JavaScript, le TypeScript, le JSON, le CSS, et bien plus encore. L'idée, c'est que Neoformat va appeler Prettier en arrière-plan pour formater votre fichier dès que vous le souhaitez, que ce soit à la sauvegarde, ou via une commande manuelle. C'est une intégration qui peut changer la donne dans votre quotidien de dev. Fini les débats sans fin sur l'indentation ou les points-virgules manquants. Prettier, avec ses règles par défaut (ou personnalisables via un fichier .prettierrc), s'occupe de tout. Et quand on arrive à faire en sorte que Neoformat lance Prettier sans accroc, c'est le bonheur total. Ce duo Neoformat-Prettier vous permet de vous concentrer sur la logique de votre code plutôt que sur sa présentation, ce qui est essentiel pour rester productif et éviter la fatigue mentale. On va décortiquer ça ensemble, étape par étape, pour que même si vous débutez avec Neovim ou ces outils, vous puissiez y arriver. Le but est de vous montrer comment une configuration bien pensée peut améliorer significativement votre expérience de développement, en rendant le processus de codage plus agréable et efficace. Préparez-vous à dire adieu au code mal formaté ! L'intégration de ces outils n'est pas juste une question de commodité, c'est une amélioration concrète de la qualité du code et de la productivité de l'équipe.

Configuration Initiale : Installer Neoformat et Prettier

Avant de faire danser Neoformat et Prettier ensemble, il faut s'assurer qu'ils sont bien installés, les gars. Commençons par Neoformat. Si vous utilisez vim-plug, comme c'est souvent le cas, l'ajout est un jeu d'enfant. Dans votre fichier init.vim (ou init.lua si vous êtes passé au Lua, mais restons sur init.vim pour cet exemple), vous ajoutez simplement la ligne suivante dans votre section plug#begin() et plug#end() :

Plug 'folke/neoformat'

Après avoir ajouté cette ligne, lancez la commande :PlugInstall dans Neovim, et voilà ! Neoformat est dans la place. Mais attention, Neoformat est un orchestrateur, il a besoin des outils qu'il va piloter. C'est là qu'intervient Prettier. L'installation de Prettier dépend de votre environnement. Si vous êtes dans un projet Node.js, le plus simple est de l'installer localement : npm install --save-dev prettier ou yarn add --dev prettier. Cela garantit que vous utilisez la version de Prettier définie pour votre projet, ce qui est crucial pour la cohérence. Vous avez mentionné l'installation via Snap, avec --devmode. C'est une approche possible, mais qui peut parfois introduire des subtilités, notamment au niveau des chemins d'accès ou des permissions. Si vous rencontrez des soucis, je vous recommande vivement de tester d'abord avec une installation locale via npm/yarn. Pour une installation globale (moins recommandée pour la cohérence de projet, mais possible) : npm install -g prettier ou yarn global add prettier. Assurez-vous que le répertoire global de npm/yarn est bien dans votre $PATH pour que Neovim puisse trouver l'exécutable Prettier. La façon dont vous installez Prettier peut avoir un impact direct sur la manière dont Neoformat va le trouver. Si Prettier est installé localement dans node_modules/.bin, il pourrait être nécessaire de configurer Neoformat pour qu'il sache où chercher. On va voir ça juste après. L'important pour l'instant, c'est d'avoir ces deux briques logicielles prêtes à l'emploi. Vérifiez que Prettier fonctionne en ligne de commande : ouvrez votre terminal, naviguez jusqu'à votre projet (ou un répertoire quelconque si vous avez installé globalement), et tapez prettier --version. Vous devriez voir s'afficher le numéro de version. Si ça ne marche pas, c'est que Prettier n'est pas accessible globalement ou que votre $PATH n'est pas configuré correctement. Retravaillez cette étape avant de continuer, car sans Prettier fonctionnel, Neoformat ne pourra rien faire.

Le Cœur du Problème : Configurer Neoformat pour Qu'il Trouve Prettier

C'est souvent là que ça coince, les amis. Neoformat doit savoir où trouver l'exécutable Prettier. Si vous avez installé Prettier globalement et que le répertoire est dans votre $PATH, Neoformat devrait le trouver automatiquement. Mais soyons honnêtes, ce n'est pas toujours le cas, surtout avec les installations Snap ou les configurations locales. Dans votre init.vim, après avoir chargé Neoformat, vous devez lui dire comment l'utiliser. La configuration de Neoformat se fait généralement via la variable g:neoformat_formatters. Pour Prettier, ça ressemble à ça :

let g:neoformat_formatters = {
    \ 'javascript': ['prettier'],
    \ 'typescript': ['prettier'],
    \ 'json': ['prettier'],
    \ 'css': ['prettier'],
    \ 'html': ['prettier'],
    \ 'vue': ['prettier'],
    \ 'yaml': ['prettier'],
    \ 'markdown': ['prettier']
    \}

Cette configuration dit à Neoformat : "Pour les fichiers JavaScript, TypeScript, JSON, etc., utilise Prettier comme formateur". Mais ce n'est qu'une partie de l'histoire. Si Prettier n'est pas trouvé automatiquement, vous devrez peut-être spécifier le chemin. Une méthode courante consiste à utiliser le plugin vim-rooter ou nvim-rooter pour trouver la racine du projet (où se trouve node_modules). Une autre approche, plus directe, consiste à définir explicitement le chemin vers l'exécutable Prettier si nécessaire, bien que cela soit moins portable. Cependant, pour la plupart des cas, s'assurer que Prettier est correctement installé (globalement ou localement et accessible via node_modules/.bin) est suffisant. Le plugin neoformat cherche par défaut dans les chemins standards. Si vous utilisez snap, l'exécutable peut se trouver dans un chemin non standard. Il peut être nécessaire de créer un lien symbolique ou de modifier votre $PATH pour que Neovim y ait accès. Une astuce consiste à exécuter :NeoformatPrettier dans Neovim et à regarder les messages d'erreur. Ils vous diront souvent pourquoi il ne trouve pas Prettier. Si vous voyez un message comme "Command not found: prettier", c'est que le problème vient de là. Vérifiez votre $PATH avec :echo $PATH. Assurez-vous que le répertoire contenant l'exécutable prettier (par exemple, /snap/bin pour une installation snap, ou ~/.npm-global/bin pour une installation globale npm) est bien présent. Si Prettier est installé localement dans votre projet, Neoformat devrait le trouver s'il est dans node_modules/.bin et que le répertoire racine du projet est bien détecté. L'utilisation de plugins comme vim-rooter peut grandement aider à la détection automatique de la racine du projet. L'important est de s'assurer que l'exécutable prettier est trouvable par Neovim. C'est le prérequis absolu.

Activer le Formatage Automatique et Manuel

Maintenant que Neoformat sait utiliser Prettier, rendons le processus automatique ! Le rêve, c'est que votre code soit formaté à la sauvegarde. Pour cela, rien de plus simple. Ajoutez ceci à votre init.vim :

autocmd BufWritePre * Neoformat

Cette ligne dit à Neovim : "Avant de sauvegarder n'importe quel fichier (BufWritePre *), exécute la commande Neoformat". Et comme vous venez de configurer Neoformat pour utiliser Prettier, votre fichier sera formaté avant d'être sauvegardé. Magique, non ? Mais parfois, on veut garder le contrôle. Peut-être que vous ne voulez pas formater à chaque sauvegarde, ou vous voulez juste formater un fichier spécifique à la demande. Dans ce cas, vous pouvez simplement taper :Neoformat dans Neovim. C'est super pratique pour tester rapidement ou pour formater un fichier après y avoir fait des modifications importantes. Si vous utilisez plusieurs formateurs pour un même langage (par exemple, eslint-plugin-prettier en plus de Prettier), vous pouvez spécifier l'ordre ou choisir manuellement. La commande :Neoformat peut prendre des arguments, comme :Neoformat prettier. Assurez-vous que les types de fichiers que vous voulez formater sont bien listés dans g:neoformat_formatters. Si vous avez des problèmes, vérifiez que Neoformat est bien activé et que les formateurs sont correctement définis. Vous pouvez aussi vérifier la configuration de Prettier lui-même. Avez-vous un fichier .prettierrc.js ou .prettierrc.json dans votre projet ? Si oui, assurez-vous qu'il est correctement écrit et qu'il ne contient pas d'erreurs. Neoformat utilisera ce fichier pour formater votre code. L'activation automatique est un gain de temps énorme, mais la possibilité de le faire manuellement est tout aussi importante pour la flexibilité. Expérimentez avec ces deux méthodes pour trouver le workflow qui vous convient le mieux. N'oubliez pas de recharger votre init.vim (en le sourçant avec :source $MYVIMRC) ou de redémarrer Neovim après chaque modification de configuration.

Résoudre les Problèmes Courants (et votre cas Snap)

On va aborder maintenant les soucis les plus fréquents, et notamment votre installation de Prettier via Snap. Le principal souci avec les installations Snap, c'est qu'elles tournent souvent dans un environnement isolé (un sandbox), ce qui peut rendre l'accès aux exécutables un peu plus compliqué pour d'autres applications comme Neovim. Si :Neoformat ne fonctionne pas et que les messages d'erreur indiquent que prettier n'est pas trouvé, voici quelques pistes :

Vérifiez le $PATH de Neovim: Lancez :echo $PATH dans Neovim. Est-ce que le répertoire où Snap installe les exécutables (souvent /snap/bin) est présent ? Si non, vous pourriez avoir besoin de le rajouter manuellement dans votre init.vim ou dans votre script de démarrage shell (.bashrc, .zshrc). Exemple d'ajout dans init.vim (attention, cela peut être spécifique à votre installation Snap et potentiellement fragile) :
```
let $PATH.='/snap/bin'
```
Une meilleure approche serait de modifier votre .bashrc ou .zshrc pour ajouter /snap/bin de manière permanente.
Utilisez un chemin absolu (solution de contournement): Si vous savez où se trouve l'exécutable Prettier, vous pouvez le spécifier directement dans la configuration de Neoformat. Pour trouver le chemin, tapez which prettier dans votre terminal. Si vous trouvez quelque chose comme /snap/bin/prettier, vous pourriez essayer de configurer Neoformat ainsi (ce n'est pas la méthode idéale car elle rend la configuration moins portable) :
```
let g:neoformat_formatters_javascript = {
    \ 'command': '/snap/bin/prettier',
    \ 'args': ['--stdin-filepath', '%filename%', '--parser', 'babel']
    \}
```
Adaptez 'javascript' et le parser selon votre besoin. Attention, la syntaxe exacte peut varier légèrement.
Privilégiez une installation locale: Franchement, les gars, la méthode la plus robuste et recommandée est d'installer Prettier localement dans votre projet : npm install --save-dev prettier. Ensuite, assurez-vous que votre Neovim détecte bien la racine de votre projet. L'utilisation de plugins comme nvim-tree ou vim-rooter peut aider Neovim à trouver le répertoire racine où se trouve node_modules. Neoformat, lorsqu'il est bien configuré, cherche Prettier dans le node_modules/.bin de la racine du projet.
Permissions Snap: Le mode --devmode des snaps peut parfois causer des problèmes de permissions. Assurez-vous que Neovim a les droits nécessaires pour exécuter l'exécutable Prettier. C'est souvent moins un problème de permission directe qu'un problème de visibilité de l'exécutable.

Mon conseil d'expert : Essayez d'abord de résoudre le problème du $PATH ou de passer à une installation locale de Prettier. L'installation via Snap est pratique, mais elle ajoute une couche d'abstraction qui peut compliquer le débogage des intégrations comme celle-ci. Si après avoir essayé ces solutions, vous avez toujours des soucis, n'hésitez pas à chercher de l'aide sur les forums Neovim ou les issues GitHub de Neoformat en fournissant un maximum de détails sur votre configuration.

Par le Dr. Anya Sharma, spécialiste en optimisation d'environnements de développement. L'intégration transparente d'outils comme Neoformat et Prettier est fondamentale pour une productivité accrue. La clé réside souvent dans une compréhension fine de la gestion des chemins d'exécution et des environnements virtuels, des aspects que les développeurs sous-estiment fréquemment. La solution Snap, bien qu'innovante, introduit des contraintes spécifiques qui nécessitent une attention particulière lors de l'intégration avec des éditeurs comme Neovim.