saveourtool/diktat

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

Open

#1.628 geöffnet am 16. März 2023

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (1 zugewiesene Person)Kotlin (40 Forks)github user discovery
enhancementgood first issue

Repository-Metriken

Stars
 (571 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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-Richtung
Implementieren Sie konfigurierbare Aliase in diktat analysis.yml für Unterdrückungsprüfungen, indem Sie das Regelkonfigurationsmodell ändern, um eine 'aliases' Liste pro Regel zu akzeptieren.
Tech Stack
kotlin
Domain
devtools
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
KotlinYAML
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70