yamlfmt

yamlfmt

yamlfmt est un outil ou une bibliothèque de ligne de commande extensible pour formater les fichiers yaml.

Objectifs

• Créez un outil de formatage yaml en ligne de commande facile à distribuer (binaire unique)
• Simplifiez l'extension avec de nouveaux formateurs personnalisés
• Permettre une utilisation alternative en tant que bibliothèque, fournissant une base permettant aux utilisateurs de créer un outil qui répond à des besoins spécifiques

Mainteneurs

Cet outil n'est pas encore officiellement pris en charge par Google. Il est actuellement maintenu uniquement par @braydonk, et à moins que quelque chose ne change principalement pendant le temps libre.

Blogue

Je vais utiliser ces liens vers les discussions GitHub comme une sorte de blog, jusqu'à ce que je puisse mettre en place quelque chose de plus approprié :

• Développement lent récent de yamlfmt #149
• Problèmes liés à la bibliothèque yaml.v3 #148

Installation

Pour télécharger la commande yamlfmt , vous pouvez télécharger le binaire souhaité à partir des versions ou installer le module directement :

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

Cela nécessite actuellement la version Go 1.18 ou supérieure.

REMARQUE : la configuration recommandée si c'est la première fois que vous installez Go se trouve dans cet article de blog DigitalOcean.

Vous pouvez également télécharger le binaire souhaité à partir des versions. Le binaire est autonome, sans dépendances, et peut simplement être placé quelque part sur votre PATH et exécuté avec la commande yamlfmt . En savoir plus sur la vérification de l’authenticité des artefacts publiés ici.

Vous pouvez également installer la commande en tant que hook de pré-validation. Consultez la documentation du hook de pré-validation pour obtenir des instructions.

Utilisation de base

Voir Utilisation des commandes pour des informations détaillées et les indicateurs disponibles.

Pour exécuter l'outil avec tous les paramètres par défaut, exécutez la commande avec un argument de chemin :

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

Vous pouvez spécifier autant de chemins que vous le souhaitez. Vous pouvez également spécifier un répertoire dans lequel sera recherché de manière récursive tous les fichiers portant l'extension .yaml ou .yml .

yamlfmt .

Vous pouvez également utiliser un mode alternatif qui recherchera les chemins avec des globes double étoile en fournissant l'indicateur -dstar .

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

Voir le forfait doublestar pour plus d'informations sur ce format.

Fichier de configuration

La commande yamlfmt peut être configurée via un fichier yaml appelé .yamlfmt . Ce fichier peut résider dans votre répertoire de travail, un chemin spécifié via un indicateur CLI ou dans le chemin de configuration global standard de votre système (voir la documentation pour plus de détails). Pour une documentation de configuration détaillée, voir Config.

Vérification des artefacts de version

REMARQUE : La prise en charge de la vérification avec cosignature est présente à partir de la version 0.14.0.

Si vous obtenez le binaire yamlfmt directement à partir d'une version, vous souhaiterez peut-être vérifier son authenticité. Les sommes de contrôle sont appliquées à tous les artefacts publiés et le fichier de somme de contrôle résultant est signé à l'aide de cosignature.

Étapes à vérifier (remplacez ABC dans les commandes répertoriées ci-dessous par la version souhaitée) :

1. Téléchargez les fichiers suivants à partir de la version :

    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. Vérifiez la signature :

    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. Téléchargez l'archive compressée souhaitée et validez sa somme de contrôle :

   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. Si la validation de la somme de contrôle réussit, décompressez l'archive :

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