ndmitchell/hlint

Support `include` directives

Open

#1,632 创建于 2025年1月24日

在 GitHub 查看
 (3 评论) (0 反应) (0 负责人)Haskell (1,594 star) (208 fork)batch import
good first issue

描述

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.

贡献者指南

技术栈
无
领域
developer experiencetooling
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
3-5 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
active
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
Haskell programmingfamiliarity with hlintYAML basics
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
35
研究方向
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.