📖

Pull Requestを送る前にGradleプロジェクトのコーディングルールを守れているか確認する方法

2023/04/26に公開

GradleにはPMDなどコーディングスタイルを設定できる機能があり、自分が加えた変更がそれに沿っているか調べる場合、./gradlew checkコマンドを実行すると確かめられます。
Kotlinにはdetektというツールもあり、IntelliJ IDEAでこれに従ってコードをフォーマットする場合、以下のようにします。

  1. [設定]の「プラグイン」でdetektを検索しプラグインをインストール
  2. [設定]の「ツール」-「Detekt」で"Enable formatting (ktlint) rules"にチェックを入れる。
  3. "Configuration file(s):"の「+」ボタンでdetekt.ymlなどそのプロジェクトの設定ファイルを追加
  4. [リファクタリング]-[AutoCorrect by Detekt Rules]メニューをクリックすると設定されたフォーマットになります。
    image.png

Discussion