탐지

Kotlin 프로그래밍 언어 용 정적 코드 분석 도구 인 detekt를 만나보세요 . 설치 가이드, 규칙 설명, 구성 옵션 등을 알아보려면 프로젝트 웹사이트를 방문하세요.

특징

Kotlin 프로젝트에 대한 코드 냄새 분석.
고도로 구성 가능한 규칙 세트.
새로운 문제가 발생하지 않도록 하면서 레거시 프로젝트의 기존 문제를 억제하는 기준선을 생성합니다.
@Suppress 주석을 사용하여 소스 파일의 문제를 억제합니다.
다양한 보고서 형식 지원: HTML, Markdown, SARIF, XML(Checkstyle) 및 사용자 정의 보고서.
사용자 정의 규칙 세트 및 보고서로 탐지 기능을 확장합니다.
코드 줄, 순환적 복잡성 및 코드 냄새 수를 기반으로 하는 복잡성 보고서입니다.
Gradle 플러그인을 사용하여 Gradle과 자사 통합.
탐지에 더 많은 규칙과 기능을 추가하는 타사 플러그인 커뮤니티입니다.

빠른 링크

변경 로그 및 마이그레이션 가이드
사용 가능한 CLI 옵션
규칙 세트 및 규칙 설명
사용자 정의 규칙 작성 및 탐지 확장
코드의 문제 억제
기준 파일을 통해 문제 억제
감지 구성
샘플 Gradle 통합 예:

멀티 프로젝트(Kotlin DSL)
단일 프로젝트(Groovy DSL)
단일 프로젝트(비공식 Maven 플러그인)

빠른 시작 ...

명령줄 인터페이스 사용

 컬 -sSLO https://github.com/detekt/detekt/releases/download/v[버전]/detekt-cli-[버전]-all.jar
java -jar detekt-cli-[버전]-all.jar --help

여기에서 decekt를 설치하는 다른 방법을 찾을 수 있습니다.

그래들과 함께

 플러그인 {
    id("io.gitlab.arturbosch.detekt") 버전 "[버전]"}

저장소 {
    메이븐센트럴()
}

감지 {
    buildUponDefaultConfig = true // defaultsallRules = false // 사용 가능한 모든(불안정한 경우에도) 활성화 rule.config.setFrom("$projectDir/config/detekt.yml") // 실행할 규칙을 정의하는 사용자 정의 구성을 가리키고 기본 동작 기준을 덮어씁니다. = file("$projectDir/config/baseline.xml") // 감지 기능을 도입하기 전에 문제를 억제하는 방법}

tasks.withType().configureEach {
    보고서 {
        html.required.set(true) // 구조 및 코드를 사용하여 브라우저에서 결과를 관찰합니다. snippetsxml.required.set(true) // 주로 Jenkinssarif.required.set(true)와 같은 통합을 위한 형식과 같은 체크스타일 // 표준화된 SARIF 형식( https://sarifweb.azurewebsites.net/) GitHub Code Scanningmd.required.set(true) // 간단한 Markdown 형식과의 통합을 지원합니다.}
}// Groovy DSLtasks.withType(Detekt).configureEach {
    jvmTarget = "1.8"}
Tasks.withType(DetektCreateBaselineTask).configureEach {
    jvmTarget = "1.8"}// 또는// Kotlin DSLtasks.withType().configureEach {
    jvmTarget = "1.8"}
tasks.withType().configureEach {
    jvmTarget = "1.8"}

릴리스는 Maven Central을, 스냅샷은 Sonatype을 참조하세요.

SNAPSHOT 버전을 사용하려면 이 설명서 페이지에서 자세한 정보를 찾을 수 있습니다.

요구사항

Gradle 6.8.3+가 최소 요구사항입니다. 그러나 다른 도구 권장 버전과 함께 권장되는 버전은 다음과 같습니다.

감지 버전	그래들	코틀린	AGP	Java 대상 레벨	JDK 최대 버전
`1.23.7`	`8.10`	`2.0.10`	`8.5.2`	`1.8`	`21`

이전 감지 버전에 대한 권장 버전 목록이 여기에 나열되어 있습니다.

더 많은 규칙 세트 추가

detekt 자체는 Gradle 구성에 쉽게 추가할 수 있는 formatting 규칙 세트로 ktlint에 대한 래퍼를 제공합니다.

 종속성 {
    detektPlugins("io.gitlab.arturbosch.detekt:detekt-formatting:[버전]")
}

마찬가지로, 감지에서 감지에 사용할 수 있는 추가 규칙 세트가 있습니다.

 종속성 {
    detektPlugins("io.gitlab.arturbosch.detekt:detekt-rules-libraries:[버전]")
    detektPlugins("io.gitlab.arturbosch.detekt:detekt-rules-ruleauthors:[버전]")
}

더 많은 정보를 원하시면 Detekt Marketplace를 방문하세요.

마찬가지로 사용자 정의 확장을 tekt에 추가할 수 있습니다.