yamlfmt

yamlfmt

yamlfmt ist ein erweiterbares Befehlszeilentool oder eine Bibliothek zum Formatieren von Yaml-Dateien.

Ziele

• Erstellen Sie ein Befehlszeilen-YAML-Formatierungstool, das einfach zu verteilen ist (einzelne Binärdatei).
• Erleichtern Sie die Erweiterung mit neuen benutzerdefinierten Formatierern
• Ermöglichen Sie eine alternative Nutzung als Bibliothek und bieten Sie Benutzern eine Grundlage für die Erstellung eines Tools, das spezifische Anforderungen erfüllt

Betreuer

Dieses Tool wird noch nicht offiziell von Google unterstützt. Es wird derzeit ausschließlich von @braydonk gepflegt und sofern sich nichts ändert, hauptsächlich in der Freizeit.

Blog

Ich werde diese Links zu GitHub-Diskussionen als eine Art Blog verwenden, bis ich etwas Richtigeres einrichten kann:

• yamlfmts jüngste langsame Entwicklung #149
• Probleme im Zusammenhang mit der yaml.v3-Bibliothek Nr. 148

Installation

Um den Befehl yamlfmt herunterzuladen, können Sie die gewünschte Binärdatei von Releases herunterladen oder das Modul direkt installieren:

 go install github.com/google/yamlfmt/cmd/yamlfmt@latest

Dies erfordert derzeit Go-Version 1.18 oder höher.

HINWEIS: Die empfohlene Einrichtung, wenn Sie Go zum ersten Mal installieren, finden Sie in diesem DigitalOcean-Blogbeitrag.

Sie können die gewünschte Binärdatei auch aus Releases herunterladen. Die Binärdatei ist autark, ohne Abhängigkeiten und kann einfach irgendwo in Ihrem PATH abgelegt und mit dem Befehl yamlfmt ausgeführt werden. Lesen Sie hier mehr über die Überprüfung der Authentizität freigegebener Artefakte.

Sie können den Befehl auch als Pre-Commit-Hook installieren. Anweisungen finden Sie in den Pre-Commit-Hook-Dokumenten.

Grundlegende Verwendung

Ausführliche Informationen und verfügbare Flags finden Sie unter Befehlsverwendung.

Um das Tool mit allen Standardeinstellungen auszuführen, führen Sie den Befehl mit einem Pfadargument aus:

yamlfmt x.yaml y.yaml < ... >

Sie können beliebig viele Pfade angeben. Sie können auch ein Verzeichnis angeben, das rekursiv nach Dateien mit der Erweiterung .yaml oder .yml durchsucht wird.

yamlfmt .

Sie können auch einen alternativen Modus verwenden, der Pfade mit Doublestar-Globs durchsucht, indem Sie das Flag -dstar angeben.

yamlfmt -dstar ** / * .{yaml,yml}

Weitere Informationen zu diesem Format finden Sie im Doublestar-Paket.

Konfigurationsdatei

Der Befehl yamlfmt kann über eine Yaml-Datei namens .yamlfmt konfiguriert werden. Diese Datei kann sich in Ihrem Arbeitsverzeichnis, einem durch ein CLI-Flag angegebenen Pfad oder im standardmäßigen globalen Konfigurationspfad auf Ihrem System befinden (Einzelheiten finden Sie in der Dokumentation). Eine ausführliche Konfigurationsdokumentation finden Sie unter Config.

Überprüfung von Release-Artefakten

HINWEIS: Unterstützung für die Verifizierung mit Cosign ist ab Version 0.14.0 vorhanden.

Falls Sie die yamlfmt Binärdatei direkt von einer Version erhalten, möchten Sie möglicherweise deren Authentizität überprüfen. Prüfsummen werden auf alle freigegebenen Artefakte angewendet und die resultierende Prüfsummendatei wird mit Cosign signiert.

Schritte zur Überprüfung (ersetzen Sie ABC in den unten aufgeführten Befehlen durch die gewünschte Version):

1. Laden Sie die folgenden Dateien aus der Version herunter:

    curl -sfLO https://github.com/google/yamlfmt/releases/download/vA.B.C/checksums.txt
   curl -sfLO https://github.com/google/yamlfmt/releases/download/vA.B.C/checksums.txt.pem
   curl -sfLO https://github.com/google/yamlfmt/releases/download/vA.B.C/checksums.txt.sig
   

2. Überprüfen Sie die Signatur:

    cosign verify-blob checksums.txt 
       --certificate checksums.txt.pem 
       --signature checksums.txt.sig 
       --certificate-identity-regexp ' https://github.com/google/yamlfmt/.github/workflows/.+ ' 
       --certificate-oidc-issuer " https://token.actions.githubusercontent.com "

3. Laden Sie das gewünschte komprimierte Archiv herunter und validieren Sie seine Prüfsumme:

   curl -sfLO https://github.com/google/yamlfmt/releases/download/vA.B.C/yamlfmt_A.B.C_Linux_x86_64.tar.gz
   sha256sum --ignore-missing -c checksums.txt

4. Wenn die Prüfsummenvalidierung erfolgreich ist, dekomprimieren Sie das Archiv:

   tar -xzf yamlfmt_A.B.C_Linux_x86_64.tar.gz
   ./yamlfmt