Loading…

Über Online HCL / Terraform-Formatierer

Terraform, Packer und andere HashiCorp-Tools verwenden alle HCL2 – und sie sehen alle besser aus, wenn sie konsistent formatiert sind. Dieser HCL-Formatierer sendet Ihre Konfiguration an ein sicheres Backend, das terraform fmt–Stilregeln für Einrückung, Abstände und Layout anwendet und dann normalisierte HCL2 zurückgibt, während die Semantik unverändert bleibt.

Hauptmerkmale

  • HCL2-bewusste Formatierung für Terraform-Stil-Blöcke, Attribute, Listen/Maps und Heredocs
  • Konsistente Einrückung und Abstände um =, Kommas, Klammern und verschachtelte Blöcke
  • Bewahrt Kommentare und absichtliche Leerzeilen möglichst für Lesbarkeit
  • Funktioniert mit .tf-, .hcl-, HCL-basierten .tfvars- und Packer .pkr.hcl-Dateien
  • Idempotente Ausgabe: Erneutes Ausführen des Formatierers liefert dasselbe Ergebnis
  • Minimale Angriffsfläche: Eine einzige „Formatieren“-Aktion, keine Stiloptionen zum Diskutieren
  • Ein-Klick-Kopieren oder Herunterladen des formatierten Ergebnisses aus dem Editor
  • Servergestützte Verarbeitung über einen gesicherten Endpunkt – ideal für schnelle Korrekturen; bevorzugen Sie lokale CLI für hochsensible Codes

🔧 So verwenden Sie den HCL-Formatierer for hcl-formatter

1

1. Code einfügen oder ablegen

Öffnen Sie Ihre HCL/Terraform-Datei (.tf, HCL-basierte .tfvars, .hcl, .pkr.hcl usw.) und fügen Sie den Inhalt in den Editor ein, oder legen Sie die Datei ab, falls Ihr Browser dies unterstützt.

2

2. „Formatieren“ klicken

Klicken Sie auf die Schaltfläche Formatieren. Ihre Konfiguration wird an ein sicheres Backend gesendet, das terraform fmt-ähnliche Regeln für Einrückung, Abstände und Layout anwendet und dann formatiertes HCL2 zurückgibt.

3

3. Überprüfen, Kopieren oder Herunterladen

Überprüfen Sie das Ergebnis im Editor und kopieren Sie es zurück in Ihre IDE oder laden Sie die formatierte Datei herunter und committen Sie sie in Ihr Repository.

Technische Spezifikationen

Ausführungsmodell

Der Formatierer ist servergestützt und darauf ausgelegt, die Layout-Normalisierung im Stil von terraform fmt für HCL2 nachzuahmen.

AspektDetails
ModusServergestützt (kein WASM im Browser)
UmfangLeerzeichen, Einrückung, Abstände, grundlegendes Layout
NeuanordnungKeine semantische Neuanordnung von Ressourcen oder Blöcken
OptionenKeine – einzelne Formatierungsaktion für vorhersehbare Ausgabe
GrenzenCa. 1–2 MB Eingabe, ~25s Server-Timeout (kann angepasst werden)
AufbewahrungVorübergehende Verarbeitung – Eingabe wird nach der Formatierung verworfen
Vermeiden Sie wie bei jedem Online-Tool das Einfügen von Produktionsgeheimnissen. Verwenden Sie terraform fmt oder packer fmt lokal für sensiblen Code.

Sprachabdeckung

Versteht gängige HCL2-Konstrukte, die in Terraform und anderen HashiCorp-Tools verwendet werden.

KonstruktBeispieleHinweise
Blöckeresource, variable, output, module, locals, job, taskVerschachtelte Blockstruktur erhalten
Attributename = "web", count = 2Abstände um = und zwischen Attributen normalisiert
Sammlungen[1, 2, 3], { key = value }Einheitliches Layout für Listen und Maps/Objekte
Heredocs<<-EOF ... EOFMarkierungen erhalten; Einrückung wo möglich normalisiert
Kommentare# und //-Stil KommentareWo möglich beibehalten, um Absicht und Dokumentation zu bewahren

Mini Vorher/Nachher

Ein kleines Beispiel zur Bereinigung von Einrückung und Abständen in einer Terraform-Ressource.

# Vorher
resource "aws_s3_bucket" "b"{bucket="demo"
  tags={Name="demo"}}

# Nachher
resource "aws_s3_bucket" "b" {
  bucket = "demo"

  tags = {
    Name = "demo"
  }
}
Nur Layout-Transformation: Bezeichner, Ausdrücke und Referenzen bleiben unverändert.

Fehler & Grenzfälle

Wenn die Formatierung fehlschlägt oder einen Fehler zurückgibt, liegt dies meist an Parsing-Problemen in der HCL2-Eingabe.

SymptomWahrscheinliche UrsacheWas zu prüfen ist
Keine Ausgabe / Parse-FehlerUnge schlossene Klammer, eckige Klammer oder runde KlammerZähle passende { }, [ ], ( ) Paare und schließe alle Blöcke
Heredoc-ProblemeFehlender oder nicht übereinstimmender TerminatorSicherstellen, dass Marker wie EOF exakt und in eigener Zeile erscheinen
Gemischte StileTabs/Leerzeichen oder verirrte ZeichenEinrückung normalisieren, verirrte Steuerzeichen entfernen
.tfvars-VerwirrungJSON vs. HCL-SyntaxJSON-Formatter oder terraform fmt für *.tfvars.json-Dateien verwenden

Kommandozeilen-Alternativen

Für tägliche Infrastructure-as-Code-Workflows verwenden Sie offizielle Formatter lokal und in CI, und behalten Sie dieses Online-Tool für schnelle Ad-hoc-Bereinigungen.

macOS / Linux

Terraform: Formatierung vor Ort

terraform fmt

Überschreibt .tf und HCL-basierte .tfvars-Dateien im aktuellen Verzeichnis.

Terraform: Rekursive CI-Prüfung (keine Schreibvorgänge)

terraform fmt -check -recursive

Beendet mit Nicht-Null, falls eine Datei Formatierung benötigt — perfekt für CI und Pre-Commit-Hooks.

Packer: Template formatieren

packer fmt pfad/zu/template.pkr.hcl

Formatiert die angegebene Packer-HCL-Datei vor Ort.

Windows (PowerShell)

Alle Terraform-Dateien rekursiv formatieren

Get-ChildItem -Recurse -Filter *.tf | ForEach-Object { terraform fmt $_.FullName }

Führt terraform fmt für jede .tf-Datei aus, die unter dem aktuellen Verzeichnis gefunden wird.

Formatierungsprüfung im CI-Stil

terraform fmt -check -recursive

In Build-Pipelines verwenden, um bei veralteter Formatierung fehlzuschlagen.

GitHub Actions

Build fehlschlagen lassen, wenn Formatierung erforderlich ist

steps:
  - uses: hashicorp/setup-terraform@v3
  - run: terraform fmt -check -recursive

Stoppt den Workflow, wenn eine Terraform-Datei nicht korrekt formatiert ist.

Automatische Formatierung bei Pull Requests (optional)

steps:
  - run: terraform fmt -recursive
  - run: git diff --quiet || (git config user.name "bot" && git config user.email "bot@example" && git commit -am "chore: terraform fmt" && git push)

Wendet terraform fmt an und pusht einen Commit mit nur Formatierungsänderungen zurück zum Branch.

Für regulierte oder vertrauliche Infrastruktur-Codes bevorzugen Sie lokale CLI-Tools und erzwingen Sie `terraform fmt -check -recursive` in der CI, anstatt Dateien an Online-Formatierer zu senden.

Praktische Anwendungen

PR-Hygiene & Reviews

Normalisieren Sie Leerzeichen und Einrückungen, damit Reviewer sich auf tatsächliche Infrastrukturänderungen konzentrieren können.

  • Formatierung vor dem Öffnen eines Pull Requests ausführen
  • Reduzieren Sie pingelige Stilkommentare in Terraform-Reviews
  • Halten Sie Git-Diffs klein und aussagekräftig

Terraform-Modulentwicklung

Halten Sie Module über Teams, Repositories und Registries hinweg konsistent.

  • Variablen- und Output-Blöcke in gemeinsamen Modulen ausrichten
  • Sicherstellen, dass Beispielkonfigurationen einem einheitlichen Hausstil entsprechen

CI-Überwachung

Verwenden Sie terraform fmt-Prüfungen in der CI, um Stilabweichungen im Laufe der Zeit zu verhindern.

  • Fügen Sie `terraform fmt -check -recursive` als obligatorischen Pipelineschritt hinzu
  • Blockieren Sie Merges, bis alle .tf-Dateien formatiert sind

Onboarding & Dokumentation

Lesbare Beispiele helfen neuen Teammitgliedern, sowohl Terraform als auch den Hausstil schnell zu erlernen.

  • Veröffentlichen Sie konsistent formatierte Snippets in READMEs
  • Verwenden Sie saubere Beispiele in internen Terraform-Schulungen

❓ Frequently Asked Questions

🔒Wird mein Code lokal verarbeitet?

Nein. Dieser HCL-Formatierer ist serverbasiert: Ihre Eingabe wird an einen sicheren Endpunkt zur Formatierung gesendet und das resultierende HCL wird an Ihren Browser zurückgegeben. Für hochsensible oder regulierte Infrastruktur-Codes bevorzugen Sie die lokale Ausführung von `terraform fmt` (oder `packer fmt`).

🛡️Kann ich hier Geheimnisse einfügen?

Wir empfehlen dringend, keine Produktionsgeheimnisse in ein Online-Tool einzufügen. Auch wenn der Dienst gesichert und für vorübergehende Verarbeitung ausgelegt ist, sollten langlebige oder hochsensible Anmeldedaten nur in lokalen Dateien, Geheimnisspeichern oder CI-Tresoren aufbewahrt werden – nicht in Browser-Tools.

🧩Ändert die Formatierung das Konfigurationsverhalten?

Nein. Der Formatierer konzentriert sich auf das Layout: Leerzeichen, Einzüge und Abstände. Ressourcenblöcke, Argumente, Ausdrücke und Referenzen bleiben gleich, vorausgesetzt, das ursprüngliche HCL war gültig.

📄Kann ich .tfvars-Dateien formatieren?

Ja, solange die .tfvars-Datei HCL-Syntax verwendet. Terraform unterstützt auch JSON-basierte Variablen über `.tfvars.json`; diese folgen JSON-Regeln und werden besser von einem JSON-Formatierer oder `terraform fmt` selbst behandelt.

⚙️Wie unterscheidet sich dies von `terraform fmt`?

`terraform fmt` ist der kanonische Formatierer, der mit Terraform ausgeliefert wird und ideal für die lokale Entwicklung und CI. Dieses Web-Tool ist für schnelle, ad-hoc-Bereinigungen gedacht, wenn Sie die CLI nicht zur Hand haben oder einen kleinen Ausschnitt im Browser aufräumen möchten.

🧯Warum ist die Formatierung fehlgeschlagen?

Die meisten Fehler sind Parse-Fehler: nicht geschlossene Klammern oder eckige Klammern, fehlerhafte Heredocs oder das Vermischen von JSON-stil tfvars mit HCL-Syntax. Beheben Sie das strukturelle Problem (oder verwenden Sie den richtigen Dialekt/Formatierer) und versuchen Sie es erneut.

Pro Tips

CI Tip

Erzwingen Sie `terraform fmt -check -recursive` in CI, um Formatierungsabweichungen in großen Infrastruktur-Repositories zu verhindern.

Security Tip

Vermeiden Sie das Einfügen von Geheimnissen oder zustandsbezogenen Daten in Online-Tools; halten Sie Konfigurationsbeispiele bereinigt und führen Sie lokale CLI-Formatierer für echten Infrastrukturcode aus.

Best Practice

Normalisieren Sie abschließende Zeilenumbrüche und Einzüge in Ihrem Editor, damit Terraform-Dateien saubere, stabile Diffs über Plattformen hinweg erzeugen.

Best Practice

Fügen Sie einen Pre-Commit-Hook hinzu, der `terraform fmt` ausführt, damit Pull-Requests bereits formatiert eintreffen und Review-Gespräche sich auf Architektur und Risiken konzentrieren können.

Additional Resources

Terraform CLI: fmt
Documentation
Terraform-Sprache (HCL2) Überblick
Reference
HashiCorp Configuration Language (HCL) – GitHub
Technical specification
Packer CLI: fmt
Documentation

Other Tools