checkstyle은 정해진 방식으로 xml에 코드 스타일을 작성해놓으면 해당 파일을 통해 코드 스타일을 체크해주는 플러그인이다.


우선 gradle.build에 다음과 같이 추가한다

plugins {
	...
	id 'checkstyle'
}

def checkstyleVersion = "8.44"
checkstyle {
	toolVersion = checkstyleVersion
	configFile = file("config/checkstyle/google_checks.xml")
	// default 경로는 <root>/config/checkstyle/checkstyle.xml
}

checkstyle의 google_check.xml을 /config/checkstyle 하위에 둔다


참고로 210717 15:00 GMT+9 현재, 최신 commit에 추가된 'NoWhitespaceBeforeCaseDefaultColon' module에 문제가 있어 바로 하위 commit을 적용했다


다음 명령어로 실행할 수 있다

# checkstyleMain : production Java source files(프로덕션 코드)
./gradlew checkstyleMain
gradle checkstyleMain

# checkstyleTest : test Java source files(테스트 코드)
./gradlew checkstyleTest
gradle checkstyleTest

gradle에서 lint라는 하나의 task를 구성하여 프로덕션 코드와 테스트 코드를 묶어서 실행시킬 수 있다

task lint {
	dependsOn checkstyleMain, checkstyleTest
}

./gradlew lint

참고