clippy_dev/src/main.rs

   1 extern crate clap;
   2 extern crate clippy_dev;
   3 extern crate regex;
   4
   5 use clap::{App, Arg, SubCommand};
   6 use clippy_dev::*;
   7 mod stderr_length_check;
   8
   9 #[derive(PartialEq)]
  10 enum UpdateMode {
  11     Check,
  12     Change,
  13 }
  14
  15 fn main() {
  16     let matches = App::new("Clippy developer tooling")
  17         .subcommand(
  18             SubCommand::with_name("update_lints")
  19                 .about("Updates lint registration and information from the source code")
  20                 .long_about(
  21                     "Makes sure that:\n \
  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",
  27                 )
  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)",
  32                 ))
  33                 .arg(
  34                     Arg::with_name("check")
  35                         .long("check")
  36                         .help("Checks that util/dev update_lints has been run. Used on CI."),
  37                 ),
  38         )
  39         .arg(
  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."),
  43         )
  44         .get_matches();
  45
  46     if matches.is_present("limit-stderr-length") {
  47         stderr_length_check::check();
  48     }
  49     if let Some(matches) = matches.subcommand_matches("update_lints") {
  50         if matches.is_present("print-only") {
  51             print_lints();
  52         } else if matches.is_present("check") {
  53             update_lints(&UpdateMode::Check);
  54         } else {
  55             update_lints(&UpdateMode::Change);
  56         }
  57     }
  58 }
  59
  60 fn print_lints() {
  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);
  65
  66     for (lint_group, mut lints) in grouped_by_lint_group {
  67         if lint_group == "Deprecated" {
  68             continue;
  69         }
  70         println!("\n## {}", lint_group);
  71
  72         lints.sort_by_key(|l| l.name.clone());
  73
  74         for lint in lints {
  75             println!(
  76                 "* [{}]({}#{}) ({})",
  77                 lint.name,
  78                 clippy_dev::DOCS_LINK.clone(),
  79                 lint.name,
  80                 lint.desc
  81             );
  82         }
  83     }
  84
  85     println!("there are {} lints", lint_count);
  86 }
  87
  88 fn update_lints(update_mode: &UpdateMode) {
  89     let lint_list: Vec<Lint> = gather_all().collect();
  90
  91     let usable_lints: Vec<Lint> = Lint::usable_lints(lint_list.clone().into_iter()).collect();
  92     let lint_count = usable_lints.len();
  93
  94     let mut sorted_usable_lints = usable_lints.clone();
  95     sorted_usable_lints.sort_by_key(|lint| lint.name.clone());
  96
  97     std::fs::write(
  98         "../src/lintlist/mod.rs",
  99         &format!(
 100             "\
 101 //! This file is managed by `util/dev update_lints`. Do not edit.
 102
 103 pub mod lint;
 104 pub use lint::Level;
 105 pub use lint::Lint;
 106 pub use lint::LINT_LEVELS;
 107
 108 pub const ALL_LINTS: [Lint; {}] = {:#?};\n",
 109             sorted_usable_lints.len(),
 110             sorted_usable_lints
 111         ),
 112     )
 113     .expect("can write to file");
 114
 115     let mut file_change = replace_region_in_file(
 116         "../README.md",
 117         r#"\[There are \d+ lints included in this crate!\]\(https://rust-lang.github.io/rust-clippy/master/index.html\)"#,
 118         "",
 119         true,
 120         update_mode == &UpdateMode::Change,
 121         || {
 122             vec![
 123                 format!("[There are {} lints included in this crate!](https://rust-lang.github.io/rust-clippy/master/index.html)", lint_count)
 124             ]
 125         }
 126     ).changed;
 127
 128     file_change |= replace_region_in_file(
 129         "../CHANGELOG.md",
 130         "<!-- begin autogenerated links to lint list -->",
 131         "<!-- end autogenerated links to lint list -->",
 132         false,
 133         update_mode == &UpdateMode::Change,
 134         || gen_changelog_lint_list(lint_list.clone()),
 135     )
 136     .changed;
 137
 138     file_change |= replace_region_in_file(
 139         "../clippy_lints/src/lib.rs",
 140         "begin deprecated lints",
 141         "end deprecated lints",
 142         false,
 143         update_mode == &UpdateMode::Change,
 144         || gen_deprecated(&lint_list),
 145     )
 146     .changed;
 147
 148     file_change |= replace_region_in_file(
 149         "../clippy_lints/src/lib.rs",
 150         "begin lints modules",
 151         "end lints modules",
 152         false,
 153         update_mode == &UpdateMode::Change,
 154         || gen_modules_list(lint_list.clone()),
 155     )
 156     .changed;
 157
 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""#,
 162         r#"\]\);"#,
 163         false,
 164         update_mode == &UpdateMode::Change,
 165         || {
 166             // clippy::all should only include the following lint groups:
 167             let all_group_lints = usable_lints
 168                 .clone()
 169                 .into_iter()
 170                 .filter(|l| {
 171                     l.group == "correctness" || l.group == "style" || l.group == "complexity" || l.group == "perf"
 172                 })
 173                 .collect();
 174
 175             gen_lint_group_list(all_group_lints)
 176         },
 177     )
 178     .changed;
 179
 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),
 185             r#"\]\);"#,
 186             false,
 187             update_mode == &UpdateMode::Change,
 188             || gen_lint_group_list(lints.clone()),
 189         )
 190         .changed;
 191     }
 192
 193     if update_mode == &UpdateMode::Check && file_change {
 194         println!(
 195             "Not all lints defined properly. \
 196              Please run `util/dev update_lints` to make sure all lints are defined properly."
 197         );
 198         std::process::exit(1);
 199     }
 200 }