add: rationale to diagnostic comments in PR reviews

2bndy5 · 2bndy5 · commit 0923c6a1c616 · 2024-12-12T08:57:47.000-08:00
diff --git a/cpp-linter/src/clang_tools/clang_tidy.rs b/cpp-linter/src/clang_tools/clang_tidy.rs
@@ -106,7 +106,11 @@ impl MakeSuggestions for TidyAdvice {
         for note in &self.notes {
             for fixed_line in &note.fixed_lines {
                 if (start_line..=end_line).contains(fixed_line) {
-                    diagnostics.push(format!("- {}\n", note.diagnostic_link()));
+                    diagnostics.push(format!(
+                        "- {} [{}]\n",
+                        note.rationale,
+                        note.diagnostic_link()
+                    ));
                 }
             }
         }

Original file line number	Diff line number	Diff line change
`@@ -106,7 +106,11 @@ impl MakeSuggestions for TidyAdvice {`
`106`	`106`	`for note in &self.notes {`
`107`	`107`	`for fixed_line in &note.fixed_lines {`
`108`	`108`	`if (start_line..=end_line).contains(fixed_line) {`
`109`		`- diagnostics.push(format!("- {}\n", note.diagnostic_link()));`
	`109`	`+ diagnostics.push(format!(`
	`110`	`+ "- {} [{}]\n",`
	`111`	`+ note.rationale,`
	`112`	`+ note.diagnostic_link()`
	`113`	`+ ));`
`110`	`114`	`}`
`111`	`115`	`}`
`112`	`116`	`}`