Add sanitize_explanation

Author: blyxyas

clippy_lints/src/lib.rs

@@ -522,30 +522,35 @@ impl LintInfo {
 }
 }
 
-pubfnexplain(name:&str) -> i32{
-let target = format!("clippy::{}", name.to_ascii_uppercase());
-
-ifletSome(info) = declared_lints::LINTS.iter().find(|info| info.lint.name == target){
-// Remove tags and hidden code:
-letmut explanation = String::with_capacity(128);
-letmut in_code = false;
-for line in info.explanation.lines().map(|line| line.trim()){
-ifletSome(lang) = line.strip_prefix("```"){
-let tag = lang.split_once(',').map_or(lang, |(left, _)| left);
-if !in_code && matches!(tag,"" | "rust" | "ignore" | "should_panic" | "no_run" | "compile_fail"){
- explanation += "```rust\n";
-}else{
- explanation += line;
- explanation.push('\n');
-}
- in_code = !in_code;
-}elseif !(in_code && line.starts_with("# ")){
+// Remove code tags and code behind '# 's, as they are not needed for the lint docs and --explain
+pubfnsanitize_explanation(raw_docs:&str) -> String{
+// Remove tags and hidden code:
+letmut explanation = String::with_capacity(128);
+letmut in_code = false;
+for line in raw_docs.lines().map(|line| line.trim()){
+ifletSome(lang) = line.strip_prefix("```"){
+let tag = lang.split_once(',').map_or(lang, |(left, _)| left);
+if !in_code && matches!(tag,"" | "rust" | "ignore" | "should_panic" | "no_run" | "compile_fail"){
+ explanation += "```rust\n";
+}else{
  explanation += line;
  explanation.push('\n');
 }
+ in_code = !in_code;
+}elseif !(in_code && line.starts_with("# ")){
+ explanation += line;
+ explanation.push('\n');
 }
+}
 
-println!("{}", explanation);
+ explanation
+}
+
+pubfnexplain(name:&str) -> i32{
+let target = format!("clippy::{}", name.to_ascii_uppercase());
+
+ifletSome(info) = declared_lints::LINTS.iter().find(|info| info.lint.name == target){
+println!("{}", sanitize_explanation(info.explanation));
 // Check if the lint has configuration
 letmut mdconf = get_configuration_metadata();
 let name = name.to_ascii_lowercase();

tests/compile-test.rs

@@ -5,9 +5,9 @@
 use cargo_metadata::Message;
 use cargo_metadata::diagnostic::{Applicability,Diagnostic};
 use clippy_config::ClippyConfiguration;
-use clippy_lints::LintInfo;
 use clippy_lints::declared_lints::LINTS;
 use clippy_lints::deprecated_lints::{DEPRECATED,DEPRECATED_VERSION,RENAMED};
+use clippy_lints::{LintInfo, sanitize_explanation};
 use serde::{Deserialize,Serialize};
 use test_utils::IS_RUSTC_TEST_SUITE;
 use ui_test::custom_flags::Flag;
@@ -444,7 +444,12 @@ impl DiagnosticCollector {
  iter::zip(DEPRECATED,DEPRECATED_VERSION)
 .map(|((lint, reason), version)| LintMetadata::new_deprecated(lint, reason, version)),
 )
+.map(|mut metadata| {
+ metadata.docs = sanitize_explanation(&metadata.docs);
+ metadata
+})
 .collect();
+
  metadata.sort_unstable_by(|a, b| a.id.cmp(&b.id));
 
 let json = serde_json::to_string_pretty(&metadata).unwrap();