Atom エディタに EditorConfig を導入する

コーディングスタイルを統一するため Atom エディタに、 editorconfig パッケージを導入します。

EditorConfig

EditorConfig は、異なるエディタや IDE でも統一したコーディングスタイルを設定できます。

インストール

Atom エディタのメニューから settings を開きます。

settings の 左メニューから install を選択

install packages の検索ボックスを packages にして「 editorconfig 」と入力して検索します。

検索結果に表示される各種パッケージの Install ボタンをクリックします。

コマンドでインストールする場合には下記を実行

使い方

プロジェクトフィルツリーの root 直下に .editorconfig ファイルを設置します。

.editorconfig を初期サンプルと同じ内容で編集してみます。

設置すると Atom エディタのステータスバーにネズミマークがオレンジ色で表示されます。

ネズミマークをクリックすると警告が表示されます。

Atom の「 whitespace 」パッケージによって「 insert_final_newline 」、「 trim_trailing_whitespace 」のプロパティが動作しなくなる可能性があるとのことなので、問題を解決するために、「 whitespace 」パッケージを無効にします。

「 whitespace 」パッケージは Atom のコアパッケージですが、今回の目的であるコーディングスタイル統一の為、EditorConfigを優先させます。

whitespace パッケージの無効化

settings の 左メニューから packages を選択して検索ボックスに「 whitespace 」と入力して検索します。表示された whitespace パッケージの Disable ボタンをクリックして無効にします。

これでステータスバーに表示されていたオレンジ色のネズミが消えました。

EditorConfigを使用したプロジェクト一覧

Projects Using EditorConfig · editorconfig/editorconfig Wiki · GitHub

まとめ

チーム開発で開発をすると、ルールを決めても沿ってないコーディングがあったりするものですが、EditorConfig を設定してコーディングスタイルを統一しておくことで、コードレビューの負担を少しでも下げてストレスを減らすことができます。

参考

公式サイト:EditorConfig

atomパッケージサイト:editorconfig

関連

返信を残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

CAPTCHA