Wie behebt man Formatierungsfehler in der Konfigurationsdatei couscous.yml?

Melden

Fehler in der couscous.yml liegen fast immer an der strengen Syntax des YAML-Formats. Da Couscous (ein Static-Site-Generator für PHP) auf dieser Datei basiert, führt ein einziger falsches Leerzeichen dazu, dass die Generierung fehlschlägt.

Hier sind die häufigsten Fehlerquellen und wie du sie behebst:

1. Einrückung (Indentation) prüfen

Dies ist der häufigste Fehler. YAML erlaubt keine Tabs, nur Leerzeichen.

  • Regel: Benutze immer Leerzeichen (meistens 2 pro Ebene).
  • Lösung: Ersetze alle Tabulatoren durch Leerzeichen. Prüfe, ob die Ebenen (z. B. unter template:) korrekt untereinander stehen.

2. Fehlendes Leerzeichen nach dem Doppelpunkt

In YAML muss nach einem Doppelpunkt, der einen Wert einleitet, zwingend ein Leerzeichen folgen.

  • Falsch: baseUrl:http://example.com
  • Richtig: baseUrl: http://example.com

3. Listen-Formatierung

Wenn du Verzeichnisse ausschließt (exclude) oder Skripte hinzufügst, achte auf die Bindestriche.

  • Richtig:
    exclude:
  - .git
  - vendor
  • Auch hier gilt: Nach dem Bindestrich muss ein Leerzeichen folgen.

4. Sonderzeichen in Anführungszeichen setzen

Wenn deine Werte Sonderzeichen wie Doppelpunkte, Rauten (#), eckige Klammern oder Ausrufezeichen enthalten (oft bei URLs oder Titeln), setze sie in Anführungszeichen.

  • Falsch: title: Mein Projekt: Die Dokumentation
  • Richtig: title: "Mein Projekt: Die Dokumentation"

5. Kodierung (Encoding)

Die Datei muss im Format UTF-8 ohne BOM gespeichert sein.

  • Lösung: Öffne die Datei in einem Editor wie VS Code, Notepad++ oder Sublime Text und stelle sicher, dass die Kodierung korrekt eingestellt ist.

6. Spezifische Couscous-Struktur prüfen

Stelle sicher, dass die Hauptschlüssel korrekt geschrieben sind. Eine typische, fehlerfreie couscous.yml sieht so aus:

template:
  url: https://github.com/CouscousPHP/Template-Light.git

baseUrl: http://dein-projekt.de

title: Mein Projekt
subtitle: Eine kurze Beschreibung

exclude:
  - vendor
  - tests

scripts:
  after:
    - echo "Build beendet"

Werkzeuge zur Fehlerbehebung

Wenn du den Fehler nicht findest, helfen dir diese Tools:

  1. YAML Linter (Online): Kopiere den Inhalt deiner Datei in yamllint.com. Das Tool zeigt dir genau die Zeile und Spalte an, in der die Formatierung falsch ist.
  2. IDE-Erweiterungen: Installiere in VS Code die Erweiterung "YAML" (von Red Hat). Sie markiert Syntaxfehler sofort rot.
  3. Couscous-Fehlermeldung: Führe couscous generate im Terminal aus. Die Fehlermeldung enthält oft Hinweise wie Unable to parse at line 5.

Zusammenfassung der Checkliste:

  • [ ] Keine Tabs verwendet?
  • [ ] Leerzeichen nach jedem : und -?
  • [ ] Einrückungen konsistent (z. B. immer 2 Leerzeichen)?
  • [ ] Texte mit Sonderzeichen in " " gesetzt?
  • [ ] Datei als UTF-8 gespeichert?
0