Migrate the fluent_alphabetical and fluent_used check to diagnostics

Author: Kobzol

src/tools/tidy/src/fluent_alphabetical.rs

@@ -7,6 +7,7 @@ use std::path::Path;
 
 use regex::Regex;
 
+use crate::diagnostics::{CheckId, DiagCtx, RunningCheck};
 use crate::walk::{filter_dirs, walk};
 
 fn message() -> &'static Regex {
@@ -20,33 +21,30 @@ fn is_fluent(path: &Path) -> bool {
 fn check_alphabetic(
     filename: &str,
     fluent: &str,
-    bad: &mut bool,
+    check: &mut RunningCheck,
     all_defined_msgs: &mut HashMap<String, String>,
 ) {
     let mut matches = message().captures_iter(fluent).peekable();
     while let Some(m) = matches.next() {
         let name = m.get(1).unwrap();
         if let Some(defined_filename) = all_defined_msgs.get(name.as_str()) {
-            tidy_error!(
-                bad,
-                "{filename}: message `{}` is already defined in {}",
+            check.error(format!(
+                "{filename}: message `{}` is already defined in {defined_filename}",
                 name.as_str(),
-                defined_filename,
-            );
+            ));
         }
 
         all_defined_msgs.insert(name.as_str().to_owned(), filename.to_owned());
 
         if let Some(next) = matches.peek() {
             let next = next.get(1).unwrap();
             if name.as_str() > next.as_str() {
-                tidy_error!(
-                    bad,
+                check.error(format!(
                     "{filename}: message `{}` appears before `{}`, but is alphabetically later than it
 run `./x.py test tidy --bless` to sort the file correctly",
                     name.as_str(),
                     next.as_str()
-                );
+                ));
             }
         } else {
             break;
@@ -57,20 +55,18 @@ run `./x.py test tidy --bless` to sort the file correctly",
 fn sort_messages(
     filename: &str,
     fluent: &str,
-    bad: &mut bool,
+    check: &mut RunningCheck,
     all_defined_msgs: &mut HashMap<String, String>,
 ) -> String {
     let mut chunks = vec![];
     let mut cur = String::new();
     for line in fluent.lines() {
         if let Some(name) = message().find(line) {
             if let Some(defined_filename) = all_defined_msgs.get(name.as_str()) {
-                tidy_error!(
-                    bad,
-                    "{filename}: message `{}` is already defined in {}",
+                check.error(format!(
+                    "{filename}: message `{}` is already defined in {defined_filename}",
                     name.as_str(),
-                    defined_filename,
-                );
+                ));
             }
 
             all_defined_msgs.insert(name.as_str().to_owned(), filename.to_owned());
@@ -88,7 +84,9 @@ fn sort_messages(
     out
 }
 
-pub fn check(path: &Path, bless: bool, bad: &mut bool) {
+pub fn check(path: &Path, bless: bool, diag_ctx: DiagCtx) {
+    let mut check = diag_ctx.start_check(CheckId::new("fluent_alphabetical").path(path));
+
     let mut all_defined_msgs = HashMap::new();
     walk(
         path,
@@ -98,7 +96,7 @@ pub fn check(path: &Path, bless: bool, bad: &mut bool) {
                 let sorted = sort_messages(
                     ent.path().to_str().unwrap(),
                     contents,
-                    bad,
+                    &mut check,
                     &mut all_defined_msgs,
                 );
                 if sorted != contents {
@@ -110,12 +108,12 @@ pub fn check(path: &Path, bless: bool, bad: &mut bool) {
                 check_alphabetic(
                     ent.path().to_str().unwrap(),
                     contents,
-                    bad,
+                    &mut check,
                     &mut all_defined_msgs,
                 );
             }
         },
     );
 
-    crate::fluent_used::check(path, all_defined_msgs, bad);
+    crate::fluent_used::check(path, all_defined_msgs, diag_ctx);
 }

src/tools/tidy/src/fluent_used.rs

@@ -3,6 +3,7 @@
 use std::collections::HashMap;
 use std::path::Path;
 
+use crate::diagnostics::{CheckId, DiagCtx};
 use crate::walk::{filter_dirs, walk};
 
 fn filter_used_messages(
@@ -27,13 +28,15 @@ fn filter_used_messages(
     }
 }
 
-pub fn check(path: &Path, mut all_defined_msgs: HashMap<String, String>, bad: &mut bool) {
+pub fn check(path: &Path, mut all_defined_msgs: HashMap<String, String>, diag_ctx: DiagCtx) {
+    let mut check = diag_ctx.start_check(CheckId::new("fluent_used").path(path));
+
     let mut msgs_appear_only_once = HashMap::new();
     walk(path, |path, _| filter_dirs(path), &mut |_, contents| {
         filter_used_messages(contents, &mut all_defined_msgs, &mut msgs_appear_only_once);
     });
 
     for (name, filename) in msgs_appear_only_once {
-        tidy_error!(bad, "{filename}: message `{}` is not used", name,);
+        check.error(format!("{filename}: message `{name}` is not used"));
     }
 }

src/tools/tidy/src/main.rs

@@ -119,7 +119,7 @@ fn main() {
 
         // Checks that only make sense for the compiler.
         check!(error_codes, &root_path, &[&compiler_path, &librustdoc_path], &ci_info);
-        // check!(fluent_alphabetical, &compiler_path, bless);
+        check!(fluent_alphabetical, &compiler_path, bless);
         // check!(fluent_period, &compiler_path);
         // check!(fluent_lowercase, &compiler_path);
         // check!(target_policy, &root_path);