clippy_dev/src/lib.rs

   1 #![cfg_attr(feature = "deny-warnings", deny(warnings))]
   2
   3 use itertools::Itertools;
   4 use lazy_static::lazy_static;
   5 use regex::Regex;
   6 use std::collections::HashMap;
   7 use std::ffi::OsStr;
   8 use std::fs;
   9 use std::io::prelude::*;
  10 use std::path::{Path, PathBuf};
  11 use walkdir::WalkDir;
  12
  13 lazy_static! {
  14     static ref DEC_CLIPPY_LINT_RE: Regex = Regex::new(
  15         r#"(?x)
  16         declare_clippy_lint!\s*[\{(]
  17         (?:\s+///.*)*
  18         \s+pub\s+(?P<name>[A-Z_][A-Z_0-9]*)\s*,\s*
  19         (?P<cat>[a-z_]+)\s*,\s*
  20         "(?P<desc>(?:[^"\\]+|\\(?s).(?-s))*)"\s*[})]
  21     "#
  22     )
  23     .unwrap();
  24     static ref DEC_DEPRECATED_LINT_RE: Regex = Regex::new(
  25         r#"(?x)
  26         declare_deprecated_lint!\s*[{(]\s*
  27         (?:\s+///.*)*
  28         \s+pub\s+(?P<name>[A-Z_][A-Z_0-9]*)\s*,\s*
  29         "(?P<desc>(?:[^"\\]+|\\(?s).(?-s))*)"\s*[})]
  30     "#
  31     )
  32     .unwrap();
  33     static ref NL_ESCAPE_RE: Regex = Regex::new(r#"\\\n\s*"#).unwrap();
  34     pub static ref DOCS_LINK: String = "https://rust-lang.github.io/rust-clippy/master/index.html".to_string();
  35 }
  36
  37 /// Lint data parsed from the Clippy source code.
  38 #[derive(Clone, PartialEq, Debug)]
  39 pub struct Lint {
  40     pub name: String,
  41     pub group: String,
  42     pub desc: String,
  43     pub deprecation: Option<String>,
  44     pub module: String,
  45 }
  46
  47 impl Lint {
  48     #[must_use]
  49     pub fn new(name: &str, group: &str, desc: &str, deprecation: Option<&str>, module: &str) -> Self {
  50         Self {
  51             name: name.to_lowercase(),
  52             group: group.to_string(),
  53             desc: NL_ESCAPE_RE.replace(&desc.replace("\\\"", "\""), "").to_string(),
  54             deprecation: deprecation.map(ToString::to_string),
  55             module: module.to_string(),
  56         }
  57     }
  58
  59     /// Returns all non-deprecated lints and non-internal lints
  60     pub fn usable_lints(lints: impl Iterator<Item = Self>) -> impl Iterator<Item = Self> {
  61         lints.filter(|l| l.deprecation.is_none() && !l.is_internal())
  62     }
  63
  64     /// Returns the lints in a `HashMap`, grouped by the different lint groups
  65     #[must_use]
  66     pub fn by_lint_group(lints: &[Self]) -> HashMap<String, Vec<Self>> {
  67         lints
  68             .iter()
  69             .map(|lint| (lint.group.to_string(), lint.clone()))
  70             .into_group_map()
  71     }
  72
  73     #[must_use]
  74     pub fn is_internal(&self) -> bool {
  75         self.group.starts_with("internal")
  76     }
  77 }
  78
  79 /// Generates the Vec items for `register_lint_group` calls in `clippy_lints/src/lib.rs`.
  80 #[must_use]
  81 pub fn gen_lint_group_list(lints: Vec<Lint>) -> Vec<String> {
  82     lints
  83         .into_iter()
  84         .filter_map(|l| {
  85             if l.is_internal() || l.deprecation.is_some() {
  86                 None
  87             } else {
  88                 Some(format!("        LintId::of(&{}::{}),", l.module, l.name.to_uppercase()))
  89             }
  90         })
  91         .sorted()
  92         .collect::<Vec<String>>()
  93 }
  94
  95 /// Generates the `pub mod module_name` list in `clippy_lints/src/lib.rs`.
  96 #[must_use]
  97 pub fn gen_modules_list(lints: Vec<Lint>) -> Vec<String> {
  98     lints
  99         .into_iter()
 100         .filter_map(|l| {
 101             if l.is_internal() || l.deprecation.is_some() {
 102                 None
 103             } else {
 104                 Some(l.module)
 105             }
 106         })
 107         .unique()
 108         .map(|module| format!("pub mod {};", module))
 109         .sorted()
 110         .collect::<Vec<String>>()
 111 }
 112
 113 /// Generates the list of lint links at the bottom of the README
 114 #[must_use]
 115 pub fn gen_changelog_lint_list(lints: Vec<Lint>) -> Vec<String> {
 116     let mut lint_list_sorted: Vec<Lint> = lints;
 117     lint_list_sorted.sort_by_key(|l| l.name.clone());
 118     lint_list_sorted
 119         .iter()
 120         .filter_map(|l| {
 121             if l.is_internal() {
 122                 None
 123             } else {
 124                 Some(format!("[`{}`]: {}#{}", l.name, DOCS_LINK.clone(), l.name))
 125             }
 126         })
 127         .collect()
 128 }
 129
 130 /// Generates the `register_removed` code in `./clippy_lints/src/lib.rs`.
 131 #[must_use]
 132 pub fn gen_deprecated(lints: &[Lint]) -> Vec<String> {
 133     lints
 134         .iter()
 135         .filter_map(|l| {
 136             l.clone().deprecation.map(|depr_text| {
 137                 vec![
 138                     "    store.register_removed(".to_string(),
 139                     format!("        \"clippy::{}\",", l.name),
 140                     format!("        \"{}\",", depr_text),
 141                     "    );".to_string(),
 142                 ]
 143             })
 144         })
 145         .flatten()
 146         .collect::<Vec<String>>()
 147 }
 148
 149 #[must_use]
 150 pub fn gen_register_lint_list(lints: &[Lint]) -> Vec<String> {
 151     let pre = "    store.register_lints(&[".to_string();
 152     let post = "    ]);".to_string();
 153     let mut inner = lints
 154         .iter()
 155         .filter_map(|l| {
 156             if !l.is_internal() && l.deprecation.is_none() {
 157                 Some(format!("        &{}::{},", l.module, l.name.to_uppercase()))
 158             } else {
 159                 None
 160             }
 161         })
 162         .sorted()
 163         .collect::<Vec<String>>();
 164     inner.insert(0, pre);
 165     inner.push(post);
 166     inner
 167 }
 168
 169 /// Gathers all files in `src/clippy_lints` and gathers all lints inside
 170 pub fn gather_all() -> impl Iterator<Item = Lint> {
 171     lint_files().flat_map(|f| gather_from_file(&f))
 172 }
 173
 174 fn gather_from_file(dir_entry: &walkdir::DirEntry) -> impl Iterator<Item = Lint> {
 175     let mut file = fs::File::open(dir_entry.path()).unwrap();
 176     let mut content = String::new();
 177     file.read_to_string(&mut content).unwrap();
 178     let mut filename = dir_entry.path().file_stem().unwrap().to_str().unwrap();
 179     // If the lints are stored in mod.rs, we get the module name from
 180     // the containing directory:
 181     if filename == "mod" {
 182         filename = dir_entry
 183             .path()
 184             .parent()
 185             .unwrap()
 186             .file_stem()
 187             .unwrap()
 188             .to_str()
 189             .unwrap()
 190     }
 191     parse_contents(&content, filename)
 192 }
 193
 194 fn parse_contents(content: &str, filename: &str) -> impl Iterator<Item = Lint> {
 195     let lints = DEC_CLIPPY_LINT_RE
 196         .captures_iter(content)
 197         .map(|m| Lint::new(&m["name"], &m["cat"], &m["desc"], None, filename));
 198     let deprecated = DEC_DEPRECATED_LINT_RE
 199         .captures_iter(content)
 200         .map(|m| Lint::new(&m["name"], "Deprecated", &m["desc"], Some(&m["desc"]), filename));
 201     // Removing the `.collect::<Vec<Lint>>().into_iter()` causes some lifetime issues due to the map
 202     lints.chain(deprecated).collect::<Vec<Lint>>().into_iter()
 203 }
 204
 205 /// Collects all .rs files in the `clippy_lints/src` directory
 206 fn lint_files() -> impl Iterator<Item = walkdir::DirEntry> {
 207     // We use `WalkDir` instead of `fs::read_dir` here in order to recurse into subdirectories.
 208     // Otherwise we would not collect all the lints, for example in `clippy_lints/src/methods/`.
 209     let path = clippy_project_root().join("clippy_lints/src");
 210     WalkDir::new(path)
 211         .into_iter()
 212         .filter_map(std::result::Result::ok)
 213         .filter(|f| f.path().extension() == Some(OsStr::new("rs")))
 214 }
 215
 216 /// Whether a file has had its text changed or not
 217 #[derive(PartialEq, Debug)]
 218 pub struct FileChange {
 219     pub changed: bool,
 220     pub new_lines: String,
 221 }
 222
 223 /// Replaces a region in a file delimited by two lines matching regexes.
 224 ///
 225 /// `path` is the relative path to the file on which you want to perform the replacement.
 226 ///
 227 /// See `replace_region_in_text` for documentation of the other options.
 228 #[allow(clippy::expect_fun_call)]
 229 pub fn replace_region_in_file<F>(
 230     path: &Path,
 231     start: &str,
 232     end: &str,
 233     replace_start: bool,
 234     write_back: bool,
 235     replacements: F,
 236 ) -> FileChange
 237 where
 238     F: Fn() -> Vec<String>,
 239 {
 240     let path = clippy_project_root().join(path);
 241     let mut f = fs::File::open(&path).expect(&format!("File not found: {}", path.to_string_lossy()));
 242     let mut contents = String::new();
 243     f.read_to_string(&mut contents)
 244         .expect("Something went wrong reading the file");
 245     let file_change = replace_region_in_text(&contents, start, end, replace_start, replacements);
 246
 247     if write_back {
 248         let mut f = fs::File::create(&path).expect(&format!("File not found: {}", path.to_string_lossy()));
 249         f.write_all(file_change.new_lines.as_bytes())
 250             .expect("Unable to write file");
 251         // Ensure we write the changes with a trailing newline so that
 252         // the file has the proper line endings.
 253         f.write_all(b"\n").expect("Unable to write file");
 254     }
 255     file_change
 256 }
 257
 258 /// Replaces a region in a text delimited by two lines matching regexes.
 259 ///
 260 /// * `text` is the input text on which you want to perform the replacement
 261 /// * `start` is a `&str` that describes the delimiter line before the region you want to replace.
 262 ///   As the `&str` will be converted to a `Regex`, this can contain regex syntax, too.
 263 /// * `end` is a `&str` that describes the delimiter line until where the replacement should happen.
 264 ///   As the `&str` will be converted to a `Regex`, this can contain regex syntax, too.
 265 /// * If `replace_start` is true, the `start` delimiter line is replaced as well. The `end`
 266 ///   delimiter line is never replaced.
 267 /// * `replacements` is a closure that has to return a `Vec<String>` which contains the new text.
 268 ///
 269 /// If you want to perform the replacement on files instead of already parsed text,
 270 /// use `replace_region_in_file`.
 271 ///
 272 /// # Example
 273 ///
 274 /// ```
 275 /// let the_text = "replace_start\nsome text\nthat will be replaced\nreplace_end";
 276 /// let result = clippy_dev::replace_region_in_text(the_text, r#"replace_start"#, r#"replace_end"#, false, || {
 277 ///     vec!["a different".to_string(), "text".to_string()]
 278 /// })
 279 /// .new_lines;
 280 /// assert_eq!("replace_start\na different\ntext\nreplace_end", result);
 281 /// ```
 282 pub fn replace_region_in_text<F>(text: &str, start: &str, end: &str, replace_start: bool, replacements: F) -> FileChange
 283 where
 284     F: Fn() -> Vec<String>,
 285 {
 286     let lines = text.lines();
 287     let mut in_old_region = false;
 288     let mut found = false;
 289     let mut new_lines = vec![];
 290     let start = Regex::new(start).unwrap();
 291     let end = Regex::new(end).unwrap();
 292
 293     for line in lines.clone() {
 294         if in_old_region {
 295             if end.is_match(&line) {
 296                 in_old_region = false;
 297                 new_lines.extend(replacements());
 298                 new_lines.push(line.to_string());
 299             }
 300         } else if start.is_match(&line) {
 301             if !replace_start {
 302                 new_lines.push(line.to_string());
 303             }
 304             in_old_region = true;
 305             found = true;
 306         } else {
 307             new_lines.push(line.to_string());
 308         }
 309     }
 310
 311     if !found {
 312         // This happens if the provided regex in `clippy_dev/src/main.rs` is not found in the
 313         // given text or file. Most likely this is an error on the programmer's side and the Regex
 314         // is incorrect.
 315         eprintln!("error: regex `{:?}` not found. You may have to update it.", start);
 316     }
 317
 318     FileChange {
 319         changed: lines.ne(new_lines.clone()),
 320         new_lines: new_lines.join("\n"),
 321     }
 322 }
 323
 324 /// Returns the path to the Clippy project directory
 325 #[must_use]
 326 pub fn clippy_project_root() -> PathBuf {
 327     let current_dir = std::env::current_dir().unwrap();
 328     for path in current_dir.ancestors() {
 329         let result = std::fs::read_to_string(path.join("Cargo.toml"));
 330         if let Err(err) = &result {
 331             if err.kind() == std::io::ErrorKind::NotFound {
 332                 continue;
 333             }
 334         }
 335
 336         let content = result.unwrap();
 337         if content.contains("[package]\nname = \"clippy\"") {
 338             return path.to_path_buf();
 339         }
 340     }
 341     panic!("error: Can't determine root of project. Please run inside a Clippy working dir.");
 342 }
 343
 344 #[test]
 345 fn test_parse_contents() {
 346     let result: Vec<Lint> = parse_contents(
 347         r#"
 348 declare_clippy_lint! {
 349     pub PTR_ARG,
 350     style,
 351     "really long \
 352      text"
 353 }
 354
 355 declare_clippy_lint!{
 356     pub DOC_MARKDOWN,
 357     pedantic,
 358     "single line"
 359 }
 360
 361 /// some doc comment
 362 declare_deprecated_lint! {
 363     pub SHOULD_ASSERT_EQ,
 364     "`assert!()` will be more flexible with RFC 2011"
 365 }
 366     "#,
 367         "module_name",
 368     )
 369     .collect();
 370
 371     let expected = vec![
 372         Lint::new("ptr_arg", "style", "really long text", None, "module_name"),
 373         Lint::new("doc_markdown", "pedantic", "single line", None, "module_name"),
 374         Lint::new(
 375             "should_assert_eq",
 376             "Deprecated",
 377             "`assert!()` will be more flexible with RFC 2011",
 378             Some("`assert!()` will be more flexible with RFC 2011"),
 379             "module_name",
 380         ),
 381     ];
 382     assert_eq!(expected, result);
 383 }
 384
 385 #[test]
 386 fn test_replace_region() {
 387     let text = "\nabc\n123\n789\ndef\nghi";
 388     let expected = FileChange {
 389         changed: true,
 390         new_lines: "\nabc\nhello world\ndef\nghi".to_string(),
 391     };
 392     let result = replace_region_in_text(text, r#"^\s*abc$"#, r#"^\s*def"#, false, || {
 393         vec!["hello world".to_string()]
 394     });
 395     assert_eq!(expected, result);
 396 }
 397
 398 #[test]
 399 fn test_replace_region_with_start() {
 400     let text = "\nabc\n123\n789\ndef\nghi";
 401     let expected = FileChange {
 402         changed: true,
 403         new_lines: "\nhello world\ndef\nghi".to_string(),
 404     };
 405     let result = replace_region_in_text(text, r#"^\s*abc$"#, r#"^\s*def"#, true, || {
 406         vec!["hello world".to_string()]
 407     });
 408     assert_eq!(expected, result);
 409 }
 410
 411 #[test]
 412 fn test_replace_region_no_changes() {
 413     let text = "123\n456\n789";
 414     let expected = FileChange {
 415         changed: false,
 416         new_lines: "123\n456\n789".to_string(),
 417     };
 418     let result = replace_region_in_text(text, r#"^\s*123$"#, r#"^\s*456"#, false, || vec![]);
 419     assert_eq!(expected, result);
 420 }
 421
 422 #[test]
 423 fn test_usable_lints() {
 424     let lints = vec![
 425         Lint::new("should_assert_eq", "Deprecated", "abc", Some("Reason"), "module_name"),
 426         Lint::new("should_assert_eq2", "Not Deprecated", "abc", None, "module_name"),
 427         Lint::new("should_assert_eq2", "internal", "abc", None, "module_name"),
 428         Lint::new("should_assert_eq2", "internal_style", "abc", None, "module_name"),
 429     ];
 430     let expected = vec![Lint::new(
 431         "should_assert_eq2",
 432         "Not Deprecated",
 433         "abc",
 434         None,
 435         "module_name",
 436     )];
 437     assert_eq!(expected, Lint::usable_lints(lints.into_iter()).collect::<Vec<Lint>>());
 438 }
 439
 440 #[test]
 441 fn test_by_lint_group() {
 442     let lints = vec![
 443         Lint::new("should_assert_eq", "group1", "abc", None, "module_name"),
 444         Lint::new("should_assert_eq2", "group2", "abc", None, "module_name"),
 445         Lint::new("incorrect_match", "group1", "abc", None, "module_name"),
 446     ];
 447     let mut expected: HashMap<String, Vec<Lint>> = HashMap::new();
 448     expected.insert(
 449         "group1".to_string(),
 450         vec![
 451             Lint::new("should_assert_eq", "group1", "abc", None, "module_name"),
 452             Lint::new("incorrect_match", "group1", "abc", None, "module_name"),
 453         ],
 454     );
 455     expected.insert(
 456         "group2".to_string(),
 457         vec![Lint::new("should_assert_eq2", "group2", "abc", None, "module_name")],
 458     );
 459     assert_eq!(expected, Lint::by_lint_group(&lints));
 460 }
 461
 462 #[test]
 463 fn test_gen_changelog_lint_list() {
 464     let lints = vec![
 465         Lint::new("should_assert_eq", "group1", "abc", None, "module_name"),
 466         Lint::new("should_assert_eq2", "group2", "abc", None, "module_name"),
 467         Lint::new("incorrect_internal", "internal_style", "abc", None, "module_name"),
 468     ];
 469     let expected = vec![
 470         format!("[`should_assert_eq`]: {}#should_assert_eq", DOCS_LINK.to_string()),
 471         format!("[`should_assert_eq2`]: {}#should_assert_eq2", DOCS_LINK.to_string()),
 472     ];
 473     assert_eq!(expected, gen_changelog_lint_list(lints));
 474 }
 475
 476 #[test]
 477 fn test_gen_deprecated() {
 478     let lints = vec![
 479         Lint::new(
 480             "should_assert_eq",
 481             "group1",
 482             "abc",
 483             Some("has been superseded by should_assert_eq2"),
 484             "module_name",
 485         ),
 486         Lint::new(
 487             "another_deprecated",
 488             "group2",
 489             "abc",
 490             Some("will be removed"),
 491             "module_name",
 492         ),
 493         Lint::new("should_assert_eq2", "group2", "abc", None, "module_name"),
 494     ];
 495     let expected: Vec<String> = vec![
 496         "    store.register_removed(",
 497         "        \"clippy::should_assert_eq\",",
 498         "        \"has been superseded by should_assert_eq2\",",
 499         "    );",
 500         "    store.register_removed(",
 501         "        \"clippy::another_deprecated\",",
 502         "        \"will be removed\",",
 503         "    );",
 504     ]
 505     .into_iter()
 506     .map(String::from)
 507     .collect();
 508     assert_eq!(expected, gen_deprecated(&lints));
 509 }
 510
 511 #[test]
 512 fn test_gen_modules_list() {
 513     let lints = vec![
 514         Lint::new("should_assert_eq", "group1", "abc", None, "module_name"),
 515         Lint::new("should_assert_eq2", "group2", "abc", Some("abc"), "deprecated"),
 516         Lint::new("incorrect_stuff", "group3", "abc", None, "another_module"),
 517         Lint::new("incorrect_internal", "internal_style", "abc", None, "module_name"),
 518     ];
 519     let expected = vec![
 520         "pub mod another_module;".to_string(),
 521         "pub mod module_name;".to_string(),
 522     ];
 523     assert_eq!(expected, gen_modules_list(lints));
 524 }
 525
 526 #[test]
 527 fn test_gen_lint_group_list() {
 528     let lints = vec![
 529         Lint::new("abc", "group1", "abc", None, "module_name"),
 530         Lint::new("should_assert_eq", "group1", "abc", None, "module_name"),
 531         Lint::new("should_assert_eq2", "group2", "abc", Some("abc"), "deprecated"),
 532         Lint::new("incorrect_internal", "internal_style", "abc", None, "module_name"),
 533     ];
 534     let expected = vec![
 535         "        LintId::of(&module_name::ABC),".to_string(),
 536         "        LintId::of(&module_name::SHOULD_ASSERT_EQ),".to_string(),
 537     ];
 538     assert_eq!(expected, gen_lint_group_list(lints));
 539 }