Skip to content

Support early stopping too old pre-installed tidy command for macOS in the HTML checker #90663

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.

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 1 commit into from
Nov 10, 2021
Merged
Changes from all commits
Commits
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
23 changes: 23 additions & 0 deletions src/tools/html-checker/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -79,11 +79,34 @@ fn find_all_html_files(dir: &Path) -> (usize, usize) {
(files_read, errors)
}

/// Default `tidy` command for macOS is too old that it does not have `mute-id` and `mute` options.
/// `tidy` on macOS Monterey was released on 31 October 2006, and the same date can be seen seven
/// years ago at <https://stackoverflow.com/questions/22283382/overwrite-osx-tidy>. Accordingly,
/// the macOS environment using pre-installed `tidy` should immediately suspend HTML checker process
/// and show a hint to install a newer one.
#[cfg(target_os = "macos")]
fn check_tidy_version() -> Result<(), String> {
let output = Command::new("tidy").arg("-v").output().expect("failed to run tidy command");
let version = String::from_utf8(output.stdout).expect("failed to read version of tidy command");
if version.contains("HTML Tidy for Mac OS X released on 31 October 2006") {
eprintln!("The pre-installed HTML Tidy for macOS is not supported.");
eprintln!("Consider installing a newer one and re-running.");
eprintln!("If you're using Homebrew, you can install it by the following command:");
eprintln!(" brew install tidy-html5");
eprintln!();
Err("HTML check failed: 1 error".to_string())
} else {
Ok(())
}
}

fn main() -> Result<(), String> {
let args = env::args().collect::<Vec<_>>();
if args.len() != 2 {
return Err(format!("Usage: {} <doc folder>", args[0]));
}
#[cfg(target_os = "macos")]
check_tidy_version()?;

println!("Running HTML checker...");

Expand Down