Aller au contenu

La version 0.1.0 est une première version, à l'essai. Voir ce qui n'est pas prouvé →

bogolang
EN

← Documentation

Bogolang dans VS Code

L'extension pour VS Code, et les deux commandes que tout éditeur peut utiliser.

Toutes les pages de documentation

Bogolang embarque une extension pour Visual Studio Code. C'est une petite extension : elle montre les erreurs d'un fichier .bogo pendant qu'il est écrit, colore le fichier, le met en forme et l'exécute.

Elle a besoin d'un Bogolang installé. L'extension ne fait aucune vérification par elle-même : elle lance la commande bogo du PC.

L'installer dans VS Code

bogo vscode

Un Bogolang installé porte le fichier de l'extension dans son dossier editors. bogo vscode le remet à VS Code. S'il n'y a pas de VS Code sur le PC, la commande le dit, et nomme le fichier pour qu'il puisse être installé à la main : dans VS Code, « Extensions: Install from VSIX ».

Ce qu'elle apporte

Elle apporte Comment
Couleurs Les couleurs Python de VS Code, plus les littéraux Bogolang (192.0.2.1, 198.51.100.0/24, 20Mbps, 50ms) et les nouvelles instructions (change on, wait until, retry, every, watch, alert when, on syslog)
Les erreurs soulignées La même vérification que bogo run, avec le même texte d'aide quand la souris est sur l'erreur
Mise en forme « Format Document » exécute bogo fmt sur le texte
Exécution Deux commandes dans la palette de commandes : « Bogolang: Run this file » et « Bogolang: Run this file on saved answers »
Morceaux de départ Tapez program, test ou change et choisissez le morceau

La vérification s'exécute quand un fichier est ouvert, quand il est enregistré, et une seconde après la dernière touche. Une vérification prend une à deux secondes, donc une erreur apparaît deux à trois secondes après l'arrêt de la saisie. La toute première vérification sur un PC prend plus longtemps.

« Run this file on saved answers » utilise le dossier saved à côté du fichier, ou le dossier replay. Sans l'un ni l'autre, elle demande le dossier. Elle exécute bogo run --replay FOLDER FILE, donc rien n'est contacté.

Réglages

Réglage Signification
bogolang.command La commande bogo. Donnez un chemin complet quand bogo n'est pas dans le PATH. Par défaut bogo
bogolang.checkDelay Millisecondes à attendre après la dernière touche avant la vérification. Par défaut 1000

Limites

  • Ce n'est pas un serveur de langage. Elle ne complète pas les noms et n'affiche pas de type sous la souris.
  • Dans un dossier auquel VS Code ne fait pas confiance (« Restricted Mode »), l'extension reste éteinte : elle lancerait une commande sur les fichiers de ce dossier.
  • Un littéral à l'intérieur des {} d'une f-string n'est pas coloré. Bogolang ne lit pas non plus de littéral à cet endroit.
  • « Run this file » ferme le terminal nommé Bogolang d'une exécution précédente et en ouvre un nouveau. Un programme qui y tourne encore, comme un écouteur, est arrêté.

Pour un autre éditeur

Les deux commandes qu'utilise l'extension fonctionnent pour n'importe quel éditeur :

bogo check --json --stdin FILE
bogo fmt --stdin FILE
  • bogo check --json affiche chaque erreur sous forme d'une ligne de JSON et rien d'autre : file, line, col, end_col, level, message, hint. Les lignes et les colonnes commencent à 1 ; end_col est le dernier caractère de l'erreur. Le code de sortie vaut 0 sans erreur, 1 avec des erreurs, 2 quand la vérification n'a pas pu s'exécuter.
  • --stdin FILE vérifie le texte donné sur l'entrée standard comme s'il était le contenu de FILE. Le fichier sur le disque n'est pas lu et n'est jamais écrit. Les autres fichiers du dossier sont lus comme d'habitude.
  • bogo fmt --stdin FILE affiche le texte mis en forme. Sur un texte qu'il ne peut pas lire, il n'affiche rien, dit pourquoi sur la sortie d'erreur et se termine avec le code 1.