IntelliJ Detekt Plugin

Integrates detekt, a static code analysis tool for the Kotlin programming language, into IntelliJ.

The plugin can be downloaded from the Jetbrains plugin repository.

Enabling the plugin

• Install the plugin
• Navigate to Settings/Preferences -> Tools -> Detekt
• Check Enable Detekt

Customization

• Configuration file: Path to custom detekt.yml config file (optional)
• Baseline file: Path to custom baseline.xml file (optional)
• Plugin jars: Path to jar file that has the 'custom rules', if you want them to be reported as well (optional)

That's it. Detekt issues will be annotated on-the-fly while coding.

Auto correction

You may optionally click Refactor -> AutoCorrect by Detekt rules to auto correct detekt violations if possible.

Building / developing the plugin

For building the project, the Gradle IntelliJ plugin is used.

# linux & macOS
./gradlew buildPlugin
# windows
gradlew buildPlugin

To test your development, use task runIde which will automatically run an Intellij instance to test your new version of detekt plugin.

# linux & macOS
./gradlew runIde
# windows
gradlew runIde

License