ndmitchell/hlint

Support `include` directives

Open

#1,632 opened on 2025年1月24日

GitHub で見る
 (3 comments) (0 reactions) (0 assignees)Haskell (1,594 stars) (208 forks)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
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
3-5 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.