Intégrer Biome à une extension pour un éditeur

Biome prend nativement en charge LSP. Si votre éditeur implémente LSP, alors l’intégration de Biome devrait être sans accroc.

Utiliser le proxy LSP

Section titled Utiliser le proxy LSP

Biome a une commande appelée lsp-proxy. Lors de son exécution, Biome générera deux processus :

• un daemon qui exécute les opérations demandées,
• un serveur qui fonctionne comme un proxy entre les requêtes du client – l’éditeur – et le serveur – le daemon.

Si votre éditeur est capable d’interagir avec un serveur et d’envoyer des requêtes en JSON-RPC, vous n’avez besoin que de configurer l’éditeur pour qu’il exécute cette commande.

Vous pouvez regarder la manière dont l’extension neo-vim biome le fait.

Utiliser stdin

Section titled Utiliser stdin

Si votre éditeur ne prend pas en charge LSP, vous utilisez directement le binaire biome et l’appelez en utilisant l’entrée standard.

Les commandes suivantes peuvent être appelées via l’entrée standard :

• format,
• lint,
• check.

Biome renverra la nouvelle sortie (ou la sortie d’origine s’il n’y a eu aucune modification) vers la sortie standard et les diagnostics vers l’erreur standard.

Quand vous utilisez stdin, vous devez passer l’option --stdin-file-path. Le fichier path n’a pas besoin d’exister dans votre système de fichiers et peut avoir n’importe quel nom. L’important est de fournir la bonne extension de fichier pour que Biome sache comment traiter votre fichier.

Il est de la responsabilité de l’éditeur de localiser la résolution du chemin du binaire et de l’appeler ensuite si besoin. Les binaires sont envoyés à npm sur la base des architectures et systèmes d’exploitation que nous prenons en charge :

• @biomejs/cli-darwin-arm64,
• @biomejs/cli-darwin-x64,
• @biomejs/cli-linux-arm64,
• @biomejs/cli-linux-x64,
• @biomejs/cli-win32-arm64,
• @biomejs/cli-win32-x64.

Le nom du binaire est biome ou biome.exe et il peut être trouvé dans le répertoire racine de la librairie ; par exemple, @biomejs/cli-darwin-arm64/biome, @biomejs/cli-win32-x64/biome.exe.

Utiliser le daemon avec le binaire

Section titled Utiliser le daemon avec le binaire

L’utilisation du binaire via la ligne de commande est très efficace, bien que vous ne puissiez pas fournir de logs à vos utilisateurs. L’interface en ligne de commande vous permet de monter un daemon et d’utiliser la ligne de commande par l’intermédiaire du daemon lui-même.

Pour ce faire, vous devez d’abord démarrer un processus daemon avec la commande start :

biome start

Puis, chaque commande a besoin d’ajouter les options --use-server ; par exemple :

echo "console.log('')" | biome format --use-server --stdin-file-path=dummy.js

Note

Si vous décidez d’utiliser le daemon, vous avez également la responsabilité de redémarrer/tuer le processus avec la commande stop pour éviter des processus fantômes.

Attention

Les opérations via le daemon sont considérablement plus lentes que la ligne de commande elle-même, il est donc conseillé de n’exécuter les opérations que sur un fichier à la fois.

Logs daemon

Section titled Logs daemon

Le daemon de Biome enregistre les logs dans votre système de fichiers. Les logs sont stockés dans un dossier appelé biome-logs. Le chemin vers ce dossier varie selon votre système d’exploitation :

• Linux : ~/.cache/biome,
• Windows : C:\Users\<nom d’utilisateur>\AppData\Local\biomejs\biome\cache,
• macOS : /Users/<nom d’utilisateur>/Library/Caches/dev.biomejs.biome.

Pour d’autres systèmes d’exploitation, vous pouvez trouver le dossier dans le répertoire temporaire du système.

Pour obtenir le chemin exact, exécutez la commande suivante :

biome explain daemon-logs

Les fichiers de log sont mis à jour toutes les heures.