ndmitchell/hlint

Support `include` directives

Open

#1,632 opened on Jan 24, 2025

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

The yaml package has a Data.Yaml.Include API which allows you to use include directives to reference other files.

We want to use this to allow us to have an hlint-rules directory, and different teams can own their own hlint rules via CODEOWNERS. This way, they can be in charge of their own rules, and any modification or exclusion of those rules would trigger review for the relevant team.

Contributor guide

Research direction
Examine the Data.Yaml.Include API and implement support for include directives in hlint configuration files.
Tech stack
haskell
Domain
tooling
Issue type
Feature
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.
Half day
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
Haskell
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65