yamlfmt

yamlft

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標誌來搜尋具有雙星 glob 的路徑。

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

有關此格式的更多信息，請參閱 doublestar 包。

設定檔

可以透過名為.yamlfmt的 yaml 檔案來設定yamlfmt指令。該文件可以位於您的工作目錄、透過 CLI 標誌指定的路徑或系統上的標準全域設定路徑中（有關詳細信息，請參閱文件）。有關深入的配置文檔，請參閱 Config。

驗證發布工件

注意：從 v0.14.0 開始支援使用 cosign 進行驗證。

如果您直接從發行版取得yamlfmt二進位文件，您可能需要驗證其真實性。校驗和應用於所有已發佈的工件，並且產生的校驗和檔案使用 cosign 進行簽署。

驗證步驟（將下面列出的命令中的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