読み飛ばしてください
おはようございます、しなもんです。
yamlっていいですよね。読みやすいし、コメント書けるし。
実際、yaml形式のファイルは、構造化されたデータを記述するためのシンプルな言語であり、設定ファイルやデータファイルの記述に広く利用されるようになってきています。
しかし、そのファイルの拡張子として、.yml
と.yaml
の2種類が存在し、どちらを使うべきか悩む方も多いのではないでしょうか。
実際に3文字とそれ以外の拡張子が混合することで引き起こされる問題についてはこちらで述べています。
この記事では、業界におけるそれぞれの拡張子の使用状況、名前の由来、具体的な使い方などをまとめ、結局どちらを使うべきなのか調べてみます。
業界の使用状況
近年、様々な調査結果や統計データによると、.yaml
より.yml
の方がも広く使用されていることが分かっています。
調査会社RedMonkによる調査「State of DevOps」では、世界中のGithubリポジトリにおいて
約7割のYAMLファイルが.yml
拡張子を使用していることが報告されています。
これらの結果から、業界全体では.yml
の方が主流であると言えそうです。
由来
公式サイトによると、
YAML (a recursive acronym for “YAML Ain’t Markup Language”) is a data serialization language designed to be human-friendly and work well with modern programming languages for common everyday tasks.
意訳すると、
YAML("YAML Ain't Markup Language"(YAMLはマークアップ言語ではない)の頭文字)は、
人間にやさしく、一般的な日常的タスクのための最新のプログラミング言語とうまく動作するように設計されたデータ・シリアライズ言語である。
です。
そのまま拡張子にするのであれば、.yaml
が正しいように思えます。
使用について
どちらもyamlファイルとして正しく認識され、問題なく処理できます。
ただ、以下のようなケースでは.yaml
を使用するほうが良いと感じました。
- 正式なドキュメントや仕様書(あくまで正式名称はyamlであるため)
- xml等の似ている拡張子と区別し可読性を高めるため(4文字である利点を生かす)
結論
業界における使用状況や利便性を考慮すると、基本的に.yml
拡張子の使用が推奨されるべきかなと思います。
ただし、上記で紹介したようなケースでは、.yaml
拡張子の方が適切となる場合があります。
まあ最終的には、プロジェクトの規約やチームの慣習などを考慮し、チーム内でどちらにするかを規約として決め、それに従うのが良いかなと感じました。
迷ったら.yml
って感じです。