detekt/detekt-intellij-plugin

IntelliJ IDEA Plugin: Add Suppression action

オープン

#143 opened on 2021/10/08

 (1 件のコメント) (8 件のリアクション) (0 人の担当者)Kotlin (38 件のフォーク)auto 404
featurehelp wanted

Repository metrics

Stars
 (318 個のスター)
PR merge metrics
 (PR metrics pending)

説明

Expected Behavior

Option in Alt+Enter to add @Suppress("RuleName") to the finding's entity.

Current Behavior

No actions on violations. image

Context

There are some cases when we just need to suppress a warning, because we deem the code is fine as is. In these cases the process is:

  • Looking at the HTML report on CI open the file in IDE
  • See the same Detekt violations show up
  • Find the name of the violation from either the report or the tooltip.
  • Edit the code to add @Suppress("RuleName") manually, this might involve typing the rule name.

I'm sure you all know how easy it is to suppress IDEA inspections. Alt-Enter, Right, Enter

image

Similarly the plugin could open the detekt.yml configuration file for editing at the minimum. The 5* experience would be to automatically add/edit the group: Rule: active: false when suppressing in whole project, but opening the file would be a good start.

コントリビューターガイド