ndmitchell/hlint

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

Open

#1,615 opened on Sep 6, 2024

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Haskell (208 forks)batch import
good first issue

Repository metrics

Stars
 (1,594 stars)
PR merge metrics
 (No merged PRs in 30d)

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.

Contributor guide

Research direction
Trace the implementation of the `within` directive in hlint's configuration parser to understand how it interacts with the `as` key.
Tech stack
haskell
Domain
tooling
Issue type
Bug
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
Haskellhlint basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45