matercan/beer
1
0
Fork 0
forked from NotAShelf/beer
Code Pull requests 1 Activity

config: warn on unknown keys instead of dropping them silently

Browse source 
Signed-off-by: NotAShelf <raf@notashelf.dev>
Change-Id: Id06a7e2c96cfdcb69a21fa0416d988696a6a6964
This commit is contained in:
raf 2026-06-26 10:27:40 +03:00
commit 27a509362b
No known key found for this signature in database
GPG key ID: 29D95B64378DB4BF
3 changed files with 57 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

56
src/config.rs
View file

@ -195,19 +195,32 @@ impl Config {
if !path.exists() {
return Self::default();
}
match std::fs::read_to_string(&path) {
Ok(text) => match toml::from_str(&text) {
Ok(config) => {
tracing::info!("loaded config from {}", path.display());
config
}
Err(err) => {
tracing::warn!("config {}: {err}; using defaults", path.display());
Self::default()
}
},
let text = match std::fs::read_to_string(&path) {
Ok(text) => text,
Err(err) => {
tracing::warn!("read config {}: {err}; using defaults", path.display());
return Self::default();
}
};
// Deserialize through serde_ignored so a typo'd key (`font-sze`) is
// reported instead of silently dropped, while still loading: unknown
// keys stay tolerated, keeping forward-compatibility with newer configs.
let de = match toml::Deserializer::parse(&text) {
Ok(de) => de,
Err(err) => {
tracing::warn!("config {}: {err}; using defaults", path.display());
return Self::default();
}
};
match serde_ignored::deserialize(de, |key| {
tracing::warn!("config {}: unknown key `{key}` ignored", path.display());
}) {
Ok(config) => {
tracing::info!("loaded config from {}", path.display());
config
}
Err(err) => {
tracing::warn!("config {}: {err}; using defaults", path.display());
Self::default()
}
}
@ -253,4 +266,25 @@ mod tests {
assert_eq!(c.main.term, "beer");
assert_eq!(c.scrollback.lines, 10_000);
}
#[test]
fn unknown_keys_are_reported_but_still_load() {
let toml = r##"
[main]
font-sze = 14
font = "JetBrains Mono"
[made-up]
x = 1
"##;
let mut unknown = Vec::new();
let de = toml::Deserializer::parse(toml).unwrap();
let c: Config =
serde_ignored::deserialize(de, |key| unknown.push(key.to_string())).unwrap();
// The typo and the bogus table are both surfaced...
assert!(unknown.iter().any(|k| k == "main.font-sze"), "{unknown:?}");
assert!(unknown.iter().any(|k| k == "made-up"), "{unknown:?}");
// ...yet the valid key still loaded.
assert_eq!(c.main.font, "JetBrains Mono");
}
}