feat(config): warn on unknown config keys in foundry.toml #10621
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zarkk01
requested review from
DaniPopes,
klkvr,
mattsse,
grandizzy,
yash-atreya and
zerosnacks
as code owners
mablr
suggested changes
May 30, 2025
| @@ -641,6 +643,23 @@ impl Config { | |||
| } | |||
|
|
|||
| fn from_figment(figment: Figment) -> Result<Self, ExtractConfigError> { | |||
| let file_path = Path::new("foundry.toml"); | |||
There was a problem hiding this comment.
It's a good practice to not use hardcoded paths, a FILE_NAME const is already defined in this module.
| @@ -641,6 +643,23 @@ impl Config { | |||
| } | |||
|
|
|||
| fn from_figment(figment: Figment) -> Result<Self, ExtractConfigError> { | |||
| let file_path = Path::new("foundry.toml"); | |||
| if let Ok(raw) = fs::read_to_string(&file_path) { | |||
There was a problem hiding this comment.
Clippy says there is a needless borrow here, so you can remove the & to pass the check.
| if !ignored.is_empty() { | ||
| warn!( | ||
| "Found unknown config keys in {}: {}", | ||
| file_path.display(), |
|
@zarkk01 this would be really good to have, wonder if you have time time to wrap up the work (accommodate comments and test to check warnings are emitted). thank you! |
Yes, I will wrap it up until the end of the week! :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Right now, if a user makes a typo or adds a deprecated field in their local
foundry.toml, Figment/Serde simply ignores it and the user never knows something went unused. That can lead to confusion or misconfiguration.Solution
Before Figment does
.extract()into theConfigstruct, we readfoundry.tomlas raw TOML, run it through [serde_ignored] to collect any unused/unknown keys, and if any are found we log awarn!listing them. This is non-breaking (we still load all the valid settings) and only affects root keys for now.About #10550 . For now, could I have some feedback on the implementation?
PR Checklist