clippy_dev/src/lib.rs

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