ndmitchell/hlint

`within` changes the behavior of `modules: {as: }`

Open

#1.615 geöffnet am 6. Sept. 2024

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Haskell (208 Forks)batch import
good first issue

Repository-Metriken

Stars
 (1.594 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

We want to gradually become consistent with our naming of Data.List.NonEmpty, so we create an hlint rule:

- modules:
    - name: [Data.List.NonEmpty] 
      as: NE

I run hlint on our codebase to get all the currently failing examples, and I create a within to ignore them:

- modules:
    - name: [Data.List.NonEmpty] 
      as: NE
      within: [ ... ]

But now it starts complaining about importing Data.List.NonEmpty at all. It seems like within is causing it to ignore the as: key.

Contributor Guide

Research-Richtung
Untersuche die Interaktion zwischen den Schlüsseln `within` und `as` bei der Modulregelanalyse von hlint. Sieh dir den Quellcode an, der die Konfiguration verarbeitet (wahrscheinlich in Dateien wie `src/Hint/Module.hs` oder ähnlichen). Das Problem deutet darauf hin, dass das Anwenden einer `within` Liste dazu führt, dass der `as` Schlüssel ignoriert wird, sodass die Parsing Logik, die Filter für `within` anwendet, die `as` Zuordnung möglicherweise überschreibt oder überspringt. Überprüfe, wie die Modulregeln transformiert werden, wenn `within` vorhanden ist, und stelle sicher, dass der `as` Alias erhalten bleibt.
Tech Stack
Keine
Domain
tooling
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
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
Understanding of hlint configurationBasic Haskell knowledge
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40