bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

minor fixes for error_codes.rs tidy check

Browse source
This commit is contained in:
Ezra Shaw 2023-01-07 18:36:32 +13:00
parent 84f22e44c5
commit 09382db78b
No known key found for this signature in database
GPG key ID: 17CD5C2ADAE0D344
1 changed files with 15 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

27
src/tools/tidy/src/error_codes.rs
View file

@ -15,8 +15,6 @@
//! //!
//! 4. We check that the error code is actually emitted by the compiler. //! 4. We check that the error code is actually emitted by the compiler.
//! - This is done by searching `compiler/` with a regex. //! - This is done by searching `compiler/` with a regex.
//!
//! This tidy check was merged and refactored from two others. See #PR_NUM for information about linting changes that occurred during this refactor.
use std::{ffi::OsStr, fs, path::Path}; use std::{ffi::OsStr, fs, path::Path};
@ -57,7 +55,7 @@ pub fn check(root_path: &Path, search_paths: &[&Path], verbose: bool, bad: &mut
let no_longer_emitted = check_error_codes_docs(root_path, &error_codes, &mut errors, verbose); let no_longer_emitted = check_error_codes_docs(root_path, &error_codes, &mut errors, verbose);
// Stage 3: check list has UI tests // Stage 3: check list has UI tests
check_error_codes_tests(root_path, &error_codes, &mut errors, verbose); check_error_codes_tests(root_path, &error_codes, &mut errors, verbose, &no_longer_emitted);
// Stage 4: check list is emitted by compiler // Stage 4: check list is emitted by compiler
check_error_codes_used(search_paths, &error_codes, &mut errors, &no_longer_emitted, verbose); check_error_codes_used(search_paths, &error_codes, &mut errors, &no_longer_emitted, verbose);
@ -174,8 +172,9 @@ fn check_error_codes_docs(
return; return;
} }
let (found_code_example, found_proper_doctest, emit_ignore_warning, emit_no_longer_warning) = let (found_code_example, found_proper_doctest, emit_ignore_warning, no_longer_emitted) =
check_explanation_has_doctest(&contents, &err_code); check_explanation_has_doctest(&contents, &err_code);
if emit_ignore_warning { if emit_ignore_warning {
verbose_print!( verbose_print!(
verbose, verbose,
@ -183,13 +182,11 @@ fn check_error_codes_docs(
`IGNORE_DOCTEST_CHECK` constant instead." `IGNORE_DOCTEST_CHECK` constant instead."
); );
} }
if emit_no_longer_warning {
if no_longer_emitted {
no_longer_emitted_codes.push(err_code.to_owned()); no_longer_emitted_codes.push(err_code.to_owned());
verbose_print!(
verbose,
"warning: Error code `{err_code}` is no longer emitted and should be removed entirely."
);
} }
if !found_code_example { if !found_code_example {
verbose_print!( verbose_print!(
verbose, verbose,
@ -226,7 +223,7 @@ fn check_explanation_has_doctest(explanation: &str, err_code: &str) -> (bool, bo
let mut found_proper_doctest = false; let mut found_proper_doctest = false;
let mut emit_ignore_warning = false; let mut emit_ignore_warning = false;
let mut emit_no_longer_warning = false; let mut no_longer_emitted = false;
for line in explanation.lines() { for line in explanation.lines() {
let line = line.trim(); let line = line.trim();
@ -246,13 +243,13 @@ fn check_explanation_has_doctest(explanation: &str, err_code: &str) -> (bool, bo
} else if line } else if line
.starts_with("#### Note: this error code is no longer emitted by the compiler") .starts_with("#### Note: this error code is no longer emitted by the compiler")
{ {
emit_no_longer_warning = true; no_longer_emitted = true;
found_code_example = true; found_code_example = true;
found_proper_doctest = true; found_proper_doctest = true;
} }
} }
(found_code_example, found_proper_doctest, emit_ignore_warning, emit_no_longer_warning) (found_code_example, found_proper_doctest, emit_ignore_warning, no_longer_emitted)
} }
// Stage 3: Checks that each error code has a UI test in the correct directory // Stage 3: Checks that each error code has a UI test in the correct directory
@ -261,6 +258,7 @@ fn check_error_codes_tests(
error_codes: &[String], error_codes: &[String],
errors: &mut Vec<String>, errors: &mut Vec<String>,
verbose: bool, verbose: bool,
no_longer_emitted: &[String],
) { ) {
let tests_path = root_path.join(Path::new(ERROR_TESTS_PATH)); let tests_path = root_path.join(Path::new(ERROR_TESTS_PATH));
@ -295,6 +293,11 @@ fn check_error_codes_tests(
} }
}; };
if no_longer_emitted.contains(code) {
// UI tests *can't* contain error codes that are no longer emitted.
continue;
}
let mut found_code = false; let mut found_code = false;
for line in file.lines() { for line in file.lines() {