saveourtool/diktat

The literals used to `@Suppress` Diktat checks should be configurable via `diktat-analysis.yml`

Open

#1,628 opened on Mar 16, 2023

View on GitHub
 (0 comments) (0 reactions) (1 assignee)Kotlin (40 forks)github user discovery
enhancementgood first issue

Repository metrics

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

Description

The literals used to @Suppress Diktat checks should be configurable via diktat-analysis.yml, e.g.:

- name: MAGIC_NUMBER
  aliases: [ MagicNumber ]
  enabled: true

Then the following code should trigger no warnings:

@Suppress("MagicNumber")
fun f() {
    g(42)
}

Environment information

  • diktat version: 1.2.4.2

Related

  • #1627
  • #1530

@nulls, @petertrr, feel free to comment.

Contributor guide

Research direction
Implement configurable aliases in diktat analysis.yml for suppression checks, modifying the rule configuration model to accept an 'aliases' list per rule.
Tech stack
kotlin
Domain
devtools
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
KotlinYAML
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70