Skip to content

mzyKi/detekt-intellij-plugin

 
 

Repository files navigation

IntelliJ Detekt Plugin

Join the chat at https://kotlinlang.slack.com/messages/C88E12QH4/convo/C0BQ5GZ0S-1511956674.000289/ Pre Merge Checks FOSSA Status

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

  • Settings -> Plugins -> Marketplace -> Search for Detekt -> Install
  • Configure the plugin via Settings -> Tools -> Detekt

Configuration Options

detekt in action

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

Also install the current Detekt IntelliJ plugin version to verify you do not introduce new issues.

License

FOSSA Status

Releases

No releases published

Packages

No packages published

Languages

  • Kotlin 100.0%