検出する

Kotlinプログラミング言語の静的コード分析ツールであるdetekt を紹介します。インストールガイド、ルールの説明、構成オプションなどについては、プロジェクトの Web サイトにアクセスしてください。

特徴

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

ここでdetektをインストールする他の方法を見つけることができます

グラドルと

プラグイン {
    id("io.gitlab.arturbosch.detekt") バージョン "[バージョン]"}

リポジトリ {
    mavenCentral()
}

検出する{
    buildUponDefaultConfig = true // 事前設定のdefaultsallRules = false // 利用可能なすべての（不安定なものも含む）をアクティブ化します rules.config.setFrom("$projectDir/config/detekt.yml") // 実行するルールを定義するカスタム設定をポイントし、デフォルトの動作ベースラインを上書きします= file("$projectDir/config/baseline.xml") // 検出を導入する前に問題を抑制する方法}

task.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) // 単純なマークダウン形式}
}// Groovy DSLtasks.withType(Detekt).configureEach {
    jvmTarget = "1.8"}
task.withType(DetektCreateBaselineTask).configureEach {
    jvmTarget = "1.8"}// または// Kotlin DSLtasks.withType().configureEach {
    jvmTarget = "1.8"}
task.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 マーケットプレイスをご覧ください。

同様に、カスタム拡張機能を検出に追加できます。