Report book.toml parse error when invalid fields are found #1539

joshrotenberg · 2021-05-19T04:42:39Z

Prior to this change, any type errors parsing the book, rust or build sections of the book.toml would be silently ignored and the default for the given section would be used instead.

This change adds an explicit check when parsing the above sections, and if an error is encountered, the error is reported rather than using the default configuration. For example, if the value of language in [book] is a list rather than a string:

[book]
language = ["en", "pt-br"]
# ...

The result will be something like:

❯ mdbook build                         
2021-05-19 10:16:43 [ERROR] (mdbook::utils): Error: Invalid configuration file
2021-05-19 10:16:43 [ERROR] (mdbook::utils):    Caused By: invalid type: sequence, expected a string for key `language`

Fixes #1522.

check config for book parse errors add invalid_title_type handle build and rust config errors

ehuss

Thanks, this will be great to fix! I don't know why the original just ignored the errors.

src/config.rs

Co-authored-by: Eric Huss <eric@huss.org>

ehuss

Thanks!

report book.toml parse errors

78325aa

check config for book parse errors add invalid_title_type handle build and rust config errors

joshrotenberg force-pushed the report_config_errors branch from d5bab90 to 78325aa Compare May 19, 2021 16:33

joshrotenberg marked this pull request as ready for review May 19, 2021 17:19

ehuss reviewed May 24, 2021

View reviewed changes

src/config.rs Outdated Show resolved Hide resolved

joshrotenberg and others added 2 commits May 24, 2021 11:59

Update src/config.rs

7a35132

Co-authored-by: Eric Huss <eric@huss.org>

update build and rust config change

6b0b42e

ehuss approved these changes May 24, 2021

View reviewed changes

ehuss merged commit 3c2b8cd into rust-lang:master May 24, 2021

This was referenced May 24, 2021

update the mdBook Documentation for author to fix menu-title render #1118

Closed

Not Generating menu-title from title set in book.toml #596

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Report book.toml parse error when invalid fields are found #1539

Report book.toml parse error when invalid fields are found #1539

joshrotenberg commented May 19, 2021 •

edited

Loading

ehuss left a comment

ehuss left a comment

Report book.toml parse error when invalid fields are found #1539

Report book.toml parse error when invalid fields are found #1539

Conversation

joshrotenberg commented May 19, 2021 • edited Loading

ehuss left a comment

Choose a reason for hiding this comment

ehuss left a comment

Choose a reason for hiding this comment

joshrotenberg commented May 19, 2021 •

edited

Loading