e Builderのフォーマッター関連の設定をGit経由で共有する方法

はじめに

こんにちは。開発部のA.Nです。

今回はe Builderのフォーマッター関連の設定をGit経由で共有する方法について紹介します。

プログラミングにおいて、ソースコードのフォーマットを整えることは非常に重要です。
チーム開発時に、フォーマットを揃えることでソースの可読性が向上し、作業の効率化に繋がります。

ぜひご活用ください!

e Builderのフォーマッター関連の機能について

e Builderには、ソースコードの書き方をチェックするツールや自動で整形する機能が備わっています。

  • CheckStyle
    CheckStyleとは、静的コード解析ツールで、コードのスタイルやコーディング規約に違反していないかを自動で検査するツールです。 違反している場合は下記のように背景が黄色になります。

CheckStyle警告画面

  • フォーマッター
    フォーマット定義の設定をもとにソースコードを自動で整形します。 Ctrl + Shift + Fでフォーマッターを利用できます。

フォーマッター関連の設定を共有する手順

フォーマッター関連の設定は、 ①e Builder上で設定を適用、②.settingsディレクトリのファイルをコミットの手順で共有が可能です。

CheckStyle・フォーマッターともにe Builder上で任意の設定ファイルを指定しますが、Gitでの共有時には各個人の環境に設定ファイルのインポートは不要です。

e Builder上で設定を適用

  • CheckStyle
    メニュー>ウィンドウ>設定>CheckStyleから任意の設定ファイルを適用します。

    CheckStyle設定画面

  • フォーマッター
    メニュー>ウィンドウ>設定>Java>コード・スタイル>フォーマッターから任意の設定ファイルを適用します。

    Formatter設定画面

また、下記設定で保存時にも自動でフォーマットされるようになります。

メニュー>ウィンドウ>設定>Java>エディター>保管アクション
(「ソース・コードのフォーマット」にチェックを入れる)

保存時Formatter適用設定画面

Gitにファイルをコミット

上記設定変更後に、.settings配下のファイルが変更されるため変更箇所をコミットしましょう。

おわりに

e Builderのフォーマッター関連の設定をGit経由で共有する方法について紹介しました。

今回の内容を活用して、チームでのフォーマット統一を効率的に行っていきましょう!