yamlの拡張子が yaml と yml で揺れている #244

Closed
kdmsnr opened this Issue Mar 26, 2014 · 9 comments

Projects

None yet

5 participants

@kdmsnr
Collaborator
kdmsnr commented Mar 26, 2014

どちらかに統一したいところ

@kdmsnr kdmsnr changed the title from yamlno to yamlの拡張子が yaml と yml で揺れている Mar 26, 2014
@kmuto
Owner
kmuto commented Mar 27, 2014

yaml にしよう

@takahashim
Collaborator

個人的には*.ymlを多用しているのですが、どちらが一般的か気になったので軽く調べてみたところ、Ruby方面では*.ymlばかりでした(多分Railsが*.yml(config/database.yml)だったからだと思いますが、Rails以外のRubyのライブラリ等でも広く*.ymlが使われています)。

  • Rails: config/database.yml
    • newrelic: newrelic.yml
    • configatron: config.yml
    • redmine: configuration.yml
  • Jekyll: _config.yml
  • amazon aws-sdk: aws.yml
  • RubyInstaller DevKit: config.yml

Ruby以外でも、PHPではSymfonyがconfig.ymlだったり、PerlでもCPANがMETA.ymlだったりしています。

一方、*.yamlがないわけでもなくて、例えばMT5がconfig.yamlだったり、Ubuntu Jujuはenvironments.yamlだったりするようです。とはいえ、Rubyのライブラリやアプリで*.yamlを使っている例は確認できませんでした(もちろん見つけられなかっただけで、ないとは限りません)。

というわけで、統一するならRe:VIEWでは*.ymlにした方がよい、に一票です。

@kmuto
Owner
kmuto commented Mar 27, 2014

4文字タームに3文字化ってどうなの…という気もするけど、現状デファクトがそうで、じゃぁjpgはどうなのヨと言われると弱いので、ymlにしましょうか。

とりあえず手元データでyamlなものは内部挙動には関係はしないので、yml統一でもOKです。

@kdmsnr
Collaborator
kdmsnr commented Mar 27, 2014

#245 がマージされたらymlに統一しましょう。

@kdmsnr kdmsnr added a commit that closed this issue Apr 3, 2014
@kdmsnr kdmsnr Change .yaml to .yml (Fix #244) 93fd449
@kdmsnr kdmsnr closed this in 93fd449 Apr 3, 2014
@kdmsnr kdmsnr added this to the 1.3.0 milestone Apr 3, 2014
@kmuto
Owner
kmuto commented Apr 3, 2014

うーむ、locale.yaml→locale.ymlは互換性破壊で、ユーザーの変更を要求することになりますね。
両方取るようにしようかな…。

@kmuto
Owner
kmuto commented Apr 3, 2014

locale.yml→locale.yamlで探索するようにしました。78ecec5

@tkhm
tkhm commented Sep 9, 2016

通りがかりです。yaml vs ymlで探していて辿り着きました。使われているのはymlが多くこちらでもymlが採用されたようですが、Official Siteではyamlを推奨しているようですね。

http://www.yaml.org/faq.html

@dmiyakawa
Contributor

興味深いので結論を待っている筋です。

感覚的には.ymlの方が多い印象で、自分も.ymlの方が好みではあります。
できればRe:VIEWでも探索優先順序も .yml -> .yamlの方が最も肌感覚に合います。

「公式では.yamlを推奨している」というのは非常にありがたい情報で参考になります (初めて知りました)。本点で気になるのは次の点です。

  1. 推奨する理由について書かれていない
  2. 実態の利用数は.ymlが多い (らしい) ため理由なければ多い方に統一するのが自然に思える
  3. 公式サイトのcopyrightの年号が 2006年で止まっており10年前。全体的にサイトの更新が数年滞っているように見える (そりゃ仕様が変わってねーんだから、というのはもちろん正しい指摘)

正直どっちでも良いと思われました。が、Re:VIEWとして「こう決めた」というスタンスを貫いていただいて、それをどこかWikiでもFAQでも明示して維持していただくことが、一人の利用者としては一番頼りになります。

@kmuto
Owner
kmuto commented Sep 13, 2016
  • closeされてるとおり、Re:VIEW内では「Rubyの主流に合わせて」という理由で、ymlで統一。
  • 一部のものについては.yaml を読むようにもしているが、とりたてて愛や主張があるわけではなく、Re:VIEWでは旧来データ資産が重要なので過去に.yamlとしていた時代との互換性のために残している。(何度か壊して移行に四苦八苦したのではないか?というのはサテオキ)
  • よって今後何らかのYAMLファイルを新規導入することになったときには.ymlのみとなるだろう。

というのがスタンスかな。
個人的には3文字以下にするのは「DOSか?DOSなのか?」という気にはなるけど ;-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment