yamlfmt

yamlfmt

yamlfmt es una herramienta o biblioteca de línea de comandos extensible para formatear archivos yaml.

Objetivos

• Cree una herramienta de formato yaml de línea de comando que sea fácil de distribuir (binario único)
• Simplifique la ampliación con nuevos formateadores personalizados
• Permitir el uso alternativo como biblioteca, proporcionando una base para que los usuarios creen una herramienta que satisfaga necesidades específicas.

mantenedores

Esta herramienta aún no cuenta con el respaldo oficial de Google. Actualmente lo mantiene únicamente @braydonk y, a menos que algo cambie, principalmente en el tiempo libre.

Blog

Voy a utilizar estos enlaces a Discusiones de GitHub como una especie de blog, hasta que pueda configurar algo más adecuado:

• El lento desarrollo reciente de yamlfmt #149
• Problemas relacionados con la biblioteca yaml.v3 #148

Instalación

Para descargar el comando yamlfmt , puede descargar el binario deseado de las versiones o instalar el módulo directamente:

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

Actualmente, esto requiere la versión 1.18 o superior de Go.

NOTA: La configuración recomendada si es la primera vez que instala Go se encuentra en esta publicación del blog de DigitalOcean.

También puedes descargar el binario que quieras de los lanzamientos. El binario es autosuficiente sin dependencias y simplemente puede colocarse en algún lugar de su RUTA y ejecutarse con el comando yamlfmt . Lea más sobre cómo verificar la autenticidad de los artefactos publicados aquí.

También puede instalar el comando como un enlace de confirmación previa. Consulte los documentos del enlace de confirmación previa para obtener instrucciones.

Uso básico

Consulte Uso de comandos para obtener información detallada y indicadores disponibles.

Para ejecutar la herramienta con todas las configuraciones predeterminadas, ejecute el comando con un argumento de ruta:

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

Puede especificar tantas rutas como desee. También puede especificar un directorio en el que se buscará recursivamente cualquier archivo con la extensión .yaml o .yml .

yamlfmt .

También puedes usar un modo alternativo que buscará rutas con globos de doble estrella proporcionando el indicador -dstar .

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

Consulte el paquete doublestar para obtener más información sobre este formato.

Archivo de configuración

El comando yamlfmt se puede configurar a través de un archivo yaml llamado .yamlfmt . Este archivo puede residir en su directorio de trabajo, en una ruta especificada a través de un indicador CLI o en la ruta de configuración global estándar de su sistema (consulte los documentos para obtener detalles). Para obtener documentación de configuración detallada, consulte Config.

Verificación de artefactos de liberación

NOTA: La compatibilidad con la verificación con cosign está presente desde la versión 0.14.0 en adelante.

En caso de que obtenga el binario yamlfmt directamente de una versión, es posible que desee verificar su autenticidad. Las sumas de comprobación se aplican a todos los artefactos publicados y el archivo de suma de comprobación resultante se firma mediante cosign.

Pasos para verificar (reemplace ABC en los comandos que se enumeran a continuación con la versión que desee):

1. Descargue los siguientes archivos de la versión:

    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. Verificar la firma:

    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. Descargue el archivo comprimido que desee y valide su suma de verificación:

   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 se realiza la validación de la suma de comprobación, descomprima el archivo:

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