yamlfmt

ヤムルフムト

yamlfmt yaml ファイルをフォーマットするための拡張可能なコマンド ライン ツールまたはライブラリです。

目標

• 配布が簡単なコマンド ライン yaml フォーマット ツールを作成する (単一バイナリ)
• 新しいカスタム フォーマッタを使用して簡単に拡張できるようにする
• ライブラリとしての代替使用を可能にし、ユーザーが特定のニーズを満たすツールを作成するための基盤を提供します

メンテナー

このツールはまだ Google によって正式にサポートされていません。現在、主に空き時間に何か変更がない限り、@braydonk によってのみ保守されています。

ブログ

より適切なものをセットアップできるまで、GitHub ディスカッションへのこれらのリンクを一種のブログとして使用するつもりです。

• yamlfmt の最近の遅い開発 #149
• yaml.v3 ライブラリに関する問題 #148

インストール

yamlfmtコマンドをダウンロードするには、リリースから目的のバイナリをダウンロードするか、モジュールを直接インストールします。

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

現在、これには Go バージョン 1.18 以降が必要です。

注: Go を初めてインストールする場合の推奨設定については、この DigitalOcean ブログ投稿に記載されています。

リリースから必要なバイナリをダウンロードすることもできます。このバイナリは依存関係がなく自己完結しており、PATH 上のどこかに配置し、コマンドyamlfmtで実行するだけです。リリースされたアーティファクトの信頼性の検証について詳しくは、こちらをご覧ください。

コマンドをコミット前フックとしてインストールすることもできます。手順については、コミット前フックのドキュメントを参照してください。

基本的な使い方

詳細な情報と使用可能なフラグについては、「コマンドの使用法」を参照してください。

すべてのデフォルト設定でツールを実行するには、パス引数を指定してコマンドを実行します。

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

パスは必要なだけ指定できます。拡張子.yamlまたは.ymlを持つファイルを再帰的に検索するディレクトリを指定することもできます。

yamlfmt .

-dstarフラグを指定して、ダブルスター グロブを含むパスを検索する代替モードを使用することもできます。

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

この形式の詳細については、doublestar パッケージを参照してください。

設定ファイル

yamlfmtコマンドは、 .yamlfmtという yaml ファイルを通じて設定できます。このファイルは、作業ディレクトリ、CLI フラグで指定されたパス、またはシステム上の標準のグローバル設定パスに存在できます (詳細についてはドキュメントを参照してください)。詳細な構成ドキュメントについては、「構成」を参照してください。

リリースアーティファクトの検証

注: cosign による検証のサポートは、v0.14.0 以降から提供されます。

yamlfmtバイナリをリリースから直接取得した場合は、その信頼性を確認する必要があるかもしれません。チェックサムはリリースされたすべてのアーティファクトに適用され、結果のチェックサム ファイルは余署名を使用して署名されます。

確認する手順 (以下にリストされているコマンドのABC必要なバージョンに置き換えます):

1. リリースから次のファイルをダウンロードします。

    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. 署名を検証します。

    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. 必要な圧縮アーカイブをダウンロードし、そのチェックサムを検証します。

   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. チェックサム検証が成功したら、アーカイブを解凍します。

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