2 extern crate clippy_dev;
5 use clap::{App, Arg, SubCommand};
7 mod stderr_length_check;
16 let matches = App::new("Clippy developer tooling")
18 SubCommand::with_name("update_lints")
19 .about("Updates lint registration and information from the source code")
22 * the lint count in README.md is correct\n \
23 * the changelog contains markdown link references at the bottom\n \
24 * all lint groups include the correct lints\n \
25 * lint modules in `clippy_lints/*` are visible in `src/lib.rs` via `pub mod`\n \
26 * all lints are registered in the lint store",
28 .arg(Arg::with_name("print-only").long("print-only").help(
29 "Print a table of lints to STDOUT. \
30 This does not include deprecated and internal lints. \
31 (Does not modify any files)",
34 Arg::with_name("check")
36 .help("Checks that util/dev update_lints has been run. Used on CI."),
40 Arg::with_name("limit-stderr-length")
41 .long("limit-stderr-length")
42 .help("Ensures that stderr files do not grow longer than a certain amount of lines."),
46 if matches.is_present("limit-stderr-length") {
47 stderr_length_check::check();
49 if let Some(matches) = matches.subcommand_matches("update_lints") {
50 if matches.is_present("print-only") {
52 } else if matches.is_present("check") {
53 update_lints(&UpdateMode::Check);
55 update_lints(&UpdateMode::Change);
61 let lint_list = gather_all();
62 let usable_lints: Vec<Lint> = Lint::usable_lints(lint_list).collect();
63 let lint_count = usable_lints.len();
64 let grouped_by_lint_group = Lint::by_lint_group(&usable_lints);
66 for (lint_group, mut lints) in grouped_by_lint_group {
67 if lint_group == "Deprecated" {
70 println!("\n## {}", lint_group);
72 lints.sort_by_key(|l| l.name.clone());
78 clippy_dev::DOCS_LINK.clone(),
85 println!("there are {} lints", lint_count);
88 fn update_lints(update_mode: &UpdateMode) {
89 let lint_list: Vec<Lint> = gather_all().collect();
95 /// Lint data parsed from the Clippy source code.
96 #[derive(Clone, PartialEq, Debug)]
98 pub name: &'static str,
99 pub group: &'static str,
100 pub desc: &'static str,
101 pub deprecation: Option<&'static str>,
102 pub module: &'static str,
105 pub const ALL_LINTS: [Lint; {}] = {:#?};\n",
110 .expect("can write to file");
112 let usable_lints: Vec<Lint> = Lint::usable_lints(lint_list.clone().into_iter()).collect();
113 let lint_count = usable_lints.len();
115 let mut file_change = replace_region_in_file(
117 r#"\[There are \d+ lints included in this crate!\]\(https://rust-lang.github.io/rust-clippy/master/index.html\)"#,
120 update_mode == &UpdateMode::Change,
123 format!("[There are {} lints included in this crate!](https://rust-lang.github.io/rust-clippy/master/index.html)", lint_count)
128 file_change |= replace_region_in_file(
130 "<!-- begin autogenerated links to lint list -->",
131 "<!-- end autogenerated links to lint list -->",
133 update_mode == &UpdateMode::Change,
134 || gen_changelog_lint_list(lint_list.clone()),
138 file_change |= replace_region_in_file(
139 "../clippy_lints/src/lib.rs",
140 "begin deprecated lints",
141 "end deprecated lints",
143 update_mode == &UpdateMode::Change,
144 || gen_deprecated(&lint_list),
148 file_change |= replace_region_in_file(
149 "../clippy_lints/src/lib.rs",
150 "begin lints modules",
153 update_mode == &UpdateMode::Change,
154 || gen_modules_list(lint_list.clone()),
158 // Generate lists of lints in the clippy::all lint group
159 file_change |= replace_region_in_file(
160 "../clippy_lints/src/lib.rs",
161 r#"reg.register_lint_group\("clippy::all""#,
164 update_mode == &UpdateMode::Change,
166 // clippy::all should only include the following lint groups:
167 let all_group_lints = usable_lints
171 l.group == "correctness" || l.group == "style" || l.group == "complexity" || l.group == "perf"
175 gen_lint_group_list(all_group_lints)
180 // Generate the list of lints for all other lint groups
181 for (lint_group, lints) in Lint::by_lint_group(&usable_lints) {
182 file_change |= replace_region_in_file(
183 "../clippy_lints/src/lib.rs",
184 &format!("reg.register_lint_group\\(\"clippy::{}\"", lint_group),
187 update_mode == &UpdateMode::Change,
188 || gen_lint_group_list(lints.clone()),
193 if update_mode == &UpdateMode::Check && file_change {
195 "Not all lints defined properly. \
196 Please run `util/dev update_lints` to make sure all lints are defined properly."
198 std::process::exit(1);