Skip to content

warn on invalid fields in the root of book.toml #2622

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 3, 2025
Merged

warn on invalid fields in the root of book.toml #2622

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1bc2ebd
warn on invalid fields in root of book.toml
szabgab Mar 28, 2025
97f1948
Make the unexpected case explicit that it is an internal error
ehuss Apr 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions src/config.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,6 +312,8 @@ impl<'de> serde::Deserialize<'de> for Config {
return Ok(Config::from_legacy(raw));
}

warn_on_invalid_fields(&raw);

use serde::de::Error;
let mut table = match raw {
Value::Table(t) => t,
Expand Down Expand Up @@ -376,6 +378,17 @@ fn parse_env(key: &str) -> Option<String> {
.map(|key| key.to_lowercase().replace("__", ".").replace('_', "-"))
}

fn warn_on_invalid_fields(table: &Value) {
let valid_items = ["book", "build", "rust", "output", "preprocessor"];

let table = table.as_table().expect("root must be a table");
for item in table.keys() {
if !valid_items.contains(&item.as_str()) {
warn!("Invalid field {:?} in book.toml", &item);
}
}
}

fn is_legacy_format(table: &Value) -> bool {
let legacy_items = [
"title",
Expand Down