Skip to content

os97673/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 JetBrains Plugins FOSSA Status License

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

detekt in action

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

Help testing beta releases

  • Settings -> Plugins -> Manage Plugin Repositories
  • Add https://plugins.jetbrains.com/plugins/beta/list (check for trailing spaces!)
  • Help test .beta.x releases and report bugs

Configuration Options

configuration

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

Autocorrection

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.

About

detekt plugin for IntelliJ

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Kotlin 100.0%