2017-09-18 10:47:33 +00:00
|
|
|
#![feature(rustc_private)]
|
2022-11-21 19:34:47 +00:00
|
|
|
#![feature(let_chains)]
|
2022-12-12 05:42:45 +00:00
|
|
|
#![feature(lazy_cell)]
|
2022-12-01 17:29:38 +00:00
|
|
|
#![feature(lint_reasons)]
|
2020-06-23 15:05:22 +00:00
|
|
|
#![cfg_attr(feature = "deny-warnings", deny(warnings))]
|
|
|
|
// warn on lints, that are included in `rust-lang/rust`s bootstrap
|
|
|
|
#![warn(rust_2018_idioms, unused_lifetimes)]
|
|
|
|
// warn on rustc internal lints
|
2021-04-27 17:00:36 +00:00
|
|
|
#![warn(rustc::internal)]
|
2017-09-18 10:47:33 +00:00
|
|
|
|
2018-09-15 07:21:58 +00:00
|
|
|
// FIXME: switch to something more ergonomic here, once available.
|
2019-01-31 01:15:29 +00:00
|
|
|
// (Currently there is no way to opt into sysroot crates without `extern crate`.)
|
2018-09-15 07:21:58 +00:00
|
|
|
extern crate rustc_driver;
|
2019-02-01 22:28:14 +00:00
|
|
|
extern crate rustc_interface;
|
2021-03-12 14:30:50 +00:00
|
|
|
extern crate rustc_session;
|
|
|
|
extern crate rustc_span;
|
2018-09-15 07:21:58 +00:00
|
|
|
|
2019-02-01 22:28:14 +00:00
|
|
|
use rustc_interface::interface;
|
2023-06-22 21:56:09 +00:00
|
|
|
use rustc_session::config::ErrorOutputType;
|
2021-03-15 10:24:28 +00:00
|
|
|
use rustc_session::parse::ParseSess;
|
2023-07-02 12:35:19 +00:00
|
|
|
use rustc_session::EarlyErrorHandler;
|
2021-03-12 14:30:50 +00:00
|
|
|
use rustc_span::symbol::Symbol;
|
2019-04-30 09:10:31 +00:00
|
|
|
|
2019-12-23 20:06:52 +00:00
|
|
|
use std::env;
|
|
|
|
use std::ops::Deref;
|
2022-10-28 07:20:51 +00:00
|
|
|
use std::path::Path;
|
|
|
|
use std::process::exit;
|
2017-09-18 10:47:33 +00:00
|
|
|
|
2019-01-15 18:56:09 +00:00
|
|
|
/// If a command-line option matches `find_arg`, then apply the predicate `pred` on its value. If
|
|
|
|
/// true, then return it. The parameter is assumed to be either `--arg=value` or `--arg value`.
|
2019-12-23 20:06:52 +00:00
|
|
|
fn arg_value<'a, T: Deref<Target = str>>(
|
|
|
|
args: &'a [T],
|
2019-01-15 18:56:09 +00:00
|
|
|
find_arg: &str,
|
|
|
|
pred: impl Fn(&str) -> bool,
|
|
|
|
) -> Option<&'a str> {
|
2019-12-23 20:06:52 +00:00
|
|
|
let mut args = args.iter().map(Deref::deref);
|
2019-01-15 18:56:09 +00:00
|
|
|
while let Some(arg) = args.next() {
|
2019-12-23 20:06:52 +00:00
|
|
|
let mut arg = arg.splitn(2, '=');
|
|
|
|
if arg.next() != Some(find_arg) {
|
2019-01-15 18:56:09 +00:00
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
2019-12-23 20:06:52 +00:00
|
|
|
match arg.next().or_else(|| args.next()) {
|
|
|
|
Some(v) if pred(v) => return Some(v),
|
2020-12-20 16:19:49 +00:00
|
|
|
_ => {},
|
2019-01-15 18:56:09 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
None
|
|
|
|
}
|
|
|
|
|
2020-12-23 09:52:53 +00:00
|
|
|
#[test]
|
|
|
|
fn test_arg_value() {
|
|
|
|
let args = &["--bar=bar", "--foobar", "123", "--foo"];
|
|
|
|
|
|
|
|
assert_eq!(arg_value(&[] as &[&str], "--foobar", |_| true), None);
|
|
|
|
assert_eq!(arg_value(args, "--bar", |_| false), None);
|
|
|
|
assert_eq!(arg_value(args, "--bar", |_| true), Some("bar"));
|
|
|
|
assert_eq!(arg_value(args, "--bar", |p| p == "bar"), Some("bar"));
|
|
|
|
assert_eq!(arg_value(args, "--bar", |p| p == "foo"), None);
|
|
|
|
assert_eq!(arg_value(args, "--foobar", |p| p == "foo"), None);
|
|
|
|
assert_eq!(arg_value(args, "--foobar", |p| p == "123"), Some("123"));
|
2022-06-30 08:50:09 +00:00
|
|
|
assert_eq!(arg_value(args, "--foobar", |p| p.contains("12")), Some("123"));
|
2020-12-23 09:52:53 +00:00
|
|
|
assert_eq!(arg_value(args, "--foo", |_| true), None);
|
|
|
|
}
|
|
|
|
|
2021-03-15 10:24:28 +00:00
|
|
|
fn track_clippy_args(parse_sess: &mut ParseSess, args_env_var: &Option<String>) {
|
|
|
|
parse_sess.env_depinfo.get_mut().insert((
|
2021-03-12 14:30:50 +00:00
|
|
|
Symbol::intern("CLIPPY_ARGS"),
|
|
|
|
args_env_var.as_deref().map(Symbol::intern),
|
|
|
|
));
|
|
|
|
}
|
|
|
|
|
2022-11-21 19:34:47 +00:00
|
|
|
/// Track files that may be accessed at runtime in `file_depinfo` so that cargo will re-run clippy
|
|
|
|
/// when any of them are modified
|
2023-06-02 09:41:57 +00:00
|
|
|
fn track_files(parse_sess: &mut ParseSess) {
|
2022-11-21 19:34:47 +00:00
|
|
|
let file_depinfo = parse_sess.file_depinfo.get_mut();
|
|
|
|
|
|
|
|
// Used by `clippy::cargo` lints and to determine the MSRV. `cargo clippy` executes `clippy-driver`
|
|
|
|
// with the current directory set to `CARGO_MANIFEST_DIR` so a relative path is fine
|
|
|
|
if Path::new("Cargo.toml").exists() {
|
|
|
|
file_depinfo.insert(Symbol::intern("Cargo.toml"));
|
|
|
|
}
|
|
|
|
|
2023-06-02 09:41:57 +00:00
|
|
|
// `clippy.toml` will be automatically tracked as it's loaded with `sess.source_map().load_file()`
|
2022-11-21 19:34:47 +00:00
|
|
|
|
|
|
|
// During development track the `clippy-driver` executable so that cargo will re-run clippy whenever
|
|
|
|
// it is rebuilt
|
2022-12-01 17:29:38 +00:00
|
|
|
#[expect(
|
|
|
|
clippy::collapsible_if,
|
|
|
|
reason = "Due to a bug in let_chains this if statement can't be collapsed"
|
|
|
|
)]
|
2022-11-22 13:30:29 +00:00
|
|
|
if cfg!(debug_assertions) {
|
|
|
|
if let Ok(current_exe) = env::current_exe()
|
|
|
|
&& let Some(current_exe) = current_exe.to_str()
|
|
|
|
{
|
|
|
|
file_depinfo.insert(Symbol::intern(current_exe));
|
|
|
|
}
|
2022-11-21 19:34:47 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-02-11 15:52:00 +00:00
|
|
|
struct DefaultCallbacks;
|
|
|
|
impl rustc_driver::Callbacks for DefaultCallbacks {}
|
2019-02-01 22:28:14 +00:00
|
|
|
|
2021-03-12 14:30:50 +00:00
|
|
|
/// This is different from `DefaultCallbacks` that it will inform Cargo to track the value of
|
|
|
|
/// `CLIPPY_ARGS` environment variable.
|
|
|
|
struct RustcCallbacks {
|
|
|
|
clippy_args_var: Option<String>,
|
|
|
|
}
|
|
|
|
|
|
|
|
impl rustc_driver::Callbacks for RustcCallbacks {
|
|
|
|
fn config(&mut self, config: &mut interface::Config) {
|
|
|
|
let clippy_args_var = self.clippy_args_var.take();
|
2021-03-15 10:24:28 +00:00
|
|
|
config.parse_sess_created = Some(Box::new(move |parse_sess| {
|
|
|
|
track_clippy_args(parse_sess, &clippy_args_var);
|
2021-03-12 14:30:50 +00:00
|
|
|
}));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
struct ClippyCallbacks {
|
|
|
|
clippy_args_var: Option<String>,
|
|
|
|
}
|
|
|
|
|
2019-02-01 22:28:14 +00:00
|
|
|
impl rustc_driver::Callbacks for ClippyCallbacks {
|
2022-07-25 12:02:39 +00:00
|
|
|
// JUSTIFICATION: necessary in clippy driver to set `mir_opt_level`
|
2022-08-09 13:56:13 +00:00
|
|
|
#[allow(rustc::bad_opt_access)]
|
2019-10-11 01:46:22 +00:00
|
|
|
fn config(&mut self, config: &mut interface::Config) {
|
2022-11-21 19:34:47 +00:00
|
|
|
let conf_path = clippy_lints::lookup_conf_file();
|
2019-10-11 01:46:22 +00:00
|
|
|
let previous = config.register_lints.take();
|
2021-03-12 14:30:50 +00:00
|
|
|
let clippy_args_var = self.clippy_args_var.take();
|
2021-03-15 10:24:28 +00:00
|
|
|
config.parse_sess_created = Some(Box::new(move |parse_sess| {
|
|
|
|
track_clippy_args(parse_sess, &clippy_args_var);
|
2023-06-02 09:41:57 +00:00
|
|
|
track_files(parse_sess);
|
2021-03-15 10:24:28 +00:00
|
|
|
}));
|
2021-04-08 15:50:13 +00:00
|
|
|
config.register_lints = Some(Box::new(move |sess, lint_store| {
|
2019-10-11 01:46:22 +00:00
|
|
|
// technically we're ~guaranteed that this is none but might as well call anything that
|
|
|
|
// is there already. Certainly it can't hurt.
|
|
|
|
if let Some(previous) = &previous {
|
|
|
|
(previous)(sess, lint_store);
|
|
|
|
}
|
|
|
|
|
2022-11-21 19:34:47 +00:00
|
|
|
let conf = clippy_lints::read_conf(sess, &conf_path);
|
2021-04-08 15:50:13 +00:00
|
|
|
clippy_lints::register_plugins(lint_store, sess, &conf);
|
2021-12-06 11:33:31 +00:00
|
|
|
clippy_lints::register_pre_expansion_lints(lint_store, sess, &conf);
|
2021-04-08 15:50:13 +00:00
|
|
|
clippy_lints::register_renamed(lint_store);
|
2019-10-11 01:46:22 +00:00
|
|
|
}));
|
2019-11-22 13:24:38 +00:00
|
|
|
|
2019-11-23 00:26:19 +00:00
|
|
|
// FIXME: #4825; This is required, because Clippy lints that are based on MIR have to be
|
|
|
|
// run on the unoptimized MIR. On the other hand this results in some false negatives. If
|
|
|
|
// MIR passes can be enabled / disabled separately, we should figure out, what passes to
|
|
|
|
// use for Clippy.
|
2022-07-06 12:44:47 +00:00
|
|
|
config.opts.unstable_opts.mir_opt_level = Some(0);
|
2023-04-17 11:45:11 +00:00
|
|
|
|
|
|
|
// Disable flattening and inlining of format_args!(), so the HIR matches with the AST.
|
|
|
|
config.opts.unstable_opts.flatten_format_args = false;
|
2019-02-01 22:28:14 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-06-08 21:19:16 +00:00
|
|
|
fn display_help() {
|
|
|
|
println!(
|
|
|
|
"\
|
2019-06-05 00:32:03 +00:00
|
|
|
Checks a package to catch common mistakes and improve your Rust code.
|
|
|
|
|
|
|
|
Usage:
|
|
|
|
cargo clippy [options] [--] [<opts>...]
|
|
|
|
|
|
|
|
Common options:
|
|
|
|
-h, --help Print this message
|
2020-06-23 15:05:22 +00:00
|
|
|
--rustc Pass all args to rustc
|
2019-06-05 00:32:03 +00:00
|
|
|
-V, --version Print version info and exit
|
|
|
|
|
2023-03-10 09:53:50 +00:00
|
|
|
For the other options see `cargo check --help`.
|
2019-06-05 00:32:03 +00:00
|
|
|
|
|
|
|
To allow or deny a lint from the command line you can use `cargo clippy --`
|
|
|
|
with:
|
|
|
|
|
|
|
|
-W --warn OPT Set lint warnings
|
|
|
|
-A --allow OPT Set lint allowed
|
|
|
|
-D --deny OPT Set lint denied
|
|
|
|
-F --forbid OPT Set lint forbidden
|
|
|
|
|
|
|
|
You can use tool lints to allow or deny lints from your code, eg.:
|
|
|
|
|
|
|
|
#[allow(clippy::needless_lifetimes)]
|
|
|
|
"
|
2019-06-08 21:19:16 +00:00
|
|
|
);
|
|
|
|
}
|
|
|
|
|
2019-09-27 05:09:12 +00:00
|
|
|
const BUG_REPORT_URL: &str = "https://github.com/rust-lang/rust-clippy/issues/new";
|
|
|
|
|
2020-12-20 16:19:49 +00:00
|
|
|
#[allow(clippy::too_many_lines)]
|
2019-06-08 21:19:16 +00:00
|
|
|
pub fn main() {
|
2023-06-22 21:56:09 +00:00
|
|
|
let handler = EarlyErrorHandler::new(ErrorOutputType::default());
|
|
|
|
|
|
|
|
rustc_driver::init_rustc_env_logger(&handler);
|
2023-04-29 11:29:07 +00:00
|
|
|
|
|
|
|
rustc_driver::install_ice_hook(BUG_REPORT_URL, |handler| {
|
|
|
|
// FIXME: this macro calls unwrap internally but is called in a panicking context! It's not
|
|
|
|
// as simple as moving the call from the hook to main, because `install_ice_hook` doesn't
|
|
|
|
// accept a generic closure.
|
|
|
|
let version_info = rustc_tools_util::get_version_info!();
|
|
|
|
handler.note_without_error(format!("Clippy version: {version_info}"));
|
|
|
|
});
|
|
|
|
|
2020-05-17 15:36:26 +00:00
|
|
|
exit(rustc_driver::catch_with_exit_code(move || {
|
|
|
|
let mut orig_args: Vec<String> = env::args().collect();
|
2023-01-12 18:48:13 +00:00
|
|
|
let has_sysroot_arg = arg_value(&orig_args, "--sysroot", |_| true).is_some();
|
2019-06-05 00:32:03 +00:00
|
|
|
|
2022-11-21 19:34:47 +00:00
|
|
|
let sys_root_env = std::env::var("SYSROOT").ok();
|
|
|
|
let pass_sysroot_env_if_given = |args: &mut Vec<String>, sys_root_env| {
|
|
|
|
if let Some(sys_root) = sys_root_env {
|
2023-01-12 18:48:13 +00:00
|
|
|
if !has_sysroot_arg {
|
|
|
|
args.extend(vec!["--sysroot".into(), sys_root]);
|
|
|
|
}
|
2022-11-21 19:34:47 +00:00
|
|
|
};
|
|
|
|
};
|
|
|
|
|
2020-06-23 15:05:22 +00:00
|
|
|
// make "clippy-driver --rustc" work like a subcommand that passes further args to "rustc"
|
|
|
|
// for example `clippy-driver --rustc --version` will print the rustc version that clippy-driver
|
|
|
|
// uses
|
|
|
|
if let Some(pos) = orig_args.iter().position(|arg| arg == "--rustc") {
|
|
|
|
orig_args.remove(pos);
|
|
|
|
orig_args[0] = "rustc".to_string();
|
|
|
|
|
2022-11-21 19:34:47 +00:00
|
|
|
let mut args: Vec<String> = orig_args.clone();
|
|
|
|
pass_sysroot_env_if_given(&mut args, sys_root_env);
|
|
|
|
|
|
|
|
return rustc_driver::RunCompiler::new(&args, &mut DefaultCallbacks).run();
|
2020-06-23 15:05:22 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
if orig_args.iter().any(|a| a == "--version" || a == "-V") {
|
|
|
|
let version_info = rustc_tools_util::get_version_info!();
|
2022-10-06 07:44:38 +00:00
|
|
|
println!("{version_info}");
|
2020-06-23 15:05:22 +00:00
|
|
|
exit(0);
|
|
|
|
}
|
|
|
|
|
2020-05-17 15:36:26 +00:00
|
|
|
// Setting RUSTC_WRAPPER causes Cargo to pass 'rustc' as the first argument.
|
|
|
|
// We're invoking the compiler programmatically, so we ignore this/
|
2020-12-20 16:19:49 +00:00
|
|
|
let wrapper_mode = orig_args.get(1).map(Path::new).and_then(Path::file_stem) == Some("rustc".as_ref());
|
2020-05-17 15:36:26 +00:00
|
|
|
|
|
|
|
if wrapper_mode {
|
|
|
|
// we still want to be able to invoke it normally though
|
|
|
|
orig_args.remove(1);
|
|
|
|
}
|
|
|
|
|
2020-12-20 16:19:49 +00:00
|
|
|
if !wrapper_mode && (orig_args.iter().any(|a| a == "--help" || a == "-h") || orig_args.len() == 1) {
|
2020-05-17 15:36:26 +00:00
|
|
|
display_help();
|
|
|
|
exit(0);
|
|
|
|
}
|
|
|
|
|
2022-11-21 19:34:47 +00:00
|
|
|
let mut args: Vec<String> = orig_args.clone();
|
|
|
|
pass_sysroot_env_if_given(&mut args, sys_root_env);
|
|
|
|
|
2020-12-23 09:52:53 +00:00
|
|
|
let mut no_deps = false;
|
2021-03-12 14:30:50 +00:00
|
|
|
let clippy_args_var = env::var("CLIPPY_ARGS").ok();
|
|
|
|
let clippy_args = clippy_args_var
|
|
|
|
.as_deref()
|
2020-12-23 09:52:53 +00:00
|
|
|
.unwrap_or_default()
|
|
|
|
.split("__CLIPPY_HACKERY__")
|
|
|
|
.filter_map(|s| match s {
|
|
|
|
"" => None,
|
|
|
|
"--no-deps" => {
|
|
|
|
no_deps = true;
|
|
|
|
None
|
|
|
|
},
|
|
|
|
_ => Some(s.to_string()),
|
|
|
|
})
|
|
|
|
.chain(vec!["--cfg".into(), r#"feature="cargo-clippy""#.into()])
|
|
|
|
.collect::<Vec<String>>();
|
2020-12-20 16:19:49 +00:00
|
|
|
|
|
|
|
// We enable Clippy if one of the following conditions is met
|
|
|
|
// - IF Clippy is run on its test suite OR
|
|
|
|
// - IF Clippy is run on the main crate, not on deps (`!cap_lints_allow`) THEN
|
|
|
|
// - IF `--no-deps` is not set (`!no_deps`) OR
|
|
|
|
// - IF `--no-deps` is set and Clippy is run on the specified primary package
|
2022-06-30 08:50:09 +00:00
|
|
|
let cap_lints_allow = arg_value(&orig_args, "--cap-lints", |val| val == "allow").is_some()
|
|
|
|
&& arg_value(&orig_args, "--force-warn", |val| val.contains("clippy::")).is_none();
|
2020-12-20 16:19:49 +00:00
|
|
|
let in_primary_package = env::var("CARGO_PRIMARY_PACKAGE").is_ok();
|
2020-05-17 15:36:26 +00:00
|
|
|
|
2022-01-27 14:12:45 +00:00
|
|
|
let clippy_enabled = !cap_lints_allow && (!no_deps || in_primary_package);
|
2020-05-17 15:36:26 +00:00
|
|
|
if clippy_enabled {
|
2020-12-23 09:52:53 +00:00
|
|
|
args.extend(clippy_args);
|
2021-03-12 14:30:50 +00:00
|
|
|
rustc_driver::RunCompiler::new(&args, &mut ClippyCallbacks { clippy_args_var }).run()
|
|
|
|
} else {
|
2022-11-21 19:34:47 +00:00
|
|
|
rustc_driver::RunCompiler::new(&args, &mut RustcCallbacks { clippy_args_var }).run()
|
2021-03-12 14:30:50 +00:00
|
|
|
}
|
2020-05-17 15:36:26 +00:00
|
|
|
}))
|
2017-09-18 10:47:33 +00:00
|
|
|
}
|