saveourtool/diktat

`FILE_UNORDERED_IMPORTS` error message doesn't match the style guide

Open

#1.933 geöffnet am 19. Juni 2024

Auf GitHub ansehen
 (1 Kommentar) (1 Reaktion) (0 zugewiesene Personen)Kotlin (40 Forks)github user discovery
buggood first issue

Repository-Metriken

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

Beschreibung

Describe the bug

When there is a violation on imports, the error message doesn't match Diktat style guide. The message says:

[FILE_UNORDERED_IMPORTS] imports should be ordered alphabetically and shouldn't be separated by newlines: import [...] (diktat-ruleset:file-structure)

while the corresponding style rule says:

From top to bottom, the order is the following:

  1. Android
  2. Imports of packages used internally in your organization
  3. Imports from other non-core dependencies
  4. Java core packages
  5. kotlin stdlib

Each category should be alphabetically arranged. Each group should be separated by a blank line.

In fact, running gradle diktatFix formats the code according to the convention above.

Expected behavior

The error message should match the style guide

Steps to Reproduce

  1. shuffle import declarations or remove blank lines between groups
  2. run gradle diktatCheck

Environment information

  • diktat version: 2.0.0
  • build tool (maven/gradle): gradle
  • how is diktat run (CLI, plugin, etc.): plugin
  • kotlin version: 1.9.24
  • operating system: MacOS

Contributor Guide

Research-Richtung
Finden Sie die Quelldatei mit der Fehlermeldung für FILE UNORDERED IMPORTS und aktualisieren Sie den Text, um die Beschreibung des Styleguides zu Kategorien und Leerzeilen widerzuspiegeln.
Tech Stack
kotlin
Domain
devtools
Issue Type
Fehler
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
KotlinGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65