1 #![cfg_attr(feature = "deny-warnings", deny(warnings))]
3 use itertools::Itertools;
4 use lazy_static::lazy_static;
6 use std::collections::HashMap;
9 use std::path::{Path, PathBuf};
15 pub mod stderr_length_check;
19 static ref DEC_CLIPPY_LINT_RE: Regex = Regex::new(
21 declare_clippy_lint!\s*[\{(]
23 \s+pub\s+(?P<name>[A-Z_][A-Z_0-9]*)\s*,\s*
24 (?P<cat>[a-z_]+)\s*,\s*
25 "(?P<desc>(?:[^"\\]+|\\(?s).(?-s))*)"\s*[})]
29 static ref DEC_DEPRECATED_LINT_RE: Regex = Regex::new(
31 declare_deprecated_lint!\s*[{(]\s*
33 \s+pub\s+(?P<name>[A-Z_][A-Z_0-9]*)\s*,\s*
34 "(?P<desc>(?:[^"\\]+|\\(?s).(?-s))*)"\s*[})]
38 static ref NL_ESCAPE_RE: Regex = Regex::new(r#"\\\n\s*"#).unwrap();
41 pub static DOCS_LINK: &str = "https://rust-lang.github.io/rust-clippy/master/index.html";
43 /// Lint data parsed from the Clippy source code.
44 #[derive(Clone, PartialEq, Debug)]
49 pub deprecation: Option<String>,
55 pub fn new(name: &str, group: &str, desc: &str, deprecation: Option<&str>, module: &str) -> Self {
57 name: name.to_lowercase(),
58 group: group.to_string(),
59 desc: NL_ESCAPE_RE.replace(&desc.replace("\\\"", "\""), "").to_string(),
60 deprecation: deprecation.map(ToString::to_string),
61 module: module.to_string(),
65 /// Returns all non-deprecated lints and non-internal lints
67 pub fn usable_lints(lints: &[Self]) -> Vec<Self> {
70 .filter(|l| l.deprecation.is_none() && !l.group.starts_with("internal"))
75 /// Returns all internal lints (not `internal_warn` lints)
77 pub fn internal_lints(lints: &[Self]) -> Vec<Self> {
78 lints.iter().filter(|l| l.group == "internal").cloned().collect()
81 /// Returns all deprecated lints
83 pub fn deprecated_lints(lints: &[Self]) -> Vec<Self> {
84 lints.iter().filter(|l| l.deprecation.is_some()).cloned().collect()
87 /// Returns the lints in a `HashMap`, grouped by the different lint groups
89 pub fn by_lint_group(lints: impl Iterator<Item = Self>) -> HashMap<String, Vec<Self>> {
90 lints.map(|lint| (lint.group.to_string(), lint)).into_group_map()
94 /// Generates the Vec items for `register_lint_group` calls in `clippy_lints/src/lib.rs`.
96 pub fn gen_lint_group_list<'a>(lints: impl Iterator<Item = &'a Lint>) -> Vec<String> {
98 .map(|l| format!(" LintId::of(&{}::{}),", l.module, l.name.to_uppercase()))
100 .collect::<Vec<String>>()
103 /// Generates the `pub mod module_name` list in `clippy_lints/src/lib.rs`.
105 pub fn gen_modules_list<'a>(lints: impl Iterator<Item = &'a Lint>) -> Vec<String> {
109 .map(|module| format!("mod {};", module))
111 .collect::<Vec<String>>()
114 /// Generates the list of lint links at the bottom of the README
116 pub fn gen_changelog_lint_list<'a>(lints: impl Iterator<Item = &'a Lint>) -> Vec<String> {
118 .sorted_by_key(|l| &l.name)
119 .map(|l| format!("[`{}`]: {}#{}", l.name, DOCS_LINK, l.name))
123 /// Generates the `register_removed` code in `./clippy_lints/src/lib.rs`.
125 pub fn gen_deprecated<'a>(lints: impl Iterator<Item = &'a Lint>) -> Vec<String> {
132 " store.register_removed(".to_string(),
133 format!(" \"clippy::{}\",", l.name),
134 format!(" \"{}\",", depr_text),
138 .expect("only deprecated lints should be passed")
140 .collect::<Vec<String>>()
144 pub fn gen_register_lint_list<'a>(lints: impl Iterator<Item = &'a Lint>) -> Vec<String> {
145 let pre = " store.register_lints(&[".to_string();
146 let post = " ]);".to_string();
147 let mut inner = lints
148 .map(|l| format!(" &{}::{},", l.module, l.name.to_uppercase()))
150 .collect::<Vec<String>>();
151 inner.insert(0, pre);
156 /// Gathers all files in `src/clippy_lints` and gathers all lints inside
157 pub fn gather_all() -> impl Iterator<Item = Lint> {
158 lint_files().flat_map(|f| gather_from_file(&f))
161 fn gather_from_file(dir_entry: &walkdir::DirEntry) -> impl Iterator<Item = Lint> {
162 let content = fs::read_to_string(dir_entry.path()).unwrap();
163 let path = dir_entry.path();
164 let filename = path.file_stem().unwrap();
165 let path_buf = path.with_file_name(filename);
166 let mut rel_path = path_buf
167 .strip_prefix(clippy_project_root().join("clippy_lints/src"))
168 .expect("only files in `clippy_lints/src` should be looked at");
169 // If the lints are stored in mod.rs, we get the module name from
170 // the containing directory:
171 if filename == "mod" {
172 rel_path = rel_path.parent().unwrap();
175 let module = rel_path
177 .map(|c| c.as_os_str().to_str().unwrap())
181 parse_contents(&content, &module)
184 fn parse_contents(content: &str, module: &str) -> impl Iterator<Item = Lint> {
185 let lints = DEC_CLIPPY_LINT_RE
186 .captures_iter(content)
187 .map(|m| Lint::new(&m["name"], &m["cat"], &m["desc"], None, module));
188 let deprecated = DEC_DEPRECATED_LINT_RE
189 .captures_iter(content)
190 .map(|m| Lint::new(&m["name"], "Deprecated", &m["desc"], Some(&m["desc"]), module));
191 // Removing the `.collect::<Vec<Lint>>().into_iter()` causes some lifetime issues due to the map
192 lints.chain(deprecated).collect::<Vec<Lint>>().into_iter()
195 /// Collects all .rs files in the `clippy_lints/src` directory
196 fn lint_files() -> impl Iterator<Item = walkdir::DirEntry> {
197 // We use `WalkDir` instead of `fs::read_dir` here in order to recurse into subdirectories.
198 // Otherwise we would not collect all the lints, for example in `clippy_lints/src/methods/`.
199 let path = clippy_project_root().join("clippy_lints/src");
202 .filter_map(Result::ok)
203 .filter(|f| f.path().extension() == Some(OsStr::new("rs")))
206 /// Whether a file has had its text changed or not
207 #[derive(PartialEq, Debug)]
208 pub struct FileChange {
210 pub new_lines: String,
213 /// Replaces a region in a file delimited by two lines matching regexes.
215 /// `path` is the relative path to the file on which you want to perform the replacement.
217 /// See `replace_region_in_text` for documentation of the other options.
218 pub fn replace_region_in_file<F>(
227 F: FnOnce() -> Vec<String>,
229 let contents = fs::read_to_string(path).unwrap_or_else(|e| panic!("Cannot read from {}: {}", path.display(), e));
230 let file_change = replace_region_in_text(&contents, start, end, replace_start, replacements);
233 if let Err(e) = fs::write(path, file_change.new_lines.as_bytes()) {
234 panic!("Cannot write to {}: {}", path.display(), e);
240 /// Replaces a region in a text delimited by two lines matching regexes.
242 /// * `text` is the input text on which you want to perform the replacement
243 /// * `start` is a `&str` that describes the delimiter line before the region you want to replace.
244 /// As the `&str` will be converted to a `Regex`, this can contain regex syntax, too.
245 /// * `end` is a `&str` that describes the delimiter line until where the replacement should happen.
246 /// As the `&str` will be converted to a `Regex`, this can contain regex syntax, too.
247 /// * If `replace_start` is true, the `start` delimiter line is replaced as well. The `end`
248 /// delimiter line is never replaced.
249 /// * `replacements` is a closure that has to return a `Vec<String>` which contains the new text.
251 /// If you want to perform the replacement on files instead of already parsed text,
252 /// use `replace_region_in_file`.
257 /// let the_text = "replace_start\nsome text\nthat will be replaced\nreplace_end";
259 /// clippy_dev::replace_region_in_text(the_text, "replace_start", "replace_end", false, || {
260 /// vec!["a different".to_string(), "text".to_string()]
263 /// assert_eq!("replace_start\na different\ntext\nreplace_end", result);
265 pub fn replace_region_in_text<F>(text: &str, start: &str, end: &str, replace_start: bool, replacements: F) -> FileChange
267 F: FnOnce() -> Vec<String>,
269 let replace_it = replacements();
270 let mut in_old_region = false;
271 let mut found = false;
272 let mut new_lines = vec![];
273 let start = Regex::new(start).unwrap();
274 let end = Regex::new(end).unwrap();
276 for line in text.lines() {
278 if end.is_match(line) {
279 in_old_region = false;
280 new_lines.extend(replace_it.clone());
281 new_lines.push(line.to_string());
283 } else if start.is_match(line) {
285 new_lines.push(line.to_string());
287 in_old_region = true;
290 new_lines.push(line.to_string());
295 // This happens if the provided regex in `clippy_dev/src/main.rs` does not match in the
296 // given text or file. Most likely this is an error on the programmer's side and the Regex
298 eprintln!("error: regex \n{:?}\ndoesn't match. You may have to update it.", start);
299 std::process::exit(1);
302 let mut new_lines = new_lines.join("\n");
303 if text.ends_with('\n') {
304 new_lines.push('\n');
306 let changed = new_lines != text;
307 FileChange { changed, new_lines }
310 /// Returns the path to the Clippy project directory
312 pub fn clippy_project_root() -> PathBuf {
313 let current_dir = std::env::current_dir().unwrap();
314 for path in current_dir.ancestors() {
315 let result = std::fs::read_to_string(path.join("Cargo.toml"));
316 if let Err(err) = &result {
317 if err.kind() == std::io::ErrorKind::NotFound {
322 let content = result.unwrap();
323 if content.contains("[package]\nname = \"clippy\"") {
324 return path.to_path_buf();
327 panic!("error: Can't determine root of project. Please run inside a Clippy working dir.");
331 fn test_parse_contents() {
332 let result: Vec<Lint> = parse_contents(
334 declare_clippy_lint! {
341 declare_clippy_lint!{
348 declare_deprecated_lint! {
349 pub SHOULD_ASSERT_EQ,
350 "`assert!()` will be more flexible with RFC 2011"
358 Lint::new("ptr_arg", "style", "really long text", None, "module_name"),
359 Lint::new("doc_markdown", "pedantic", "single line", None, "module_name"),
363 "`assert!()` will be more flexible with RFC 2011",
364 Some("`assert!()` will be more flexible with RFC 2011"),
368 assert_eq!(expected, result);
372 fn test_replace_region() {
373 let text = "\nabc\n123\n789\ndef\nghi";
374 let expected = FileChange {
376 new_lines: "\nabc\nhello world\ndef\nghi".to_string(),
378 let result = replace_region_in_text(text, r#"^\s*abc$"#, r#"^\s*def"#, false, || {
379 vec!["hello world".to_string()]
381 assert_eq!(expected, result);
385 fn test_replace_region_with_start() {
386 let text = "\nabc\n123\n789\ndef\nghi";
387 let expected = FileChange {
389 new_lines: "\nhello world\ndef\nghi".to_string(),
391 let result = replace_region_in_text(text, r#"^\s*abc$"#, r#"^\s*def"#, true, || {
392 vec!["hello world".to_string()]
394 assert_eq!(expected, result);
398 fn test_replace_region_no_changes() {
399 let text = "123\n456\n789";
400 let expected = FileChange {
402 new_lines: "123\n456\n789".to_string(),
404 let result = replace_region_in_text(text, r#"^\s*123$"#, r#"^\s*456"#, false, Vec::new);
405 assert_eq!(expected, result);
409 fn test_usable_lints() {
411 Lint::new("should_assert_eq", "Deprecated", "abc", Some("Reason"), "module_name"),
412 Lint::new("should_assert_eq2", "Not Deprecated", "abc", None, "module_name"),
413 Lint::new("should_assert_eq2", "internal", "abc", None, "module_name"),
414 Lint::new("should_assert_eq2", "internal_style", "abc", None, "module_name"),
416 let expected = vec![Lint::new(
423 assert_eq!(expected, Lint::usable_lints(&lints));
427 fn test_by_lint_group() {
429 Lint::new("should_assert_eq", "group1", "abc", None, "module_name"),
430 Lint::new("should_assert_eq2", "group2", "abc", None, "module_name"),
431 Lint::new("incorrect_match", "group1", "abc", None, "module_name"),
433 let mut expected: HashMap<String, Vec<Lint>> = HashMap::new();
435 "group1".to_string(),
437 Lint::new("should_assert_eq", "group1", "abc", None, "module_name"),
438 Lint::new("incorrect_match", "group1", "abc", None, "module_name"),
442 "group2".to_string(),
443 vec![Lint::new("should_assert_eq2", "group2", "abc", None, "module_name")],
445 assert_eq!(expected, Lint::by_lint_group(lints.into_iter()));
449 fn test_gen_changelog_lint_list() {
451 Lint::new("should_assert_eq", "group1", "abc", None, "module_name"),
452 Lint::new("should_assert_eq2", "group2", "abc", None, "module_name"),
455 format!("[`should_assert_eq`]: {}#should_assert_eq", DOCS_LINK.to_string()),
456 format!("[`should_assert_eq2`]: {}#should_assert_eq2", DOCS_LINK.to_string()),
458 assert_eq!(expected, gen_changelog_lint_list(lints.iter()));
462 fn test_gen_deprecated() {
468 Some("has been superseded by should_assert_eq2"),
472 "another_deprecated",
475 Some("will be removed"),
479 let expected: Vec<String> = vec![
480 " store.register_removed(",
481 " \"clippy::should_assert_eq\",",
482 " \"has been superseded by should_assert_eq2\",",
484 " store.register_removed(",
485 " \"clippy::another_deprecated\",",
486 " \"will be removed\",",
492 assert_eq!(expected, gen_deprecated(lints.iter()));
497 fn test_gen_deprecated_fail() {
498 let lints = vec![Lint::new("should_assert_eq2", "group2", "abc", None, "module_name")];
499 let _ = gen_deprecated(lints.iter());
503 fn test_gen_modules_list() {
505 Lint::new("should_assert_eq", "group1", "abc", None, "module_name"),
506 Lint::new("incorrect_stuff", "group3", "abc", None, "another_module"),
508 let expected = vec!["mod another_module;".to_string(), "mod module_name;".to_string()];
509 assert_eq!(expected, gen_modules_list(lints.iter()));
513 fn test_gen_lint_group_list() {
515 Lint::new("abc", "group1", "abc", None, "module_name"),
516 Lint::new("should_assert_eq", "group1", "abc", None, "module_name"),
517 Lint::new("internal", "internal_style", "abc", None, "module_name"),
520 " LintId::of(&module_name::ABC),".to_string(),
521 " LintId::of(&module_name::INTERNAL),".to_string(),
522 " LintId::of(&module_name::SHOULD_ASSERT_EQ),".to_string(),
524 assert_eq!(expected, gen_lint_group_list(lints.iter()));