ndmitchell/hlint

Support `include` directives

Open

#1,632 opened on Jan 24, 2025

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

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

Tech stack
None
Domain
developer experiencetooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
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.
mostly clear
Prerequisites
Haskell programmingfamiliarity with hlintYAML basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Investigate how hlint currently parses and applies YAML configuration files (likely in src/). Explore the Data.Yaml.Include API from the yaml package to understand how include directives are handled. Check if there are any existing issues or comments discussing parsing modifications. Consider adding include support by recursively resolving YAML files before processing rules, following the pattern used by the yaml package itself.
Support `include` directives · ndmitchell/hlint#1632 | Good First Issue