開發者工具

YAML 格式化工具

貼上 YAML,取回乾淨的結果,或得知確切是哪一行有誤。

YAML 格式化工具 在您的裝置上執行
  • 在您的瀏覽器中執行 — 您的文字絕不會傳送到任何地方
  • 免註冊、無額度限制,可隨您高興使用多少次

運作方式

YAML 的整個設計都建立在縮排上,這讓它讀起來舒服,也異常容易弄壞。一個多餘的空格,就會讓 CI 管線在二十分鐘後丟出錯誤訊息。這裡會立即解析,並馬上告訴您。

附行號的驗證

如果文件無法解析,您會得到出錯的行號與欄號,以及解析器自己給的原因。這幾乎總是比格式化後的輸出更有用,也是大多數人開啟這類工具的原因。

重新格式化

有效的 YAML 會被解析成資料結構,再從頭重新寫出,因此縮排會統一、引號會標準化,多餘的結尾空白也會消失。由於是透過資料來回轉換,而不是編輯文字,結果保證是有效的。

來回轉換的代價

註解會遺失。它們不屬於資料,所以解析器會將其捨棄。錨點與別名會被展開成完整的值,而不是被保留。如果您的檔案中的註解很重要,請對副本格式化,再手動套用縮排的修正。

為鍵排序

依字母排序能讓兩份設定檔在比對時真正具有可比性。但對於順序對人類讀者有意義的檔案,這就是錯誤的選擇,CI 管線依執行順序讀起來比依字母順序更好。

多份文件

包含以 --- 分隔的多份文件的檔案可以處理,每份文件會依序被格式化。

常見問題

YAML 格式化工具常見問題

為什麼我的註解不見了?

格式化會把 YAML 解析成資料再重新寫出,而註解不屬於資料。如果需要保留註解,請對副本進行格式化。

它會告訴我錯誤在哪裡嗎?

會,包含行號與欄號,以及解析器自己的說明。

我的 YAML 會被上傳嗎?

不會。它在您的瀏覽器中解析,考量到 YAML 常存放機密與基礎架構細節,這一點很重要。

它能處理同一個檔案中的多份文件嗎?

可以,以 --- 分隔的文件會各自被格式化。

我應該為鍵排序嗎?

比較兩份設定檔時很有用。但若順序對讀者有意義,就沒有幫助。