kmuto / review

Re:VIEW is flexible document format/conversion system
http://reviewml.org/
GNU Lesser General Public License v2.1
1.34k stars 216 forks source link

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

Closed kdmsnr closed 10 years ago

kdmsnr commented 10 years ago

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

kmuto commented 10 years ago

yaml にしよう

takahashim commented 10 years ago

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

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

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

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

kmuto commented 10 years ago

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

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

kdmsnr commented 10 years ago

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

kmuto commented 10 years ago

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

kmuto commented 10 years ago

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

tkhm commented 8 years ago

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

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

dmiyakawa commented 8 years ago

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

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

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

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

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

kmuto commented 8 years ago

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