yamlfmt

yamlfmt

yamlfmt é uma ferramenta ou biblioteca de linha de comando extensível para formatar arquivos yaml.

Metas

• Crie uma ferramenta de formatação yaml de linha de comando que seja fácil de distribuir (binário único)
• Simplifique a extensão com novos formatadores personalizados
• Permitir o uso alternativo como biblioteca, fornecendo uma base para os usuários criarem uma ferramenta que atenda a necessidades específicas

Mantenedores

Esta ferramenta ainda não é oficialmente suportada pelo Google. Atualmente é mantido exclusivamente por @braydonk, e a menos que algo mude principalmente no tempo livre.

Blogue

Vou usar esses links para discussões do GitHub como uma espécie de blog, até que eu possa configurar algo mais adequado:

• Desenvolvimento lento recente do yamlfmt # 149
• Problemas relacionados à biblioteca yaml.v3 nº 148

Instalação

Para baixar o comando yamlfmt , você pode baixar o binário desejado das versões ou instalar o módulo diretamente:

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

Atualmente, isso requer Go versão 1.18 ou superior.

NOTA: A configuração recomendada se esta for a primeira vez que você instala o Go estaria nesta postagem do blog DigitalOcean.

Você também pode baixar o binário desejado nas versões. O binário é autossuficiente, sem dependências, e pode simplesmente ser colocado em algum lugar do seu PATH e executado com o comando yamlfmt . Leia mais sobre como verificar a autenticidade dos artefatos divulgados aqui.

Você também pode instalar o comando como um gancho de pré-confirmação. Consulte a documentação do gancho de pré-confirmação para obter instruções.

Uso Básico

Consulte Uso de comandos para obter informações detalhadas e sinalizadores disponíveis.

Para executar a ferramenta com todas as configurações padrão, execute o comando com um argumento de caminho:

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

Você pode especificar quantos caminhos desejar. Você também pode especificar um diretório que será pesquisado recursivamente por quaisquer arquivos com a extensão .yaml ou .yml .

yamlfmt .

Você também pode usar um modo alternativo que pesquisará caminhos com globs doublestar fornecendo o sinalizador -dstar .

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

Consulte o pacote doublestar para obter mais informações sobre este formato.

Arquivo de configuração

O comando yamlfmt pode ser configurado por meio de um arquivo yaml chamado .yamlfmt . Este arquivo pode estar em seu diretório de trabalho, em um caminho especificado por meio de um sinalizador CLI ou no caminho de configuração global padrão em seu sistema (consulte a documentação para obter detalhes). Para obter documentação de configuração detalhada, consulte Config.

Verificando artefatos de liberação

NOTA: O suporte para verificação com cosign está presente a partir da versão 0.14.0.

Caso você obtenha o binário yamlfmt diretamente de uma versão, você pode querer verificar sua autenticidade. As somas de verificação são aplicadas a todos os artefatos lançados e o arquivo de soma de verificação resultante é assinado usando cosign.

Passos para verificar (substitua ABC nos comandos listados abaixo pela versão desejada):

1. Baixe os seguintes arquivos do lançamento:

    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. Verifique a assinatura:

    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. Baixe o arquivo compactado desejado e valide sua soma de verificação:

   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. Se a validação da soma de verificação for concluída, descompacte o arquivo:

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