[android] checkstyle 설치및 gen 폴더 제거 설정

android에서 checkstyle을 적용하려고 설치하고 적용하다가 몇가지 유용한 것을 발견 하였다.

1. 설치하기

eclipse에서 Help->Install New Software.. 에서 아래를 설정하면 간략하게 local 환경에 설치할수 있다.

http://eclipse-cs.sf.net/update

 

2. checkstyle violations View

메뉴에서 “Window -> Show View -> Others -> checkstyle을 선택한뒤 “checkstyle violoations”를 클릭하면 보인다.  ( 참고로 checkstyle violation char 를 선택하면 차트로 볼 수도 있다. )

그런데 project가 많은경우 보기가 복잡하므로 내가 선택한 project의 위반사항만 보도록 설정한다.  아래 그림의 빨간 버튼을 누르면 환경설정창이 하나 뜬다.  

 

본인은  “on any resource in same project”를 선택하였다.

 

3. gen 폴더 제외 하기

Package explorer에서 원하는 project를 선택한 다음, 마우스 오른쪽버튼을 클릭해서

Checkstyle -> check code with checkstyle을 실행하면 checkstyle을 위반하는 것을 보여준다.

 

이런..  gen 폴더에서 무수히 많은 violations이 발생한다.  android에서 생성하는 gen 폴더는 checkstyle 에서 제외시켜야 한다.

Project의 환경설정에서 “files from packages” 을 check 하고 오늘쪽의  “change” 버튼을 눌러서 제외할 package를 선택하면 된다.

 

 

이 설정을 하고 나면 project 폴더에 .checkstyle 이라는 파일이 생긴다.

내용은 xml 이라서 직감적으로 알 수 있다.

<?xml version="1.0" encoding="UTF-8"?> 

<fileset-config file-format-version="1.2.0" simple-config="true" sync-formatter="false">

  <fileset name="all" enabled="true" check-config-name="My Checks" local="false">

    <file-match-pattern match-pattern="." include-pattern="true"/>

  </fileset>

  <filter name="FilesFromPackage" enabled="true">

    <filter-data value="gen"/>

  </filter>

</fileset-config>