Ktlintで差分のみチェックする

前回の続き。

前回をベースに差分のみチェックするように変更したい。
ktlint-gradleプラグインを使用するとapp/src内のモジュールごとにレポートファイルが生成されてしまうためプラグインを使用しなかったが妥協してmainモジュールのみlintでチェックすることにした。

f:id:kyamashiro:20200429100315p:plain:w300

差分のみcommit時にフォーマットする

ktlint-gradleプラグインを使用すると./gradlew addKtlintCheckGitPreCommitHookコマンドで自動でpre-commitファイルが作成されます。
プラグインなしだと引数にlintでチェックしたいファイルを指定できないので全ファイル対象になってしまいますが、プラグインだと-PinternalKtlintGitFilterオプションでいけるっぽいですね。

#!/bin/sh
set -e
######## KTLINT-GRADLE HOOK START ########

CHANGED_FILES="$(git --no-pager diff --name-status --no-color --cached | awk '$1 != "D" && $2 ~ /\.kts|\.kt/ { print $2}')"

if [ -z "$CHANGED_FILES" ]; then
    echo "No Kotlin staged files."
    exit 0
fi;

echo "Running ktlint over these files:"
echo "$CHANGED_FILES"

./gradlew --quiet ktlintFormat -PinternalKtlintGitFilter="$CHANGED_FILES"

echo "Completed ktlint run."

echo "$CHANGED_FILES" | while read -r file; do
    if [ -f $file ]; then
        git add $file
    fi
done

echo "Completed ktlint hook."
######## KTLINT-GRADLE HOOK END ########

ktlintコマンドだとこれでいけるっぽい

#!/bin/sh
# https://github.com/shyiko/ktlint pre-commit hook
git diff --name-only --cached --relative | grep '\.kt[s"]\?$' | xargs ktlint --relative .
if [ $? -ne 0 ]; then exit 1; fi

github action workflowの設定

name: CI
on:
  pull_request:
    branches:
      - master
      - develop
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v1
      - name: Setup ruby
        uses: actions/setup-ruby@v1
        with:
          ruby-version: '2.6'
          architecture: 'x64'
      - name: install danger
        run: |
          gem install bundler
          bundle install --path vendor/bundle
      - name: run ktlint
        run: git --no-pager diff --name-only origin/master..origin/$GITHUB_HEAD_REF | grep -e '.kt$' -e '.kts$' | xargs -0 -I{} ./gradlew ktlintCheck -PinternalKtlintGitFilter={}
      - name: run danger
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: bundle exec danger