페이지 이력

이 문서는  소나큐브(SonarQube) 에서 커스텀 룰(Custom Rule)을 생성하는 가이드를 공유하기 위해 작성되었다.

...

커스텀 룰 생성(Java)

책갈피
생성 생성

커스텀 룰을 생성하기 위해 플러그인에서 제공하는 규칙 템플릿을 사용한다.

...

• Name(필수) : 규칙 이름
• Key (필수): 키 (규칙 이름 입력 시 자동 제안)
• Category : 클린 코드카테고리
• Attribute : 클린 코드속성
• Software Quality (필수): 소프트웨어 품질
• Severity (필수): 심각도
• Status : 규칙 상태
• Description(필수) : "Why is this an issue?"에 대한 설명
• 템플릿에 의해 지정된 정보

생성된 커스텀 룰을 클릭하여 세부 정보를 확인할 수 있다.

품질 프로필에서 커스텀 룰 활성화

책갈피
품질프로필 품질프로필

커스텀 룰을 사용할 품질 프로필(Quality Profile)을 추가한다.

커스텀 룰 세부 정보 페이지 > Quality Profiles > "Activate" 버튼 클릭

...

• Quality Profile : 생성한 룰을 추가할 품질 프로필 
• Severity : 심각도(deprcated)

[선택] 품질 프로필(Quality Profiles) 생성

...

[선택] sonar-checkstyle 플러그인 설치

책갈피
checkstyle checkstyle

Checkstyle은 코딩 표준을 준수하는 Java 코드를 작성하는 데 도움이 되는 개발 도구로서 SonarQube에서 코드 포맷이나 레이아웃 등에 대한 다양한 템플릿을 제공한다.

• 자동 설치(커뮤니티 버전)

          1. Administration > Marketplace에서 "checkstyle" 검색 후 install 버튼 클릭

...

           1. Releases · checkstyle/checkstyle (github.com)에서 SonarQube 버전과 호환되는 버전의 jar파일을 다운로드 받는다.
           2. <SONARQUBE_HOME>/extensions/plugins경로에 다운로드 받은 파일을 넣고 SonarQube 서버를 재시작한다.

예시 - 정규식 표현으로 검사하는 커스텀 룰 생성

...