EditorConfigを使おう

インデントはスペース派?タブ派?


一人で開発を進めている方は、コーディング規約などを定めず、自分のやりやすいルールで自由に書いている方が多いのではないかと思いますが、もしあなたが開発しているアプリケーションの需要が爆発的に増え、開発の規模を大きくしなければならない事態になった場合、困った問題が起こると思いませんか?

私の場合はアプリケーションが人気になってというわけではないのですが、ある日突然、GitHubにコードを公開しようと思い立ちまして、公開してみたものの自分ルールで適当に書いていたコードに恥ずかしさを覚えることになりました。

人生なにが起こるかわかりません。いつ誰に見られてもいいように、みなさんも世の中の基本的な記述ルールに従ってコードを書くようにしましょう!

その第一歩がEditorConfigです。EditorConfigというのは簡単なコーディング規約を定めた仕様のようなもので、プログラマーによってそれぞれ違う記述ルールを統一することができます。

プロジェクトのルートに .editorconfig というファイルを設置し、その中に決まったルールを記述することで、複数の開発者間で同じルールを用いることができるようになるのです。

複数人で開発する予定がない方でも、各プロジェクト間で統一した書き方ができるようになるので、使う価値は大いにありますよ!

Atom、Eclipse、Emacs、NetBeans、PhpStorm、Sublime Text、Vim、Visual Studio、Xcode、その他多数の著名なエディターもプラグインでEditorConfigに対応していますので、ぜひ環境を整えて使ってみてください。

対応エディターについて知りたい方は、公式サイトを確認してください。

EditorConfig(公式・英語)

.editorconfigのサンプル


サンプルを用意しましたので参考にしてください。

ファイルの指定方法


[ファイル名]
この形でルールを定めたいファイルを指定します。

[*] すべてのファイルを指定
[*.js] 拡張子が.jsのファイルを指定
[*.{js,html,md}] 複数の拡張子のファイルをまとめて指定
[package.json] package.jsonという特定のファイルだけを指定

書き方の解説


root = true
プロジェクトのルートであるという記述です。これを記述しないと、さらに上の階層まで探しに行ってしまいます。

end_of_line = lf
改行コード:lf, cr, crlfを入力できます。

charset = utf-8
文字コード:latin1, utf-8, utf-8-bom, utf-16be, utf-16leを入力できます。

indent_style = space
インデント:space, tabを入力できます。

indent_size = 2
インデントのサイズ:数字を入力してください。2か4が基本です。

tab_width = 4
タブのサイズ:indent_styleにtabを選んだ場合にタブのサイズを入力します。デフォルトではindent_sizeの値が適用されますので、省略が可能です。

trim_trailing_whitespace = true
行末の空白(スペース)が自動的に削除されます。

insert_final_newline = true
保存される時に最後の行が必ず空の行になります。最後の行に文字が入力されている場合は、空の行が1行追加されます。

# コメント
シャープを入力するとコメントを記述することができます。

最後に


どう設定すればいいのかわからないときは、その言語のメジャーなコーディング規約に従って設定するのがいいと思います。

文字コードについては utf-8、改行コードは lf に設定しておくのが無難なようです。

参考になりそうな記事へのリンクを掲載しておきます。

コメントを残す

メールアドレスが公開されることはありません。

日本語が含まれない投稿は無視されますのでご注意ください。(スパム対策)