yamlfmt
adalah alat atau pustaka baris perintah yang dapat diperluas untuk memformat file yaml.
Alat ini belum didukung secara resmi oleh Google. Saat ini hanya dikelola oleh @braydonk, dan kecuali ada perubahan terutama di waktu luang.
Saya akan menggunakan tautan ini ke Diskusi GitHub sebagai semacam blog, hingga saya dapat menyiapkan sesuatu yang lebih tepat:
Untuk mengunduh perintah yamlfmt
, Anda dapat mengunduh biner yang diinginkan dari rilis atau menginstal modul secara langsung:
go install github.com/google/yamlfmt/cmd/yamlfmt@latest
Saat ini memerlukan Go versi 1.18 atau lebih tinggi.
CATATAN: Pengaturan yang disarankan jika ini adalah pertama kalinya Anda menginstal Go ada di postingan blog DigitalOcean ini.
Anda juga dapat mengunduh biner yang Anda inginkan dari rilis. Biner ini mandiri tanpa ketergantungan, dan dapat dengan mudah diletakkan di suatu tempat di PATH Anda dan dijalankan dengan perintah yamlfmt
. Baca selengkapnya tentang memverifikasi keaslian artefak yang dirilis di sini.
Anda juga dapat menginstal perintah sebagai hook pra-komit. Lihat dokumen hook pra-komit untuk petunjuknya.
Lihat Penggunaan Perintah untuk informasi mendalam dan tanda yang tersedia.
Untuk menjalankan alat dengan semua pengaturan default, jalankan perintah dengan argumen jalur:
yamlfmt x.yaml y.yaml < ... >
Anda dapat menentukan jalur sebanyak yang Anda inginkan. Anda juga dapat menentukan direktori yang akan dicari secara rekursif untuk file apa pun dengan ekstensi .yaml
atau .yml
.
yamlfmt .
Anda juga dapat menggunakan mode alternatif yang akan mencari jalur dengan gumpalan doublestar dengan menyediakan flag -dstar
.
yamlfmt -dstar ** / * .{yaml,yml}
Lihat paket doublestar untuk informasi lebih lanjut tentang format ini.
Perintah yamlfmt
dapat dikonfigurasi melalui file yaml bernama .yamlfmt
. File ini dapat berada di direktori kerja Anda, jalur yang ditentukan melalui flag CLI, atau di jalur konfigurasi global standar pada sistem Anda (lihat dokumen untuk lebih spesifik). Untuk dokumentasi konfigurasi mendalam, lihat Config.
CATATAN: Dukungan untuk verifikasi dengan cosign hadir mulai v0.14.0 dan seterusnya.
Jika Anda mendapatkan biner yamlfmt
langsung dari rilis, Anda mungkin ingin memverifikasi keasliannya. Checksum diterapkan ke semua artefak yang dirilis, dan file checksum yang dihasilkan ditandatangani menggunakan cosign.
Langkah-langkah untuk memverifikasi (ganti ABC
pada perintah di bawah ini dengan versi yang Anda inginkan):
Unduh file berikut dari rilis:
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
Verifikasi tanda tangan:
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 "
Unduh arsip terkompresi yang Anda inginkan, dan validasi checksumnya:
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
Jika validasi checksum berhasil, buka kompresi arsip:
tar -xzf yamlfmt_A.B.C_Linux_x86_64.tar.gz
./yamlfmt