haskell/hie-bios

Turn unknown fields in `hie.yaml` into warnings

Open

#344 opened on Apr 13, 2022

View on GitHub
 (1 comment) (1 reaction) (0 assignees)Haskell (70 forks)auto 404
ZuriHacgood first issue

Repository metrics

Stars
 (198 stars)
PR merge metrics
 (PR metrics pending)

Description

Until now, we threw an error message. The point being that you notice you didn't write the correct configuration and something is not right.

This will make it hard to introduce new optional keys, because older HLS versions will now choke on that config.

I think a warning is better. cabal-install also does this:

$ cabal build
Warning: /home/hasufell/git/stack2cabal/cabal.project: Unrecognized field
'foo' on line 11

Originally posted by @hasufell in https://github.com/haskell/hie-bios/issues/329#issuecomment-1061085723

Contributor guide

Research direction
Inspect the hie.yaml configuration parsing code. Locate the part that validates unknown fields and currently raises an error. Modify it to issue a warning instead. Ensure existing tests are updated to match the new behavior.
Tech stack
haskell
Domain
toolingdeveloper experience
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.
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
GitHaskell
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75