detekt/detekt-intellij-plugin

IntelliJ IDEA Plugin: Add Suppression action

Open

#143 opened on Oct 8, 2021

View on GitHub
 (1 comment) (8 reactions) (0 assignees)Kotlin (38 forks)auto 404
featurehelp wanted

Repository metrics

Stars
 (318 stars)
PR merge metrics
 (PR metrics pending)

Description

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.

Contributor guide

Research direction
Look into IntelliJ's intention action API (PsiElementBaseIntentionAction or LocalQuickFix) to add a new action that inserts @Suppress("RuleName") at the violation location. Also explore opening the detekt.yml config file via OpenFileDescriptor or similar.
Tech stack
kotlin
Domain
devtoolsdeveloper experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
IntelliJ plugin developmentKotlin
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65