Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add --fix support to cargo-clippy #5363

Merged
merged 13 commits into from
Apr 15, 2020
190 changes: 149 additions & 41 deletions src/main.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
#![cfg_attr(feature = "deny-warnings", deny(warnings))]

use rustc_tools_util::VersionInfo;
use std::env;
use std::path::PathBuf;
use std::process::{self, Command};
use std::ffi::OsString;

const CARGO_CLIPPY_HELP: &str = r#"Checks a package to catch common mistakes and improve your Rust code.

Expand Down Expand Up @@ -37,68 +41,135 @@ fn show_version() {

pub fn main() {
// Check for version and help flags even when invoked as 'cargo-clippy'
if std::env::args().any(|a| a == "--help" || a == "-h") {
if env::args().any(|a| a == "--help" || a == "-h") {
show_help();
return;
}

if std::env::args().any(|a| a == "--version" || a == "-V") {
if env::args().any(|a| a == "--version" || a == "-V") {
show_version();
return;
}

if let Err(code) = process(std::env::args().skip(2)) {
std::process::exit(code);
if let Err(code) = process(env::args().skip(2)) {
process::exit(code);
}
}

fn process<I>(mut old_args: I) -> Result<(), i32>
where
I: Iterator<Item = String>,
struct ClippyCmd {
unstable_options: bool,
cmd: &'static str,
args: Vec<String>,
clippy_args: String
}

impl ClippyCmd
{
let mut args = vec!["check".to_owned()];
fn new<I>(mut old_args: I) -> Self
where
I: Iterator<Item = String>,
{
let mut cmd = "check";
yaahc marked this conversation as resolved.
Show resolved Hide resolved
let mut unstable_options = false;
let mut args = vec![];

for arg in old_args.by_ref() {
match arg.as_str() {
"--fix" => {
cmd = "fix";
continue;
}
"--" => break,
// Cover -Zunstable-options and -Z unstable-options
s if s.ends_with("unstable-options") => unstable_options = true,
_ => {}
}

args.push(arg);
}

if cmd == "fix" && !unstable_options {
panic!("Usage of `--fix` requires `-Z unstable-options`");
}

// Run the dogfood tests directly on nightly cargo. This is required due
// to a bug in rustup.rs when running cargo on custom toolchains. See issue #3118.
if env::var_os("CLIPPY_DOGFOOD").is_some() && cfg!(windows) {
args.insert(0, "+nightly".to_string());
}

for arg in old_args.by_ref() {
if arg == "--" {
break;
let clippy_args: String =
old_args
.map(|arg| format!("{}__CLIPPY_HACKERY__", arg))
.collect();

ClippyCmd {
unstable_options,
cmd,
args,
clippy_args,
}
args.push(arg);
}

let clippy_args: String = old_args.map(|arg| format!("{}__CLIPPY_HACKERY__", arg)).collect();
fn path_env(&self) -> &'static str {
if self.unstable_options {
"RUSTC_WORKSPACE_WRAPPER"
} else {
"RUSTC_WRAPPER"
}
}
yaahc marked this conversation as resolved.
Show resolved Hide resolved

let mut path = std::env::current_exe()
.expect("current executable path invalid")
.with_file_name("clippy-driver");
if cfg!(windows) {
path.set_extension("exe");
fn path(&self) -> PathBuf {
yaahc marked this conversation as resolved.
Show resolved Hide resolved
let mut path = env::current_exe()
.expect("current executable path invalid")
.with_file_name("clippy-driver");

if cfg!(windows) {
path.set_extension("exe");
}

path
}

fn target_dir() -> Option<(&'static str, OsString)> {
env::var_os("CLIPPY_DOGFOOD")
.map(|_| {
env::var_os("CARGO_MANIFEST_DIR").map_or_else(
|| std::ffi::OsString::from("clippy_dogfood"),
|d| {
std::path::PathBuf::from(d)
.join("target")
.join("dogfood")
.into_os_string()
},
)
})
.map(|p| ("CARGO_TARGET_DIR", p))
}

let target_dir = std::env::var_os("CLIPPY_DOGFOOD")
.map(|_| {
std::env::var_os("CARGO_MANIFEST_DIR").map_or_else(
|| std::ffi::OsString::from("clippy_dogfood"),
|d| {
std::path::PathBuf::from(d)
.join("target")
.join("dogfood")
.into_os_string()
},
)
})
.map(|p| ("CARGO_TARGET_DIR", p));

// Run the dogfood tests directly on nightly cargo. This is required due
// to a bug in rustup.rs when running cargo on custom toolchains. See issue #3118.
if std::env::var_os("CLIPPY_DOGFOOD").is_some() && cfg!(windows) {
args.insert(0, "+nightly".to_string());
fn to_std_cmd(self) -> Command {
yaahc marked this conversation as resolved.
Show resolved Hide resolved
let mut cmd = Command::new("cargo");

cmd.env(self.path_env(), self.path())
yaahc marked this conversation as resolved.
Show resolved Hide resolved
.envs(ClippyCmd::target_dir())
.env("CLIPPY_ARGS", self.clippy_args)
.arg(self.cmd)
.args(&self.args);

cmd
}
}


let exit_status = std::process::Command::new("cargo")
.args(&args)
.env("RUSTC_WRAPPER", path)
.env("CLIPPY_ARGS", clippy_args)
.envs(target_dir)
fn process<I>(old_args: I) -> Result<(), i32>
where
I: Iterator<Item = String>,
{
let cmd = ClippyCmd::new(old_args);

let mut cmd = cmd.to_std_cmd();
yaahc marked this conversation as resolved.
Show resolved Hide resolved

let exit_status = cmd
.spawn()
.expect("could not run cargo")
.wait()
Expand All @@ -110,3 +181,40 @@ where
Err(exit_status.code().unwrap_or(-1))
}
}

#[cfg(test)]
mod tests {
use super::*;
yaahc marked this conversation as resolved.
Show resolved Hide resolved

#[test]
#[should_panic]
fn fix_without_unstable() {
let args = "cargo clippy --fix".split_whitespace().map(ToString::to_string);
let _ = ClippyCmd::new(args);
}

#[test]
fn fix_unstable() {
let args = "cargo clippy --fix -Zunstable-options".split_whitespace().map(ToString::to_string);
let cmd = ClippyCmd::new(args);
assert_eq!("fix", cmd.cmd);
assert_eq!("RUSTC_WORKSPACE_WRAPPER", cmd.path_env());
assert!(cmd.args.iter().find(|arg| arg.ends_with("unstable-options")).is_some());
yaahc marked this conversation as resolved.
Show resolved Hide resolved
}

#[test]
fn check() {
let args = "cargo clippy".split_whitespace().map(ToString::to_string);
let cmd = ClippyCmd::new(args);
assert_eq!("check", cmd.cmd);
assert_eq!("RUSTC_WRAPPER", cmd.path_env());
}

#[test]
fn check_unstable() {
let args = "cargo clippy -Zunstable-options".split_whitespace().map(ToString::to_string);
let cmd = ClippyCmd::new(args);
assert_eq!("check", cmd.cmd);
assert_eq!("RUSTC_WORKSPACE_WRAPPER", cmd.path_env());
}
}