1 #![cfg_attr(feature = "deny-warnings", deny(warnings))]
4 use itertools::Itertools;
6 use std::collections::HashMap;
9 use std::lazy::SyncLazy;
10 use std::path::{Path, PathBuf};
17 pub mod stderr_length_check;
20 static DEC_CLIPPY_LINT_RE: SyncLazy<Regex> = SyncLazy::new(|| {
23 declare_clippy_lint!\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*[})]
33 static DEC_DEPRECATED_LINT_RE: SyncLazy<Regex> = SyncLazy::new(|| {
36 declare_deprecated_lint!\s*[{(]\s*
38 \s+pub\s+(?P<name>[A-Z_][A-Z_0-9]*)\s*,\s*
39 "(?P<desc>(?:[^"\\]+|\\(?s).(?-s))*)"\s*[})]
44 static NL_ESCAPE_RE: SyncLazy<Regex> = SyncLazy::new(|| Regex::new(r#"\\\n\s*"#).unwrap());
46 pub static DOCS_LINK: &str = "https://rust-lang.github.io/rust-clippy/master/index.html";
48 /// Lint data parsed from the Clippy source code.
49 #[derive(Clone, PartialEq, Debug)]
54 pub deprecation: Option<String>,
60 pub fn new(name: &str, group: &str, desc: &str, deprecation: Option<&str>, module: &str) -> 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(),
70 /// Returns all non-deprecated lints and non-internal lints
72 pub fn usable_lints(lints: &[Self]) -> Vec<Self> {
75 .filter(|l| l.deprecation.is_none() && !l.group.starts_with("internal"))
80 /// Returns all internal lints (not `internal_warn` lints)
82 pub fn internal_lints(lints: &[Self]) -> Vec<Self> {
83 lints.iter().filter(|l| l.group == "internal").cloned().collect()
86 /// Returns all deprecated lints
88 pub fn deprecated_lints(lints: &[Self]) -> Vec<Self> {
89 lints.iter().filter(|l| l.deprecation.is_some()).cloned().collect()
92 /// Returns the lints in a `HashMap`, grouped by the different lint groups
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()
99 /// Generates the Vec items for `register_lint_group` calls in `clippy_lints/src/lib.rs`.
101 pub fn gen_lint_group_list<'a>(lints: impl Iterator<Item = &'a Lint>) -> Vec<String> {
103 .map(|l| format!(" LintId::of(&{}::{}),", l.module, l.name.to_uppercase()))
105 .collect::<Vec<String>>()
108 /// Generates the `pub mod module_name` list in `clippy_lints/src/lib.rs`.
110 pub fn gen_modules_list<'a>(lints: impl Iterator<Item = &'a Lint>) -> Vec<String> {
114 .map(|module| format!("mod {};", module))
116 .collect::<Vec<String>>()
119 /// Generates the list of lint links at the bottom of the README
121 pub fn gen_changelog_lint_list<'a>(lints: impl Iterator<Item = &'a Lint>) -> Vec<String> {
123 .sorted_by_key(|l| &l.name)
124 .map(|l| format!("[`{}`]: {}#{}", l.name, DOCS_LINK, l.name))
128 /// Generates the `register_removed` code in `./clippy_lints/src/lib.rs`.
130 pub fn gen_deprecated<'a>(lints: impl Iterator<Item = &'a Lint>) -> Vec<String> {
137 " store.register_removed(".to_string(),
138 format!(" \"clippy::{}\",", l.name),
139 format!(" \"{}\",", depr_text),
143 .expect("only deprecated lints should be passed")
145 .collect::<Vec<String>>()
149 pub fn gen_register_lint_list<'a>(
150 internal_lints: impl Iterator<Item = &'a Lint>,
151 usable_lints: impl Iterator<Item = &'a Lint>,
153 let header = " store.register_lints(&[".to_string();
154 let footer = " ]);".to_string();
155 let internal_lints = internal_lints
156 .sorted_by_key(|l| format!(" &{}::{},", l.module, l.name.to_uppercase()))
159 " #[cfg(feature = \"internal-lints\")]\n &{}::{},",
161 l.name.to_uppercase()
164 let other_lints = usable_lints
165 .sorted_by_key(|l| format!(" &{}::{},", l.module, l.name.to_uppercase()))
166 .map(|l| format!(" &{}::{},", l.module, l.name.to_uppercase()))
168 let mut lint_list = vec![header];
169 lint_list.extend(internal_lints);
170 lint_list.extend(other_lints);
171 lint_list.push(footer);
175 /// Gathers all files in `src/clippy_lints` and gathers all lints inside
176 pub fn gather_all() -> impl Iterator<Item = Lint> {
177 lint_files().flat_map(|f| gather_from_file(&f))
180 fn gather_from_file(dir_entry: &walkdir::DirEntry) -> impl Iterator<Item = Lint> {
181 let content = fs::read_to_string(dir_entry.path()).unwrap();
182 let path = dir_entry.path();
183 let filename = path.file_stem().unwrap();
184 let path_buf = path.with_file_name(filename);
185 let mut rel_path = path_buf
186 .strip_prefix(clippy_project_root().join("clippy_lints/src"))
187 .expect("only files in `clippy_lints/src` should be looked at");
188 // If the lints are stored in mod.rs, we get the module name from
189 // the containing directory:
190 if filename == "mod" {
191 rel_path = rel_path.parent().unwrap();
194 let module = rel_path
196 .map(|c| c.as_os_str().to_str().unwrap())
200 parse_contents(&content, &module)
203 fn parse_contents(content: &str, module: &str) -> impl Iterator<Item = Lint> {
204 let lints = DEC_CLIPPY_LINT_RE
205 .captures_iter(content)
206 .map(|m| Lint::new(&m["name"], &m["cat"], &m["desc"], None, module));
207 let deprecated = DEC_DEPRECATED_LINT_RE
208 .captures_iter(content)
209 .map(|m| Lint::new(&m["name"], "Deprecated", &m["desc"], Some(&m["desc"]), module));
210 // Removing the `.collect::<Vec<Lint>>().into_iter()` causes some lifetime issues due to the map
211 lints.chain(deprecated).collect::<Vec<Lint>>().into_iter()
214 /// Collects all .rs files in the `clippy_lints/src` directory
215 fn lint_files() -> impl Iterator<Item = walkdir::DirEntry> {
216 // We use `WalkDir` instead of `fs::read_dir` here in order to recurse into subdirectories.
217 // Otherwise we would not collect all the lints, for example in `clippy_lints/src/methods/`.
218 let path = clippy_project_root().join("clippy_lints/src");
221 .filter_map(Result::ok)
222 .filter(|f| f.path().extension() == Some(OsStr::new("rs")))
225 /// Whether a file has had its text changed or not
226 #[derive(PartialEq, Debug)]
227 pub struct FileChange {
229 pub new_lines: String,
232 /// Replaces a region in a file delimited by two lines matching regexes.
234 /// `path` is the relative path to the file on which you want to perform the replacement.
236 /// See `replace_region_in_text` for documentation of the other options.
237 pub fn replace_region_in_file<F>(
246 F: FnOnce() -> Vec<String>,
248 let contents = fs::read_to_string(path).unwrap_or_else(|e| panic!("Cannot read from {}: {}", path.display(), e));
249 let file_change = replace_region_in_text(&contents, start, end, replace_start, replacements);
252 if let Err(e) = fs::write(path, file_change.new_lines.as_bytes()) {
253 panic!("Cannot write to {}: {}", path.display(), e);
259 /// Replaces a region in a text delimited by two lines matching regexes.
261 /// * `text` is the input text on which you want to perform the replacement
262 /// * `start` is a `&str` that describes the delimiter line before the region you want to replace.
263 /// As the `&str` will be converted to a `Regex`, this can contain regex syntax, too.
264 /// * `end` is a `&str` that describes the delimiter line until where the replacement should happen.
265 /// As the `&str` will be converted to a `Regex`, this can contain regex syntax, too.
266 /// * If `replace_start` is true, the `start` delimiter line is replaced as well. The `end`
267 /// delimiter line is never replaced.
268 /// * `replacements` is a closure that has to return a `Vec<String>` which contains the new text.
270 /// If you want to perform the replacement on files instead of already parsed text,
271 /// use `replace_region_in_file`.
276 /// let the_text = "replace_start\nsome text\nthat will be replaced\nreplace_end";
278 /// clippy_dev::replace_region_in_text(the_text, "replace_start", "replace_end", false, || {
279 /// vec!["a different".to_string(), "text".to_string()]
282 /// assert_eq!("replace_start\na different\ntext\nreplace_end", result);
284 pub fn replace_region_in_text<F>(text: &str, start: &str, end: &str, replace_start: bool, replacements: F) -> FileChange
286 F: FnOnce() -> Vec<String>,
288 let replace_it = replacements();
289 let mut in_old_region = false;
290 let mut found = false;
291 let mut new_lines = vec![];
292 let start = Regex::new(start).unwrap();
293 let end = Regex::new(end).unwrap();
295 for line in text.lines() {
297 if end.is_match(line) {
298 in_old_region = false;
299 new_lines.extend(replace_it.clone());
300 new_lines.push(line.to_string());
302 } else if start.is_match(line) {
304 new_lines.push(line.to_string());
306 in_old_region = true;
309 new_lines.push(line.to_string());
314 // This happens if the provided regex in `clippy_dev/src/main.rs` does not match in the
315 // given text or file. Most likely this is an error on the programmer's side and the Regex
317 eprintln!("error: regex \n{:?}\ndoesn't match. You may have to update it.", start);
318 std::process::exit(1);
321 let mut new_lines = new_lines.join("\n");
322 if text.ends_with('\n') {
323 new_lines.push('\n');
325 let changed = new_lines != text;
326 FileChange { changed, new_lines }
329 /// Returns the path to the Clippy project directory
331 pub fn clippy_project_root() -> PathBuf {
332 let current_dir = std::env::current_dir().unwrap();
333 for path in current_dir.ancestors() {
334 let result = std::fs::read_to_string(path.join("Cargo.toml"));
335 if let Err(err) = &result {
336 if err.kind() == std::io::ErrorKind::NotFound {
341 let content = result.unwrap();
342 if content.contains("[package]\nname = \"clippy\"") {
343 return path.to_path_buf();
346 panic!("error: Can't determine root of project. Please run inside a Clippy working dir.");
350 fn test_parse_contents() {
351 let result: Vec<Lint> = parse_contents(
353 declare_clippy_lint! {
360 declare_clippy_lint!{
367 declare_deprecated_lint! {
368 pub SHOULD_ASSERT_EQ,
369 "`assert!()` will be more flexible with RFC 2011"
377 Lint::new("ptr_arg", "style", "really long text", None, "module_name"),
378 Lint::new("doc_markdown", "pedantic", "single line", None, "module_name"),
382 "`assert!()` will be more flexible with RFC 2011",
383 Some("`assert!()` will be more flexible with RFC 2011"),
387 assert_eq!(expected, result);
391 fn test_replace_region() {
392 let text = "\nabc\n123\n789\ndef\nghi";
393 let expected = FileChange {
395 new_lines: "\nabc\nhello world\ndef\nghi".to_string(),
397 let result = replace_region_in_text(text, r#"^\s*abc$"#, r#"^\s*def"#, false, || {
398 vec!["hello world".to_string()]
400 assert_eq!(expected, result);
404 fn test_replace_region_with_start() {
405 let text = "\nabc\n123\n789\ndef\nghi";
406 let expected = FileChange {
408 new_lines: "\nhello world\ndef\nghi".to_string(),
410 let result = replace_region_in_text(text, r#"^\s*abc$"#, r#"^\s*def"#, true, || {
411 vec!["hello world".to_string()]
413 assert_eq!(expected, result);
417 fn test_replace_region_no_changes() {
418 let text = "123\n456\n789";
419 let expected = FileChange {
421 new_lines: "123\n456\n789".to_string(),
423 let result = replace_region_in_text(text, r#"^\s*123$"#, r#"^\s*456"#, false, Vec::new);
424 assert_eq!(expected, result);
428 fn test_usable_lints() {
430 Lint::new("should_assert_eq", "Deprecated", "abc", Some("Reason"), "module_name"),
431 Lint::new("should_assert_eq2", "Not Deprecated", "abc", None, "module_name"),
432 Lint::new("should_assert_eq2", "internal", "abc", None, "module_name"),
433 Lint::new("should_assert_eq2", "internal_style", "abc", None, "module_name"),
435 let expected = vec![Lint::new(
442 assert_eq!(expected, Lint::usable_lints(&lints));
446 fn test_by_lint_group() {
448 Lint::new("should_assert_eq", "group1", "abc", None, "module_name"),
449 Lint::new("should_assert_eq2", "group2", "abc", None, "module_name"),
450 Lint::new("incorrect_match", "group1", "abc", None, "module_name"),
452 let mut expected: HashMap<String, Vec<Lint>> = HashMap::new();
454 "group1".to_string(),
456 Lint::new("should_assert_eq", "group1", "abc", None, "module_name"),
457 Lint::new("incorrect_match", "group1", "abc", None, "module_name"),
461 "group2".to_string(),
462 vec![Lint::new("should_assert_eq2", "group2", "abc", None, "module_name")],
464 assert_eq!(expected, Lint::by_lint_group(lints.into_iter()));
468 fn test_gen_changelog_lint_list() {
470 Lint::new("should_assert_eq", "group1", "abc", None, "module_name"),
471 Lint::new("should_assert_eq2", "group2", "abc", None, "module_name"),
474 format!("[`should_assert_eq`]: {}#should_assert_eq", DOCS_LINK.to_string()),
475 format!("[`should_assert_eq2`]: {}#should_assert_eq2", DOCS_LINK.to_string()),
477 assert_eq!(expected, gen_changelog_lint_list(lints.iter()));
481 fn test_gen_deprecated() {
487 Some("has been superseded by should_assert_eq2"),
491 "another_deprecated",
494 Some("will be removed"),
498 let expected: Vec<String> = vec![
499 " store.register_removed(",
500 " \"clippy::should_assert_eq\",",
501 " \"has been superseded by should_assert_eq2\",",
503 " store.register_removed(",
504 " \"clippy::another_deprecated\",",
505 " \"will be removed\",",
511 assert_eq!(expected, gen_deprecated(lints.iter()));
516 fn test_gen_deprecated_fail() {
517 let lints = vec![Lint::new("should_assert_eq2", "group2", "abc", None, "module_name")];
518 let _ = gen_deprecated(lints.iter());
522 fn test_gen_modules_list() {
524 Lint::new("should_assert_eq", "group1", "abc", None, "module_name"),
525 Lint::new("incorrect_stuff", "group3", "abc", None, "another_module"),
527 let expected = vec!["mod another_module;".to_string(), "mod module_name;".to_string()];
528 assert_eq!(expected, gen_modules_list(lints.iter()));
532 fn test_gen_lint_group_list() {
534 Lint::new("abc", "group1", "abc", None, "module_name"),
535 Lint::new("should_assert_eq", "group1", "abc", None, "module_name"),
536 Lint::new("internal", "internal_style", "abc", None, "module_name"),
539 " LintId::of(&module_name::ABC),".to_string(),
540 " LintId::of(&module_name::INTERNAL),".to_string(),
541 " LintId::of(&module_name::SHOULD_ASSERT_EQ),".to_string(),
543 assert_eq!(expected, gen_lint_group_list(lints.iter()));