Support éditeur
L'extension StewBeet pour VSCode est le support éditeur de tout l'écosystème beet : beet, bolt, mecha et StewBeet.
Les fichiers .bolt obtiennent leur propre langage, et les chaînes mcfunction dans votre Python obtiennent coloration, complétion, erreurs et liens vers le datapack construit.
Installation : cherchez StewBeet dans le panneau Extensions, ou ouvrez-la sur le marketplace.
Besoin de votre venv : non. Elle lit vos sources et les fichiers que votre build écrit, rien d'autre.
Code source : extension/vscode
| Vous écrivez | Vous obtenez |
|---|---|
Des modules .bolt | Le langage Bolt : coloration, complétion et ctrl+clic sur les commandes, et un lens par fonction que le module écrit |
Du bolt dans un .mcfunction | La même chose, et Spyglass retiré d'un fichier qu'il ne sait pas lire |
Du beet simple, ctx.data.functions[p] = Function(...) | Les commandes dedans sont des commandes : colorées, complétées, vérifiées, et liées à ce que le build a écrit |
| mecha | La navigation de chaque ligne générée vers la ligne source dont elle vient |
Les helpers write_* de StewBeet | Tout ce qui précède, plus chaque chemin {...} résolu vers ce qu'il est vraiment |
Mise en place
- Installez Spyglass. Il fournit la complétion, le survol et les erreurs que l'extension redirige dans vos blocs.
- Pour la navigation vers le build, ajoutez le plugin source_maps à votre
beet.yml:
require:
- "stewbeet"
- "stewbeet.plugins.source_maps" # écrit les fichiers .mcfunction.map avec lesquels l'éditeur navigueC'est toute la configuration. L'extension fonctionne sans l'étape 2, moins les liens entre votre Python et le pack construit.
Bolt
Les fichiers .bolt s'ouvrent en Bolt, avec une grammaire générée depuis l'arbre de commandes de mecha : item = 3 est du Python, item modify entity @s ... est une commande.
- Complétion, erreurs et ctrl+clic sur les commandes, via Spyglass. Les expressions Python sont masquées.
- Un lens par fonction que le module écrit, menant au fichier généré.
- Les chemins calculés restent cliquables :
function gui.openrésout vers ce que le dernier build a écrit.
Un .mcfunction contenant du bolt reçoit aussi l'id de langage bolt. Spyglass continue de l'indexer, donc les fonctions qu'il définit restent connues des fichiers qui les appellent, et les erreurs que Spyglass signale sur ses lignes bolt sont retirées.
Voir Approche 4 : Bolt pour le langage lui-même.
beet
Les plugins qui utilisent l'API de beet n'ont besoin de rien d'autre que stewbeet.plugins.source_maps :
- Les erreurs à la frappe, sans build. Les erreurs de build sont reportées sur le Python qui a écrit la commande.
- La navigation dans les deux sens : aller à la définition atterrit sur l'appel qui a écrit une fonction, chercher les références liste chaque écrivain, et un lens au-dessus de chaque bloc ouvre ce qu'il a généré.
StewBeet
write_function(f"{ns}:machines/tick", f"""
execute unless score @s energy.storage >= @s {ns}.energy_rate run return fail
execute if entity @s[tag={ns}.turbine] run function {ns}:turbine/tick
""")Chaque {...} est rempli avec ce que le dernier build y a résolu, donc ctrl+clic et complétion fonctionnent sur les chemins calculés.
Un nom résolu sur une ligne est réutilisé là où le build ne couvre rien, par exemple des commandes rassemblées dans une liste.
Rien n'évalue votre Python, et ce qui reste inconnu garde un masque _.
Ce qui compte comme un bloc
| Écrit comme | Exemple |
|---|---|
Les helpers write_* | write_function, write_versioned_function, write_load_file, ... |
| Une variable | Une f-string triple assignée à un nom, chaque += jusqu'à l'appel qui la consomme, et un littéral que l'appel lui ajoute |
| Une liste | .append, += [...], littéraux, compréhensions, "\n".join(lines) |
| Votre propre fonction | Tout paramètre annoté McFunction |
| L'API de beet | Function(...) depuis une chaîne ou une list[str], plus .append, .prepend et .lines |
Colorer une variable demande l'annotation McFunction (un simple alias de str fourni par stewbeet). Tout le reste fonctionne sans.
Commandes
Depuis la palette : Go to Generated Function, Go to Python Source, Reload Source Maps, Refresh Build Diagnostics, Show Diagnostics Status, Install Spyglass Language Server.
Paramètres
Tous sous StewBeet.* :
| Paramètre | Défaut | |
|---|---|---|
languageFeatures | true | Complétion, survol, aide à la signature et aller à la définition dans les blocs |
suggestSpyglass | true | Propose l'installation de Spyglass une fois, s'il manque |
buildOutput | "" | Où se trouve le pack généré, en absolu ou relatif au workspace. Vide cherche dans le workspace |
sourceMapDiagnostics | true | Reporte les erreurs de build sur le Python qui a écrit la commande |
resolveInterpolations | true | Remplit chaque {...} avec ce que le dernier build y a résolu |
diagnosticRuleDenylist | ["undeclaredSymbol"] | Règles jamais reportées sur le Python |
codeLens | true | Le lien au-dessus d'un bloc ayant produit une fonction |
headerLinks | true | Les resource locations dans l'en-tête #> d'un fichier généré |
boltInMcfunction | true | Donne l'id de langage bolt à un .mcfunction contenant du bolt |
enableBlockDecorations | true | Le cadre coloré autour d'un bloc |
backgroundColor | rgba(80,40,0,0.15) | N'importe quelle couleur CSS |
borderColor | rgba(200,120,30,0.30) | N'importe quelle couleur CSS |
borderWidth | "2px" |
En venant d'Aegis
Comparée à Aegis, StewBeet est plus légère et plus simple à installer, mais elle ne fournit pas encore les symboles Python dans la complétion.
| Aegis | StewBeet | |
|---|---|---|
Coloration .bolt | Aucune, lu comme du mcfunction | Grammaire Bolt |
| Commandes dans les chaînes Python | Non | Oui |
| Navigation source vers build | Non | Dans les deux sens |
| Requiert | ms-python.python et votre environnement | Rien |
Complétion .bolt | Compilateur complet, symboles Python inclus | Commandes seulement, via Spyglass |
Gardez Aegis si vous avez besoin de cette dernière ligne.
Prochaines étapes
- Écrire fonctions et fichiers : tout ce que l'extension lit, Bolt compris.
- stewbeet.plugins.source_maps : les source maps derrière la navigation.