Laravel5、コメント日本語、エラーメッセージも日本語!

タグ: Laravel5  

Laravel4の頃は、GitHubのlarave-ja/laravelリポジトリーで、大元のlaravel/laravelリポに含まれるファイルのコメントを翻訳したバージョンを提供していました。今も残骸は残っています…

基本的に、laravel/laravelでもローカルに取り込むときに、.gitの修正履歴は必要ありません。確かにアップデートに伴う修正、主に項目の追加は発生し得るのですが、その追加項目は十分に検討すべきで、pullしてお仕舞いにはできません。それに追加項目はドキュメントのアップグレードで、説明されます。それを読んで、追加したほうが良いと思います。

それでも、オリジナルでないというのはやはり気持ち悪いらしく、さほどlaravel-ja/laravelは流行りませんでした。

しかし、そうしたコメントも「ドキュメントのうち」だというのが、Laravelの考え方です。ですから、英語が苦手な方に日本語ドキュメントが必要なように、コメントの翻訳も必要です。

そこで、Laravel5からはコメント翻訳コマンドを提供することにしました。

(注目:MacとWindowsでソースのComjaとコマンドのcomjaがバッティングしていたため、コマンド名をcomja5へ変更しました。)

参照:GitHub : laravel-ja/comja5

このパッケージで提供するのは、コマンドが一つです。コマンド実行してもらえば、laravel/laravelのファイルのコメント部分だけを翻訳します。

また、larave-ja/laravelには、もう一つ重要な使命があり、日本語言語ファイルを提供していました。このリポはもうLaravel5に対応しません。そこで、言語ファイルもこのコマンドで生成することにしました。

どこか別の場所から引っ張ってくるわけでありません。英語のenフォルダーをjaとしてコピーし、その文言を日本語に置き換えるだけです。ですから、安心して使ってください。

インストール

Packagistに登録してありますので、composer.jsonを開き、requireセクションに追加してください。

"laravel-ja/comja5": "~1"

requireの最後の項目でない場合は、行末にカンマが必要です。

インストールするために、composer updateを実行してください。

もしくは、composer require laravel-ja/comja5を実行すれば、自動的にcomposer.jsonに項目が追加され、インストールされます。

必要がなくなれば、"laravel-ja/comja5"の行を削除し、composer updateをかけてください。アンインストールされます。

実行法

vendor/bin/comja5実行ファイルが用意されますので、そのまま実行してください。オプションが表示されます。

たぶん「コメント日本語にして、日本語言語ファイルを生成して、皆んなが嫌いなタブを4スペースに変換したい」人が多いと思います。その場合は-aオプションを使います。

vendor/bin/comja5 -a

Artisanのファイル生成機能を活用する人は、生成ファイルの中のタブが気になるかも知れません。その場合は-tオプションでスペース4つへ変更できます。(4スペースが気に入らなければ、-t=でスペースの数を指定してください。)

vendor/bin/comja5 -t

Laravelに慣れてくると、段々コメントが要らなくなります。コメントが長すぎてイライラし出したら、それは成長の証です。そうなれば、コメント入りません。削除しましょう。徹底的にコメントを削除するには-rオプションです。(ただし、あなたの書いたコメントも削除します。ですから、インストール直後に行いましょう。)

vendor/bin/comja5 -r

それなら、最初から「コメント削除して、日本語言語ファイルを生成して、タブは4空白に変換」したいですね。そんなプロフェッショナルなあなたには-Aオプションが用意されています。

vendor/bin/comja5 -A

comjaは大したことをやっていません。Laravelも使っていません。生のPHPです。コードを読んでも参考にはならないでしょう。:D

でも、使えるやつです。