ndmitchell/hlint

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

Open

#1 615 ouverte le 6 sept. 2024

Voir sur GitHub
 (3 commentaires) (0 réactions) (0 assignés)Haskell (208 forks)batch import
good first issue

Métriques du dépôt

Stars
 (1 594 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

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.

Guide contributeur

Direction de recherche
Étudiez l'interaction entre les clés `within` et `as` dans l'analyse des règles de module de hlint. Examinez le code source qui gère la configuration (probablement dans des fichiers comme `src/Hint/Module.hs` ou similaires). Le problème suggère que l'application d'une liste `within` entraîne l'ignorance de la clé `as`, donc la logique d'analyse qui applique les filtres pour `within` peut écraser ou ignorer le mappage `as`. Vérifiez comment les règles de module sont transformées lorsque `within` est présent et assurez vous que l'alias `as` est préservé.
Stack technique
Aucun
Domaine
tooling
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Understanding of hlint configurationBasic Haskell knowledge
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40