Validation: Report when no issues have been found

Author: msuchane

src/validation.rs

@@ -94,6 +94,8 @@ impl fmt::Display for IssueReport {
     }
 }
 
+/// The main validation function. Checks all possible issues in a single file, loaded from a file name.
+/// Prints the issues to the standard output.
 pub fn validate(file_name: &str) {
     debug!("Validating file `{}`", file_name);
 
@@ -129,14 +131,22 @@ pub fn validate(file_name: &str) {
 
 /// Print a sorted, human-readable report about the issues found in the file
 fn report_issues(mut issues: Vec<IssueReport>, file_path: &str) {
-    if !issues.is_empty() {
-        // Sort the reported issues by their line number
-        issues.sort_by_key(|report| report.line_number);
+    if issues.is_empty() {
+        // If there are no issues in the file, report that as info to avoid confusion over a blank output.
+        issues.push(IssueReport {
+            line_number: None,
+            description: "No issues found in this file.",
+            severity: IssueSeverity::Information,
+        });
+    }
 
-        println!("💾 File: {}", file_path);
-        for issue in issues {
-            println!("    {}", issue);
-        }
+    // Sort the reported issues by their line number
+    issues.sort_by_key(|report| report.line_number);
+
+    // Print the sorted reports for the file to the standard output
+    println!("💾 File: {}", file_path);
+    for issue in issues {
+        println!("    {}", issue);
     }
 }