joppa.toml

joppa.toml décrit, à la racine d’un projet, les processus que Joppa lance. Commitez-le : vos collègues retrouvent la même configuration dès qu’ils ajoutent le projet. Quand il existe, c’est lui qui fait foi sur la configuration locale.

Joppa l’écrit pour vous quand vous cochez Écrire joppa.toml dans le dépôt pour l’équipe dans l’analyse des processus. Vous pouvez aussi l’écrire à la main.

Exemple

[[procs]]
name = "postgres"
kind = "compose"
service = "db"

[[procs]]
name = "api"
kind = "script"
dir = "apps/api"
command = "bun run dev"
port = 8000
dependsOn = ["postgres"]

[procs.env]
PORT = "8000"

[[procs]]
name = "web"
kind = "script"
dir = "apps/web"
command = "bun run dev"
port = 5173
dependsOn = ["api"]

[[procs]]
name = "worker"
kind = "script"
command = "bun run queue"
enabled = false

Les champs

Chaque [[procs]] est un processus.

Champ	Type	Rôle
name	texte	Nom unique dans le projet : web, api, postgres
kind	"script" ou "compose"	Une commande, ou un service du Docker Compose du projet
port	nombre	Le port sur lequel il répond une fois prêt. Absent pour une tâche de fond
dependsOn	liste	Processus démarrés (et prêts) avant celui-ci
enabled	booléen	Lancé par « Tout démarrer » (true par défaut). À false, il se lance seul

kind = "script"

Champ	Rôle
command	La commande, lancée dans un shell
dir	Le dossier, relatif à la racine du projet (vide : la racine)
env	Variables d’environnement ajoutées ([procs.env])

kind = "compose"

Champ	Rôle
service	Le nom du service dans le fichier Docker Compose

Ce qui n’y est pas

Lancer à l’ouverture de Joppa et Relancer après un plantage sont des préférences de chaque machine : elles restent dans Joppa et ne sont jamais écrites dans joppa.toml.