2019-07-15 05:35:02 +00:00
|
|
|
#![cfg_attr(feature = "deny-warnings", deny(warnings))]
|
2020-06-13 16:22:38 +00:00
|
|
|
// warn on lints, that are included in `rust-lang/rust`s bootstrap
|
|
|
|
#![warn(rust_2018_idioms, unused_lifetimes)]
|
2019-07-15 05:35:02 +00:00
|
|
|
|
2020-02-21 08:39:38 +00:00
|
|
|
use rustc_tools_util::VersionInfo;
|
2020-04-15 16:06:57 +00:00
|
|
|
use std::env;
|
|
|
|
use std::path::PathBuf;
|
|
|
|
use std::process::{self, Command};
|
2018-09-06 06:19:47 +00:00
|
|
|
|
2016-10-24 14:04:00 +00:00
|
|
|
const CARGO_CLIPPY_HELP: &str = r#"Checks a package to catch common mistakes and improve your Rust code.
|
2016-10-24 13:31:11 +00:00
|
|
|
|
|
|
|
Usage:
|
|
|
|
cargo clippy [options] [--] [<opts>...]
|
|
|
|
|
|
|
|
Common options:
|
2021-09-08 18:34:00 +00:00
|
|
|
--no-deps Run Clippy only on the given crate, without linting the dependencies
|
2021-07-26 14:14:29 +00:00
|
|
|
--fix Automatically apply lint suggestions. This flag implies `--no-deps`
|
2016-10-24 13:31:11 +00:00
|
|
|
-h, --help Print this message
|
2016-11-08 12:54:08 +00:00
|
|
|
-V, --version Print version info and exit
|
2016-10-24 13:31:11 +00:00
|
|
|
|
2018-03-28 22:17:48 +00:00
|
|
|
Other options are the same as `cargo check`.
|
2016-10-24 13:31:11 +00:00
|
|
|
|
2016-10-25 13:09:56 +00:00
|
|
|
To allow or deny a lint from the command line you can use `cargo clippy --`
|
|
|
|
with:
|
2016-10-24 13:31:11 +00:00
|
|
|
|
|
|
|
-W --warn OPT Set lint warnings
|
|
|
|
-A --allow OPT Set lint allowed
|
|
|
|
-D --deny OPT Set lint denied
|
2016-10-24 14:04:00 +00:00
|
|
|
-F --forbid OPT Set lint forbidden
|
|
|
|
|
2018-12-25 16:11:57 +00:00
|
|
|
You can use tool lints to allow or deny lints from your code, eg.:
|
2016-10-24 14:04:00 +00:00
|
|
|
|
2018-12-25 16:11:57 +00:00
|
|
|
#[allow(clippy::needless_lifetimes)]
|
2016-10-24 14:04:00 +00:00
|
|
|
"#;
|
2016-10-24 13:31:11 +00:00
|
|
|
|
2016-10-24 14:29:36 +00:00
|
|
|
fn show_help() {
|
|
|
|
println!("{}", CARGO_CLIPPY_HELP);
|
|
|
|
}
|
|
|
|
|
2016-11-08 13:28:46 +00:00
|
|
|
fn show_version() {
|
2018-09-06 06:19:47 +00:00
|
|
|
let version_info = rustc_tools_util::get_version_info!();
|
|
|
|
println!("{}", version_info);
|
2016-11-08 13:28:46 +00:00
|
|
|
}
|
|
|
|
|
2016-05-24 16:25:25 +00:00
|
|
|
pub fn main() {
|
2016-11-08 12:54:08 +00:00
|
|
|
// Check for version and help flags even when invoked as 'cargo-clippy'
|
2020-04-15 16:06:57 +00:00
|
|
|
if env::args().any(|a| a == "--help" || a == "-h") {
|
2016-11-08 12:54:08 +00:00
|
|
|
show_help();
|
|
|
|
return;
|
|
|
|
}
|
2018-09-06 06:19:47 +00:00
|
|
|
|
2020-04-15 16:06:57 +00:00
|
|
|
if env::args().any(|a| a == "--version" || a == "-V") {
|
2016-11-08 13:28:46 +00:00
|
|
|
show_version();
|
2016-11-08 12:54:08 +00:00
|
|
|
return;
|
|
|
|
}
|
2016-05-24 16:25:25 +00:00
|
|
|
|
2020-04-15 16:06:57 +00:00
|
|
|
if let Err(code) = process(env::args().skip(2)) {
|
|
|
|
process::exit(code);
|
2016-05-24 16:25:25 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-04-15 16:06:57 +00:00
|
|
|
struct ClippyCmd {
|
2020-04-15 19:31:40 +00:00
|
|
|
cargo_subcommand: &'static str,
|
2020-04-15 16:06:57 +00:00
|
|
|
args: Vec<String>,
|
2020-12-22 18:17:59 +00:00
|
|
|
clippy_args: Vec<String>,
|
2020-04-15 16:06:57 +00:00
|
|
|
}
|
|
|
|
|
2020-04-15 20:04:04 +00:00
|
|
|
impl ClippyCmd {
|
2020-12-13 16:21:53 +00:00
|
|
|
fn new<I>(mut old_args: I) -> Self
|
2020-04-15 16:06:57 +00:00
|
|
|
where
|
|
|
|
I: Iterator<Item = String>,
|
|
|
|
{
|
2020-04-15 19:31:40 +00:00
|
|
|
let mut cargo_subcommand = "check";
|
2020-04-15 16:06:57 +00:00
|
|
|
let mut args = vec![];
|
2021-07-27 09:13:42 +00:00
|
|
|
let mut clippy_args: Vec<String> = vec![];
|
2020-04-15 16:06:57 +00:00
|
|
|
|
|
|
|
for arg in old_args.by_ref() {
|
|
|
|
match arg.as_str() {
|
|
|
|
"--fix" => {
|
2020-04-15 19:31:40 +00:00
|
|
|
cargo_subcommand = "fix";
|
2020-04-15 16:06:57 +00:00
|
|
|
continue;
|
2020-04-15 20:08:33 +00:00
|
|
|
},
|
2021-07-27 09:13:42 +00:00
|
|
|
"--no-deps" => {
|
|
|
|
clippy_args.push("--no-deps".into());
|
|
|
|
continue;
|
|
|
|
},
|
2020-04-15 16:06:57 +00:00
|
|
|
"--" => break,
|
2020-04-15 20:08:33 +00:00
|
|
|
_ => {},
|
2020-04-15 16:06:57 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
args.push(arg);
|
|
|
|
}
|
|
|
|
|
2021-07-27 09:13:42 +00:00
|
|
|
clippy_args.append(&mut (old_args.collect()));
|
2020-12-22 18:17:59 +00:00
|
|
|
if cargo_subcommand == "fix" && !clippy_args.iter().any(|arg| arg == "--no-deps") {
|
|
|
|
clippy_args.push("--no-deps".into());
|
2020-11-27 15:53:30 +00:00
|
|
|
}
|
2020-04-15 16:06:57 +00:00
|
|
|
|
|
|
|
ClippyCmd {
|
2020-04-15 19:31:40 +00:00
|
|
|
cargo_subcommand,
|
2020-04-15 16:06:57 +00:00
|
|
|
args,
|
2020-12-22 18:17:59 +00:00
|
|
|
clippy_args,
|
2020-04-15 16:06:57 +00:00
|
|
|
}
|
2016-05-24 16:25:25 +00:00
|
|
|
}
|
2018-03-28 09:50:17 +00:00
|
|
|
|
2020-04-15 21:25:42 +00:00
|
|
|
fn path() -> PathBuf {
|
2020-04-15 16:06:57 +00:00
|
|
|
let mut path = env::current_exe()
|
|
|
|
.expect("current executable path invalid")
|
|
|
|
.with_file_name("clippy-driver");
|
2020-03-27 19:47:57 +00:00
|
|
|
|
2020-04-15 16:06:57 +00:00
|
|
|
if cfg!(windows) {
|
|
|
|
path.set_extension("exe");
|
|
|
|
}
|
|
|
|
|
|
|
|
path
|
|
|
|
}
|
2016-05-27 13:31:19 +00:00
|
|
|
|
2020-12-22 18:17:59 +00:00
|
|
|
fn into_std_cmd(self) -> Command {
|
2020-04-15 16:06:57 +00:00
|
|
|
let mut cmd = Command::new("cargo");
|
2020-12-22 18:17:59 +00:00
|
|
|
let clippy_args: String = self
|
|
|
|
.clippy_args
|
|
|
|
.iter()
|
|
|
|
.map(|arg| format!("{}__CLIPPY_HACKERY__", arg))
|
|
|
|
.collect();
|
2020-04-15 16:06:57 +00:00
|
|
|
|
2021-02-06 18:38:27 +00:00
|
|
|
cmd.env("RUSTC_WORKSPACE_WRAPPER", Self::path())
|
2020-12-22 18:17:59 +00:00
|
|
|
.env("CLIPPY_ARGS", clippy_args)
|
2020-04-15 19:31:40 +00:00
|
|
|
.arg(self.cargo_subcommand)
|
2020-04-15 16:06:57 +00:00
|
|
|
.args(&self.args);
|
|
|
|
|
|
|
|
cmd
|
2019-01-26 09:10:13 +00:00
|
|
|
}
|
2020-04-15 16:06:57 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
fn process<I>(old_args: I) -> Result<(), i32>
|
|
|
|
where
|
|
|
|
I: Iterator<Item = String>,
|
|
|
|
{
|
2020-12-13 16:21:53 +00:00
|
|
|
let cmd = ClippyCmd::new(old_args);
|
2020-04-15 16:06:57 +00:00
|
|
|
|
2020-12-22 18:17:59 +00:00
|
|
|
let mut cmd = cmd.into_std_cmd();
|
2019-01-26 09:10:13 +00:00
|
|
|
|
2020-04-15 16:06:57 +00:00
|
|
|
let exit_status = cmd
|
2016-12-20 09:20:41 +00:00
|
|
|
.spawn()
|
|
|
|
.expect("could not run cargo")
|
|
|
|
.wait()
|
|
|
|
.expect("failed to wait for cargo?");
|
2016-05-27 13:31:19 +00:00
|
|
|
|
2016-06-06 09:28:09 +00:00
|
|
|
if exit_status.success() {
|
|
|
|
Ok(())
|
|
|
|
} else {
|
2016-06-06 14:43:58 +00:00
|
|
|
Err(exit_status.code().unwrap_or(-1))
|
2016-05-27 13:31:19 +00:00
|
|
|
}
|
2016-05-24 16:25:25 +00:00
|
|
|
}
|
2020-04-15 16:20:41 +00:00
|
|
|
|
|
|
|
#[cfg(test)]
|
|
|
|
mod tests {
|
2020-04-15 21:25:42 +00:00
|
|
|
use super::ClippyCmd;
|
2020-04-15 16:20:41 +00:00
|
|
|
|
|
|
|
#[test]
|
2021-06-26 01:41:56 +00:00
|
|
|
fn fix() {
|
2020-04-15 16:20:41 +00:00
|
|
|
let args = "cargo clippy --fix".split_whitespace().map(ToString::to_string);
|
2020-12-13 16:21:53 +00:00
|
|
|
let cmd = ClippyCmd::new(args);
|
2020-04-15 19:31:40 +00:00
|
|
|
assert_eq!("fix", cmd.cargo_subcommand);
|
2021-06-26 01:41:56 +00:00
|
|
|
assert!(!cmd.args.iter().any(|arg| arg.ends_with("unstable-options")));
|
2020-04-15 16:20:41 +00:00
|
|
|
}
|
|
|
|
|
2020-11-27 15:53:30 +00:00
|
|
|
#[test]
|
|
|
|
fn fix_implies_no_deps() {
|
2021-06-26 01:41:56 +00:00
|
|
|
let args = "cargo clippy --fix".split_whitespace().map(ToString::to_string);
|
2020-12-13 16:21:53 +00:00
|
|
|
let cmd = ClippyCmd::new(args);
|
2020-12-22 18:17:59 +00:00
|
|
|
assert!(cmd.clippy_args.iter().any(|arg| arg == "--no-deps"));
|
2020-11-27 15:53:30 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn no_deps_not_duplicated_with_fix() {
|
2021-06-26 01:41:56 +00:00
|
|
|
let args = "cargo clippy --fix -- --no-deps"
|
2020-11-27 15:53:30 +00:00
|
|
|
.split_whitespace()
|
|
|
|
.map(ToString::to_string);
|
2020-12-13 16:21:53 +00:00
|
|
|
let cmd = ClippyCmd::new(args);
|
2020-12-22 18:17:59 +00:00
|
|
|
assert_eq!(cmd.clippy_args.iter().filter(|arg| *arg == "--no-deps").count(), 1);
|
2020-11-27 15:53:30 +00:00
|
|
|
}
|
|
|
|
|
2020-04-15 16:20:41 +00:00
|
|
|
#[test]
|
|
|
|
fn check() {
|
|
|
|
let args = "cargo clippy".split_whitespace().map(ToString::to_string);
|
2020-12-13 16:21:53 +00:00
|
|
|
let cmd = ClippyCmd::new(args);
|
2020-04-15 19:31:40 +00:00
|
|
|
assert_eq!("check", cmd.cargo_subcommand);
|
2020-04-15 16:20:41 +00:00
|
|
|
}
|
|
|
|
}
|