1 #![cfg_attr(feature = "deny-warnings", deny(warnings))]
2 // warn on lints, that are included in `rust-lang/rust`s bootstrap
3 #![warn(rust_2018_idioms, unused_lifetimes)]
5 use clap::{App, AppSettings, Arg, ArgMatches, SubCommand};
6 use clippy_dev::{bless, fmt, new_lint, serve, setup, update_lints};
8 let matches = get_clap_config();
10 match matches.subcommand() {
11 ("bless", Some(matches)) => {
12 bless::bless(matches.is_present("ignore-timestamp"));
14 ("fmt", Some(matches)) => {
15 fmt::run(matches.is_present("check"), matches.is_present("verbose"));
17 ("update_lints", Some(matches)) => {
18 if matches.is_present("print-only") {
19 update_lints::print_lints();
20 } else if matches.is_present("check") {
21 update_lints::run(update_lints::UpdateMode::Check);
23 update_lints::run(update_lints::UpdateMode::Change);
26 ("new_lint", Some(matches)) => {
27 match new_lint::create(
28 matches.value_of("pass"),
29 matches.value_of("name"),
30 matches.value_of("category"),
32 Ok(_) => update_lints::run(update_lints::UpdateMode::Change),
33 Err(e) => eprintln!("Unable to create lint: {}", e),
36 ("setup", Some(sub_command)) => match sub_command.subcommand() {
37 ("intellij", Some(matches)) => setup::intellij::setup_rustc_src(
39 .value_of("rustc-repo-path")
40 .expect("this field is mandatory and therefore always valid"),
42 ("git-hook", Some(matches)) => setup::git_hook::install_hook(matches.is_present("force-override")),
43 ("vscode-tasks", Some(matches)) => setup::vscode::install_tasks(matches.is_present("force-override")),
46 ("remove", Some(sub_command)) => match sub_command.subcommand() {
47 ("git-hook", Some(_)) => setup::git_hook::remove_hook(),
48 ("intellij", Some(_)) => setup::intellij::remove_rustc_src(),
49 ("vscode-tasks", Some(_)) => setup::vscode::remove_tasks(),
52 ("serve", Some(matches)) => {
53 let port = matches.value_of("port").unwrap().parse().unwrap();
54 let lint = matches.value_of("lint");
55 serve::run(port, lint);
61 fn get_clap_config<'a>() -> ArgMatches<'a> {
62 App::new("Clippy developer tooling")
63 .setting(AppSettings::ArgRequiredElseHelp)
65 SubCommand::with_name("bless")
66 .about("bless the test output changes")
68 Arg::with_name("ignore-timestamp")
69 .long("ignore-timestamp")
70 .help("Include files updated before clippy was built"),
74 SubCommand::with_name("fmt")
75 .about("Run rustfmt on all projects and tests")
77 Arg::with_name("check")
79 .help("Use the rustfmt --check option"),
82 Arg::with_name("verbose")
85 .help("Echo commands run"),
89 SubCommand::with_name("update_lints")
90 .about("Updates lint registration and information from the source code")
93 * the lint count in README.md is correct\n \
94 * the changelog contains markdown link references at the bottom\n \
95 * all lint groups include the correct lints\n \
96 * lint modules in `clippy_lints/*` are visible in `src/lifb.rs` via `pub mod`\n \
97 * all lints are registered in the lint store",
99 .arg(Arg::with_name("print-only").long("print-only").help(
100 "Print a table of lints to STDOUT. \
101 This does not include deprecated and internal lints. \
102 (Does not modify any files)",
105 Arg::with_name("check")
107 .help("Checks that `cargo dev update_lints` has been run. Used on CI."),
111 SubCommand::with_name("new_lint")
112 .about("Create new lint and run `cargo dev update_lints`")
114 Arg::with_name("pass")
117 .help("Specify whether the lint runs during the early or late pass")
119 .possible_values(&["early", "late"])
123 Arg::with_name("name")
126 .help("Name of the new lint in snake case, ex: fn_too_long")
131 Arg::with_name("category")
134 .help("What category the lint belongs to")
135 .default_value("nursery")
153 SubCommand::with_name("setup")
154 .about("Support for setting up your personal development environment")
155 .setting(AppSettings::ArgRequiredElseHelp)
157 SubCommand::with_name("intellij")
158 .about("Alter dependencies so Intellij Rust can find rustc internals")
160 Arg::with_name("rustc-repo-path")
163 .help("The path to a rustc repo that will be used for setting the dependencies")
170 SubCommand::with_name("git-hook")
171 .about("Add a pre-commit git hook that formats your code to make it look pretty")
173 Arg::with_name("force-override")
174 .long("force-override")
176 .help("Forces the override of an existing git pre-commit hook")
181 SubCommand::with_name("vscode-tasks")
182 .about("Add several tasks to vscode for formatting, validation and testing")
184 Arg::with_name("force-override")
185 .long("force-override")
187 .help("Forces the override of existing vscode tasks")
193 SubCommand::with_name("remove")
194 .about("Support for undoing changes done by the setup command")
195 .setting(AppSettings::ArgRequiredElseHelp)
196 .subcommand(SubCommand::with_name("git-hook").about("Remove any existing pre-commit git hook"))
197 .subcommand(SubCommand::with_name("vscode-tasks").about("Remove any existing vscode tasks"))
199 SubCommand::with_name("intellij")
200 .about("Removes rustc source paths added via `cargo dev setup intellij`"),
204 SubCommand::with_name("serve")
205 .about("Launch a local 'ALL the Clippy Lints' website in a browser")
207 Arg::with_name("port")
210 .help("Local port for the http server")
211 .default_value("8000")
212 .validator_os(serve::validate_port),
214 .arg(Arg::with_name("lint").help("Which lint's page to load initially (optional)")),