Tiramisu Docs

Tooling

Formatage

Formatez automatiquement vos fichiers .tiramisu avec la commande tiramisu format pour un style cohérent.

La commande tiramisu format formate automatiquement les fichiers .tiramisu pour un style cohérent. Elle normalise les espaces, l'indentation et l'espacement des paramètres.

Utilisation

bash 
tiramisu format [options] [files...]

Options

DrapeauDéfautDescription
--check—Vérifie si les fichiers sont formatés sans les modifier. Quitte avec le code 1 si un fichier nécessite un formatage.
--indent <n>2Nombre d'espaces par niveau d'indentation.
--line-width <n>80Largeur maximale de ligne avant de découper les appels de fonctions en format multi-lignes.

Formater les fichiers sur place

Passez un ou plusieurs chemins de fichiers pour les formater sur place :

bash 
tiramisu format src/docs/**/*.tiramisu

Les fichiers déjà correctement formatés sont ignorés (pas d'écritures inutiles).

Stdin / Stdout

Lorsqu'aucun fichier n'est fourni et que l'entrée est envoyée par pipe, le formateur lit depuis stdin et écrit sur stdout :

bash 
echo 'bold{hello}' | tiramisu format
# Output: bold { hello }

Ceci est utile pour les intégrations d'éditeurs et le scripting.

Mode vérification

Utilisez --check en CI pour vérifier le formatage sans modifier les fichiers :

bash 
tiramisu format --check src/docs/**/*.tiramisu

Si des fichiers nécessitent un formatage, la commande les liste et quitte avec le code 1.

Ce que fait le formateur

Le formateur applique les règles suivantes :

  • Espaces en fin de ligne — supprimés de toutes les lignes.
  • Saut de ligne final — assure un unique saut de ligne final.
  • Espacement des paragraphes — réduit 3+ lignes vides à 2.
  • Fonctions en ligne — normalise l'espacement des accolades : bold{hello} → bold { hello }.
  • Fonctions multi-lignes — découpe les appels de fonctions longs sur plusieurs lignes lorsqu'ils dépassent la largeur de ligne.
  • Paramètres — normalise l'espacement autour de = : level=1 → level = 1.
  • Tableaux — formate en ligne ou multi-lignes selon la largeur de ligne.
  • Guillemets de chaînes — utilise le style de guillemets valide le plus court.

Exemples

Avant le formatage :

tiramisu 
callout{type=warning,Don't forget to install the peer dependencies.}

h2{Quick  Start}

list{First item,Second item,Third item}

Après exécution de tiramisu format :

tiramisu 
callout { type = warning, Don't forget to install the peer dependencies. }

h2 { Quick Start }

list {
  First item,
  Second item,
  Third item
}

Le formateur est idempotent — l'exécuter plusieurs fois produit un résultat identique.