Rollup merge of #146332 - lolbinarycat:tidy-extra-checks-regularize, r=Kobzol

tidy: make behavior of extra-checks more uniform
This commit is contained in:
Stuart Cook 2025-09-12 20:02:12 +10:00 committed by GitHub
commit 27954ecbae
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 45 additions and 13 deletions

View file

@ -124,6 +124,12 @@ fn check_impl(
};
}
let rerun_with_bless = |mode: &str, action: &str| {
if !bless {
eprintln!("rerun tidy with `--extra-checks={mode} --bless` to {action}");
}
};
let python_lint = extra_check!(Py, Lint);
let python_fmt = extra_check!(Py, Fmt);
let shell_lint = extra_check!(Shell, Lint);
@ -147,14 +153,21 @@ fn check_impl(
}
if python_lint {
eprintln!("linting python files");
let py_path = py_path.as_ref().unwrap();
let res = run_ruff(root_path, outdir, py_path, &cfg_args, &file_args, &["check".as_ref()]);
let args: &[&OsStr] = if bless {
eprintln!("linting python files and applying suggestions");
&["check".as_ref(), "--fix".as_ref()]
} else {
eprintln!("linting python files");
&["check".as_ref()]
};
if res.is_err() && show_diff {
let res = run_ruff(root_path, outdir, py_path, &cfg_args, &file_args, args);
if res.is_err() && show_diff && !bless {
eprintln!("\npython linting failed! Printing diff suggestions:");
let _ = run_ruff(
let diff_res = run_ruff(
root_path,
outdir,
py_path,
@ -162,6 +175,10 @@ fn check_impl(
&file_args,
&["check".as_ref(), "--diff".as_ref()],
);
// `ruff check --diff` will return status 0 if there are no suggestions.
if diff_res.is_err() {
rerun_with_bless("py:lint", "apply ruff suggestions");
}
}
// Rethrow error
res?;
@ -192,7 +209,7 @@ fn check_impl(
&["format".as_ref(), "--diff".as_ref()],
);
}
eprintln!("rerun tidy with `--extra-checks=py:fmt --bless` to reformat Python code");
rerun_with_bless("py:fmt", "reformat Python code");
}
// Rethrow error
@ -225,7 +242,7 @@ fn check_impl(
let args = merge_args(&cfg_args_clang_format, &file_args_clang_format);
let res = py_runner(py_path.as_ref().unwrap(), false, None, "clang-format", &args);
if res.is_err() && show_diff {
if res.is_err() && show_diff && !bless {
eprintln!("\nclang-format linting failed! Printing diff suggestions:");
let mut cfg_args_clang_format_diff = cfg_args.clone();
@ -265,6 +282,7 @@ fn check_impl(
);
}
}
rerun_with_bless("cpp:fmt", "reformat C++ code");
}
// Rethrow error
res?;
@ -290,12 +308,16 @@ fn check_impl(
args.extend_from_slice(SPELLCHECK_DIRS);
if bless {
eprintln!("spellcheck files and fix");
eprintln!("spellchecking files and fixing typos");
args.push("--write-changes");
} else {
eprintln!("spellcheck files");
eprintln!("spellchecking files");
}
spellcheck_runner(root_path, &outdir, &cargo, &args)?;
let res = spellcheck_runner(root_path, &outdir, &cargo, &args);
if res.is_err() {
rerun_with_bless("spellcheck", "fix typos");
}
res?;
}
if js_lint || js_typecheck {
@ -303,11 +325,21 @@ fn check_impl(
}
if js_lint {
rustdoc_js::lint(outdir, librustdoc_path, tools_path, bless)?;
if bless {
eprintln!("linting javascript files");
} else {
eprintln!("linting javascript files and applying suggestions");
}
let res = rustdoc_js::lint(outdir, librustdoc_path, tools_path, bless);
if res.is_err() {
rerun_with_bless("js:lint", "apply eslint suggestions");
}
res?;
rustdoc_js::es_check(outdir, librustdoc_path)?;
}
if js_typecheck {
eprintln!("typechecking javascript files");
rustdoc_js::typecheck(outdir, librustdoc_path)?;
}

View file

@ -57,7 +57,7 @@ fn run_eslint(
if exit_status.success() {
return Ok(());
}
Err(super::Error::FailedCheck("eslint command failed"))
Err(super::Error::FailedCheck("eslint"))
}
Err(error) => Err(super::Error::Generic(format!("eslint command failed: {error:?}"))),
}
@ -94,7 +94,7 @@ pub(super) fn typecheck(outdir: &Path, librustdoc_path: &Path) -> Result<(), sup
if exit_status.success() {
return Ok(());
}
Err(super::Error::FailedCheck("tsc command failed"))
Err(super::Error::FailedCheck("tsc"))
}
Err(error) => Err(super::Error::Generic(format!("tsc command failed: {error:?}"))),
}
@ -112,7 +112,7 @@ pub(super) fn es_check(outdir: &Path, librustdoc_path: &Path) -> Result<(), supe
if exit_status.success() {
return Ok(());
}
Err(super::Error::FailedCheck("es-check command failed"))
Err(super::Error::FailedCheck("es-check"))
}
Err(error) => Err(super::Error::Generic(format!("es-check command failed: {error:?}"))),
}