mirror of
https://github.com/jlengrand/detekt.git
synced 2026-03-10 08:11:23 +00:00
3b7cae17b6
* Support markdown report in Gradle plugin * Add markdown description to website docs * Improve markdown description for website docs
184 lines
10 KiB
Markdown
184 lines
10 KiB
Markdown
# detekt
|
|
|
|
[](https://kotlinlang.slack.com/archives/C88E12QH4)
|
|
[](https://detekt.dev/)
|
|
[](https://search.maven.org/artifact/io.gitlab.arturbosch.detekt/detekt-cli)
|
|
[](https://plugins.gradle.org/plugin/io.gitlab.arturbosch.detekt)
|
|
|
|
|
|
[](https://codecov.io/gh/detekt/detekt)
|
|
[](https://github.com/KotlinBy/awesome-kotlin)
|
|
[](https://app.fossa.com/projects/custom%2B25591%2Fgithub.com%2Fdetekt%2Fdetekt?ref=badge_small)
|
|
|
|
Meet _detekt_, a static code analysis tool for the [_Kotlin_ programming language](https://kotlinlang.org/).
|
|
Visit [the project website](https://detekt.dev/) for installation guides, rule descriptions, configuration options and more.
|
|
|
|
|
|
|
|
### Features
|
|
|
|
- Code smell analysis for your [Kotlin projects](https://kotlinlang.org/).
|
|
- Highly configurable rule sets.
|
|
- Code Smell baseline and suppression for legacy projects.
|
|
- Suppression of findings with `@Suppress` annotations.
|
|
- Support for different report formats: html, markdown, [SARIF](https://sarifweb.azurewebsites.net/) and xml (checkstyle). Is it not enough? You can extend detekt and create your own reports.
|
|
- Extensibility by enabling incorporation of personal rule sets, `FileProcessListener's` and `OutputReport's`.
|
|
- Complexity reports based on lines of code, cyclomatic complexity and number of code smells.
|
|
- First party integration with Gradle with our [Gradle plugin](#with-gradle).
|
|
- A community of [third party plugins](https://github.com/topics/detekt-plugin) that adds more rules and features to detekt.
|
|
|
|
#### Quick-Links
|
|
|
|
- [Changelog and migration guides](https://detekt.dev/changelog.html)
|
|
- [Available CLI options](https://detekt.dev/cli.html)
|
|
- [Rule set and rule descriptions](https://detekt.dev/complexity.html)
|
|
- [Writing custom rules and extending detekt](https://detekt.dev/extensions.html)
|
|
- [Suppressing issues in code](https://detekt.dev/suppressing-rules.html)
|
|
- [Suppressing issues via baseline file](https://detekt.dev/baseline.html)
|
|
- [Configuring detekt](https://detekt.dev/configurations.html)
|
|
- Sample Gradle integrations examples:
|
|
- [multi project (Kotlin DSL)](https://github.com/detekt/detekt/blob/main/build.gradle.kts)
|
|
- [single project (Groovy DSL)](https://github.com/arturbosch/kutils/blob/master/build.gradle)
|
|
- [single project (Unofficial Maven plugin)](https://github.com/detekt/sonar-kotlin/blob/main/pom.xml)
|
|
|
|
### Quick Start ...
|
|
|
|
#### with the command-line interface
|
|
|
|
```sh
|
|
curl -sSLO https://github.com/detekt/detekt/releases/download/v[version]/detekt-cli-[version]-all.jar
|
|
java -jar detekt-cli-[version]-all.jar --help
|
|
```
|
|
|
|
You can find [other ways to install detekt here](https://detekt.dev/cli.html)
|
|
|
|
#### with Gradle
|
|
|
|
```kotlin
|
|
plugins {
|
|
id("io.gitlab.arturbosch.detekt").version("[version]")
|
|
}
|
|
|
|
repositories {
|
|
mavenCentral()
|
|
}
|
|
|
|
detekt {
|
|
buildUponDefaultConfig = true // preconfigure defaults
|
|
allRules = false // activate all available (even unstable) rules.
|
|
config = files("$projectDir/config/detekt.yml") // point to your custom config defining rules to run, overwriting default behavior
|
|
baseline = file("$projectDir/config/baseline.xml") // a way of suppressing issues before introducing detekt
|
|
}
|
|
|
|
tasks.withType<Detekt>().configureEach {
|
|
reports {
|
|
html.required.set(true) // observe findings in your browser with structure and code snippets
|
|
xml.required.set(true) // checkstyle like format mainly for integrations like Jenkins
|
|
txt.required.set(true) // similar to the console output, contains issue signature to manually edit baseline files
|
|
sarif.required.set(true) // standardized SARIF format (https://sarifweb.azurewebsites.net/) to support integrations with Github Code Scanning
|
|
md.required.set(true) // simple Markdown format
|
|
}
|
|
}
|
|
|
|
// Groovy DSL
|
|
tasks.withType(Detekt).configureEach {
|
|
jvmTarget = "1.8"
|
|
}
|
|
tasks.withType(DetektCreateBaselineTask).configureEach {
|
|
jvmTarget = "1.8"
|
|
}
|
|
|
|
// or
|
|
|
|
// Kotlin DSL
|
|
tasks.withType<Detekt>().configureEach {
|
|
jvmTarget = "1.8"
|
|
}
|
|
tasks.withType<DetektCreateBaselineTask>().configureEach {
|
|
jvmTarget = "1.8"
|
|
}
|
|
```
|
|
|
|
See [maven central](https://search.maven.org/artifact/io.gitlab.arturbosch.detekt/detekt-cli) for releases and [sonatype](https://oss.sonatype.org/#view-repositories;snapshots~browsestorage~io/gitlab/arturbosch/detekt) for snapshots.
|
|
|
|
If you want to use a SNAPSHOT version, you can find more info on [this documentation page](https://detekt.dev/snapshots.html).
|
|
|
|
#### Requirements
|
|
|
|
Gradle 6.1+ is the minimum requirement. However, the recommended versions together with the other tools recommended versions are:
|
|
|
|
| Detekt Version | Gradle | Kotlin | AGP | Java Target Level | JDK Max Version |
|
|
| -------------- | ------- | -------- | ------- | ----------------- | --------------- |
|
|
| `1.20.0` | `7.4.2` | `1.6.20` | `7.1.3` | `1.8` | `17` |
|
|
|
|
The list of [recommended versions for previous detekt version is listed here](https://detekt.dev/compatibility.html).
|
|
|
|
### Adding more rule sets
|
|
|
|
detekt itself provides a wrapper over [ktlint](https://github.com/pinterest/ktlint) as the `formatting` rule set
|
|
which can be easily added to the Gradle configuration:
|
|
|
|
```kotlin
|
|
dependencies {
|
|
detektPlugins("io.gitlab.arturbosch.detekt:detekt-formatting:[version]")
|
|
}
|
|
```
|
|
|
|
Likewise custom [extensions](https://detekt.dev/extensions.html) can be added to detekt.
|
|
|
|
### Contributing
|
|
|
|
See [CONTRIBUTING](.github/CONTRIBUTING.md)
|
|
|
|
Thanks to all the people who contributed to detekt!
|
|
|
|
<a href="https://github.com/detekt/detekt/graphs/contributors">
|
|
<img src="https://contrib.rocks/image?repo=detekt/detekt" />
|
|
</a>
|
|
|
|
### Mentions
|
|
|
|
[](http://androidweekly.net/issues/issue-259)
|
|
[](http://androidweekly.cn/android-dev-wekly-issue-154/)
|
|
|
|
As mentioned in...
|
|
|
|
- [driodcon London 2021 - Detekt - State of the Union](https://www.droidcon.com/2021/11/17/detekt-state-of-the-union-2/)
|
|
- [KotlinConf 2018 - Safe(r) Kotlin Code - Static Analysis Tools for Kotlin by Marvin Ramin](https://www.youtube.com/watch?v=yjhQiP0329M)
|
|
- [droidcon NYC 2018 - Static Code Analysis For Kotlin](https://www.youtube.com/watch?v=LT6m5_LO2DQ)
|
|
- Kotlin on Code Quality Tools - by @vanniktech [Slides](https://docs.google.com/presentation/d/1sUoQCRHTR01JfaS67Qkd7K1rdRLOhO6QGCelZZwxOKs/edit) [Presentation](https://www.youtube.com/watch?v=FKDNE6PPTTE)
|
|
- [Integrating detekt in the Workflow](https://www.raywenderlich.com/24470020-integrating-detekt-in-the-workflow)
|
|
- [Check the quality of Kotlin code](https://blog.frankel.ch/check-quality-kotlin-code/)
|
|
- [Kotlin Static Analysis Tools](http://smyachenkov.com/posts/kotlin-static-analysis-tools/)
|
|
- [Are you still smelling it?: A comparative study between Java and Kotlin language](https://doi.org/10.1145/3267183.3267186) by [Flauzino et al.](https://github.com/matheusflauzino/smells-experiment-Kotlin-and-Java)
|
|
- [Preventing software antipatterns with Detekt](https://galler.dev/preventing-software-antipatterns-with-detekt/)
|
|
|
|
Integrations:
|
|
|
|
- [IntelliJ integration](https://github.com/detekt/detekt-intellij-plugin)
|
|
- [SonarQube integration](https://github.com/detekt/sonar-kotlin)
|
|
- [Codacy](https://www.codacy.com)
|
|
- [Gradle plugin that configures Error Prone, Checkstyle, PMD, CPD, Lint, Detekt & Ktlint](https://github.com/vanniktech/gradle-code-quality-tools-plugin)
|
|
- [Violations Lib](https://github.com/tomasbjerre/violations-lib) is a Java library for parsing report files like static code analysis.
|
|
- [sputnik](https://github.com/TouK/sputnik) is a free tool for static code review and provides support for detekt
|
|
- [Gradle Static Analysis plugin](https://github.com/GradleUp/static-analysis-plugin)
|
|
- [Detekt Maven plugin](https://github.com/Ozsie/detekt-maven-plugin) that wraps the Detekt CLI
|
|
- [Detekt Bazel plugin](https://github.com/buildfoundation/bazel_rules_detekt) that wraps the Detekt CLI
|
|
- [Gradle plugin that helps facilitate GitHub PR checking and automatic commenting of violations](https://github.com/btkelly/gnag)
|
|
- [Codefactor](http://codefactor.io/)
|
|
- [GitHub Action: Detekt All](https://github.com/marketplace/actions/detekt-all)
|
|
- [GitHub Action: Setup detekt](https://github.com/marketplace/actions/setup-detekt)
|
|
- [Sonatype Lift](https://github.com/marketplace/muse-dev)
|
|
|
|
Custom rules and reports from 3rd parties:
|
|
|
|
- [detekt-verify-implementation](https://github.com/cph-cachet/detekt-verify-implementation) by cph-cachet
|
|
- [detekt-hint](https://github.com/mkohm/detekt-hint) by mkohm is a plugin to detekt that provides detection of design principle violations through integration with Danger
|
|
- [GitLab report format](https://gitlab.com/cromefire_/detekt-gitlab-report)
|
|
- There are more third-party plugins out there. You can find some of them [in this list](https://github.com/topics/detekt-plugin).
|
|
|
|
#### Credits
|
|
|
|
- [JetBrains](https://github.com/jetbrains/) - Creating IntelliJ + Kotlin
|
|
- [PMD](https://github.com/pmd/pmd) & [Checkstyle](https://github.com/checkstyle/checkstyle) & [ktlint](https://github.com/pinterest/ktlint) - Ideas for threshold values and style rules
|