Tiramisu Docs

Tooling

Formatierung

Formatieren Sie .tiramisu-Dateien automatisch mit dem Befehl tiramisu format für einheitlichen Stil.

Der Befehl tiramisu format formatiert .tiramisu-Dateien automatisch für einen einheitlichen Stil. Er normalisiert Leerzeichen, Einrückungen und Abstände bei Parametern.

Verwendung

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

Optionen

FlagStandardBeschreibung
--check—Prüft, ob Dateien formatiert sind, ohne sie zu ändern. Beendet mit Code 1, wenn eine Datei formatiert werden muss.
--indent <n>2Anzahl der Leerzeichen pro Einrückungsebene.
--line-width <n>80Maximale Zeilenbreite, bevor Funktionsaufrufe in ein mehrzeiliges Format umgebrochen werden.

Dateien direkt formatieren

Übergeben Sie einen oder mehrere Dateipfade, um sie direkt zu formatieren:

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

Bereits korrekt formatierte Dateien werden übersprungen (keine unnötigen Schreibvorgänge).

Stdin / Stdout

Wenn keine Dateien angegeben werden und die Eingabe über eine Pipe kommt, liest der Formatierer von stdin und schreibt nach stdout:

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

Dies ist nützlich für Editor-Integrationen und Skripte.

Prüfmodus

Verwenden Sie --check in CI, um die Formatierung zu überprüfen, ohne Dateien zu ändern:

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

Wenn Dateien formatiert werden müssen, listet der Befehl sie auf und beendet sich mit Code 1.

Was er macht

Der Formatierer wendet folgende Regeln an:

  • Nachgestellte Leerzeichen — werden aus allen Zeilen entfernt.
  • Abschließender Zeilenumbruch — stellt einen einzelnen abschließenden Zeilenumbruch sicher.
  • Absatzabstände — reduziert 3+ Leerzeilen auf 2.
  • Inline-Funktionen — normalisiert Klammerabstände: bold{hello} → bold { hello }.
  • Mehrzeilige Funktionen — bricht lange Funktionsaufrufe über mehrere Zeilen um, wenn sie die Zeilenbreite überschreiten.
  • Parameter — normalisiert Abstände um =: level=1 → level = 1.
  • Arrays — formatiert inline oder mehrzeilig basierend auf der Zeilenbreite.
  • Anführungszeichen — verwendet den kürzesten gültigen Anführungsstil.

Beispiele

Vor der Formatierung:

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

h2{Quick  Start}

list{First item,Second item,Third item}

Nach Ausführung von tiramisu format:

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

h2 { Quick Start }

list {
  First item,
  Second item,
  Third item
}

Der Formatierer ist idempotent — mehrfaches Ausführen erzeugt identische Ergebnisse.