이 문서는 SonarQube 메인 메뉴 중 Rules 메뉴에 대한 가이드를 공유하기 위해 작성되었다.
| 도구명 | SonarQube CE |
|---|---|
| 버전 | 9.4 |
SonarQube Rules 메인화면
Rules 메인화면
SonarQube 에서 지원하는 모든 Rule을 목록으로 표시한다.
- 설치된 SonarQube에서 지원하는 기본 Rule과 플러그인을 설치하여 추가된 Rule까지 모두 표시됨
각 화면 및 기능 요약 설명
- 필터 기능으로 다음 항목별로 필터하여 목록에 표시
- 필터시 생기는 Clear 또는 Clear All Filters 버튼으로 필터 초기화 가능
- Search for rules : Rule 이름에 대하여 검색 지원
- Languages : 개발 언어별 검색 및 필터 지원 (SonarQube 버전 및 라이선스에 따라 다를 수 있음)
- Type : Rule 타입별 필터 지원
- Tag : Rule에 매핑된 태그 별 검색 및 필터 지원
Repository : 해당 Rule을 지원하는 저장소(일종의 RuleSet)별 검색 및 필터 지원
SonarQube 기본 지원 외 플러그인 설치로 생성된 저장소까지 표시
- Default Severity : Rule에 설정된 기본(Default) 심각도별 필터 지원
- Status : Rule 상태별 필터 지원
- Ready : 프로덕션에 사용 가능 | Beta : 최근에 구현된 베타 버전으로 피드백이 충분하지 않음 | Deprecated : 더 이상 사용되지 않음
Security Category : 보안 이슈 카테고리별 필터 지원
SonarSource 에서 분류한 카테고리 외 공신력 있는 OWASP, SANS, CWE 카테고리도 지원
- Available Since : 사용 가능 시작 날짜로 필터 지원
- Template : Rule Custom Rule 생성을 위한 Rule 템플릿의 표시여부 필터 지원
- Quality Profile : Quality Profile 별 필터 지원
- Inheritance / Activation Severity : Quality Profile 필터를 선택할 경우 활성화 되는 항목으로 해당 Quality Profile의 Rule 상속 여부와 활성화된 심각도 필터 지원
Quality Profile(에 포함된 Rule) 활성화 여부 일괄 처리 기능 제공
- 기본 제공되는 Quality Profile 제외되어, 사용자가 임의 생성(Create) / 복제(Clone) / 확장(Extend) 한 Quality Profile이 있을 때만 Bulk Change 버튼 활성화 됨
Bulk Change 버튼 클릭시 다음과 같이 일괄 활성화 / 비활성화 메뉴 제공됨
각 버튼 클릭시 다음과 같이 기본 제공되는 것 외 사용자가 추가한 Quality Profile이 목록에 표시되고, 다중 선택하여 일괄 활성화 / 비활성화 처리 가능
키보드 방향키를 사용하여 Rule 목록 커서 위치 변경 기능 제공 및 현재 선택된 Rule 번호 및 전체 Rule 개수 표시
- 위 아래 방향키로 커서 위치 변경
- 좌 우 방향키로 해당 Rule 상세 정보 화면 진입 및 목록 복귀 가능
- 모든 Rule 또는 필터한 Rule 목록에 표시
다음 그림 각 항목별 상세 설명
- Rule 요약 : 클릭시 상세화면으로 진입
- Rule의 개발언어 / 심각도 / 태그
- Similar Filter 기능 : 해당 Rule의 특성과 유사한 Rule 필터 기능 제공
- Rule 클릭시 상세 화면
- Rule 요약 / 상세설명 / 미준수 코드 예제 / 솔루션 표시
- 해당 Rule을 사용하는 Quality Profiles 표시
- 해당 Rule에 검출된 Issue 목록 표시
1 개의 댓글
윤준호 책임
SonarSource Code Analyzers Rules Explorer