Skip to content
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

Jump to bottom

linkchecker: add a reminder on broken links to add new/renamed pages to SUMMARY.md for mdBooks #131737

Merged
merged 1 commit into from
Oct 21, 2024
Merged

linkchecker: add a reminder on broken links to add new/renamed pages to SUMMARY.md for mdBooks #131737

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 11 additions & 0 deletions src/tools/linkchecker/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ fn main() {
links_ignored_external: 0,
links_ignored_exception: 0,
intra_doc_exceptions: 0,
has_broken_urls: false,
};
checker.walk(&docs, &mut report);
report.report();
Expand All @@ -116,6 +117,8 @@ struct Checker {

struct Report {
errors: u32,
// Used to provide help message to remind the user to register a page in `SUMMARY.md`.
has_broken_urls: bool,
start: Instant,
html_files: u32,
html_redirects: u32,
Expand Down Expand Up @@ -274,6 +277,7 @@ impl Checker {
report.links_ignored_exception += 1;
} else {
report.errors += 1;
report.has_broken_urls = true;
println!("{}:{}: broken link - `{}`", pretty_path, i, target_pretty_path);
}
return;
Expand Down Expand Up @@ -438,6 +442,13 @@ impl Report {
println!("number of links ignored due to exceptions: {}", self.links_ignored_exception);
println!("number of intra doc links ignored: {}", self.intra_doc_exceptions);
println!("errors found: {}", self.errors);

if self.has_broken_urls {
eprintln!(
"NOTE: if you are adding or renaming a markdown file in a mdBook, don't forget to \
register the page in SUMMARY.md"
);
}
}
}

Expand Down
Loading