fix: fail build on invalid HTML renderer config#3097
Closed
leno23 wants to merge 1 commit into
Closed
Conversation
Propagate deserialization errors from `Config::html_config()` instead of logging and returning `None`, so unknown `[output.html]` keys cause the build to fail. Fixes rust-lang#2984. Co-authored-by: Cursor <cursoragent@cursor.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Summary
Fixes #2984.
Config::html_config()previously logged deserialization errors and returnedNone, which caused mdBook to fall back to default HTML settings and continue the build. Invalid[output.html]keys (e.g.foo = 123) now propagate as errors and fail the build, consistent with other config validation.Changes
html_config()returnResult<Option<HtmlConfig>>by delegating toget("output.html")serve,watch, HTML renderer,theme_dir, etc.) to propagate errors[output.html]fieldsTest plan
cargo test -p mdbook-core html_config_rejectscargo test bad_config_in_html_tablecargo test -p mdbook-core -p mdbook-driverMade with Cursor