2 #![feature(box_syntax)]
3 #![feature(rustc_private)]
5 #![allow(unknown_lints, missing_docs_in_private_items)]
7 extern crate clippy_lints;
10 extern crate rustc_driver;
11 extern crate rustc_errors;
12 extern crate rustc_plugin;
15 use rustc_driver::{driver, CompilerCalls, RustcDefaultCalls, Compilation};
16 use rustc::session::{config, Session, CompileIncomplete};
17 use rustc::session::config::{Input, ErrorOutputType};
18 use std::path::PathBuf;
19 use std::process::{self, Command};
21 use std::io::{self, Write};
23 extern crate cargo_metadata;
25 struct ClippyCompilerCalls {
26 default: RustcDefaultCalls,
30 impl ClippyCompilerCalls {
31 fn new(run_lints: bool) -> Self {
33 default: RustcDefaultCalls,
39 impl<'a> CompilerCalls<'a> for ClippyCompilerCalls {
42 matches: &getopts::Matches,
43 sopts: &config::Options,
44 cfg: &ast::CrateConfig,
45 descriptions: &rustc_errors::registry::Registry,
46 output: ErrorOutputType,
49 .early_callback(matches, sopts, cfg, descriptions, output)
53 matches: &getopts::Matches,
54 sopts: &config::Options,
55 cfg: &ast::CrateConfig,
56 odir: &Option<PathBuf>,
57 ofile: &Option<PathBuf>,
58 descriptions: &rustc_errors::registry::Registry,
59 ) -> Option<(Input, Option<PathBuf>)> {
61 .no_input(matches, sopts, cfg, odir, ofile, descriptions)
65 matches: &getopts::Matches,
68 odir: &Option<PathBuf>,
69 ofile: &Option<PathBuf>,
72 .late_callback(matches, sess, input, odir, ofile)
74 fn build_controller(&mut self, sess: &Session, matches: &getopts::Matches) -> driver::CompileController<'a> {
75 let mut control = self.default.build_controller(sess, matches);
78 let old = std::mem::replace(&mut control.after_parse.callback, box |_| {});
79 control.after_parse.callback = Box::new(move |state| {
81 let mut registry = rustc_plugin::registry::Registry::new(state.session,
85 .expect("at this compilation stage \
86 the krate must be parsed")
88 registry.args_hidden = Some(Vec::new());
89 clippy_lints::register_plugins(&mut registry);
91 let rustc_plugin::registry::Registry {
99 let sess = &state.session;
100 let mut ls = sess.lint_store.borrow_mut();
101 for pass in early_lint_passes {
102 ls.register_early_pass(Some(sess), true, pass);
104 for pass in late_lint_passes {
105 ls.register_late_pass(Some(sess), true, pass);
108 for (name, to) in lint_groups {
109 ls.register_group(Some(sess), true, name, to);
112 sess.plugin_llvm_passes.borrow_mut().extend(llvm_passes);
113 sess.plugin_attributes.borrow_mut().extend(attributes);
125 const CARGO_CLIPPY_HELP: &str = r#"Checks a package to catch common mistakes and improve your Rust code.
128 cargo clippy [options] [--] [<opts>...]
131 -h, --help Print this message
132 --features Features to compile for the package
133 -V, --version Print version info and exit
135 Other options are the same as `cargo rustc`.
137 To allow or deny a lint from the command line you can use `cargo clippy --`
140 -W --warn OPT Set lint warnings
141 -A --allow OPT Set lint allowed
142 -D --deny OPT Set lint denied
143 -F --forbid OPT Set lint forbidden
145 The feature `cargo-clippy` is automatically defined for convenience. You can use
146 it to allow or deny lints from the code, eg.:
148 #[cfg_attr(feature = "cargo-clippy", allow(needless_lifetimes))]
151 #[allow(print_stdout)]
153 println!("{}", CARGO_CLIPPY_HELP);
156 #[allow(print_stdout)]
158 println!("{}", env!("CARGO_PKG_VERSION"));
161 // FIXME: false positive for needless_lifetimes
162 #[allow(needless_lifetimes)]
163 fn has_prefix<'a, T: PartialEq, I: Iterator<Item = &'a T>>(v: &'a [T], itr: I) -> bool {
164 v.iter().zip(itr).all(|(a, b)| a == b)
170 if env::var("CLIPPY_DOGFOOD").map(|_| true).unwrap_or(false) {
174 // Check for version and help flags even when invoked as 'cargo-clippy'
175 if std::env::args().any(|a| a == "--help" || a == "-h") {
179 if std::env::args().any(|a| a == "--version" || a == "-V") {
184 if let Some("clippy") = std::env::args().nth(1).as_ref().map(AsRef::as_ref) {
185 // this arm is executed on the initial call to `cargo clippy`
187 let manifest_path_arg = std::env::args()
189 .find(|val| val.starts_with("--manifest-path="));
192 if let Ok(metadata) = cargo_metadata::metadata(manifest_path_arg.as_ref().map(AsRef::as_ref)) {
195 let _ = io::stderr().write_fmt(format_args!("error: Could not obtain cargo metadata.\n"));
199 let manifest_path = manifest_path_arg.map(|arg| PathBuf::from(Path::new(&arg["--manifest-path=".len()..])));
201 let package_index = {
202 let mut iterator = metadata.packages.iter();
204 if let Some(ref manifest_path) = manifest_path {
205 iterator.position(|package| {
206 let package_manifest_path = Path::new(&package.manifest_path);
207 package_manifest_path == manifest_path
210 let current_dir = std::env::current_dir()
211 .expect("could not read current directory")
213 .expect("current directory cannot be canonicalized");
214 let current_dir_components = current_dir.components().collect::<Vec<_>>();
216 // This gets the most-recent parent (the one that takes the fewest `cd ..`s to
220 .filter_map(|(i, package)| {
221 let package_manifest_path = Path::new(&package.manifest_path);
222 let canonical_path = package_manifest_path
224 .expect("could not find parent directory of package manifest")
226 .expect("package directory cannot be canonicalized");
228 // TODO: We can do this in `O(1)` by combining the `len` and the
230 let components = canonical_path.components().collect::<Vec<_>>();
231 if has_prefix(¤t_dir_components, components.iter()) {
232 Some((i, components.len()))
237 .max_by_key(|&(_, length)| length)
241 .expect("could not find matching package");
243 let package = metadata.packages.remove(package_index);
244 for target in package.targets {
245 let args = std::env::args().skip(2);
246 if let Some(first) = target.kind.get(0) {
247 if target.kind.len() > 1 || first.ends_with("lib") {
248 if let Err(code) = process(std::iter::once("--lib".to_owned()).chain(args)) {
249 std::process::exit(code);
251 } else if ["bin", "example", "test", "bench"].contains(&&**first) {
252 if let Err(code) = process(vec![format!("--{}", first), target.name]
255 std::process::exit(code);
259 panic!("badly formatted cargo metadata: target::kind is an empty array");
263 // this arm is executed when cargo-clippy runs `cargo rustc` with the `RUSTC`
264 // env var set to itself
266 let home = option_env!("RUSTUP_HOME").or(option_env!("MULTIRUST_HOME"));
267 let toolchain = option_env!("RUSTUP_TOOLCHAIN").or(option_env!("MULTIRUST_TOOLCHAIN"));
268 let sys_root = if let (Some(home), Some(toolchain)) = (home, toolchain) {
269 format!("{}/toolchains/{}", home, toolchain)
271 option_env!("SYSROOT")
272 .map(|s| s.to_owned())
274 Command::new("rustc")
279 .and_then(|out| String::from_utf8(out.stdout).ok())
280 .map(|s| s.trim().to_owned())
282 .expect("need to specify SYSROOT env var during clippy compilation, or use rustup or multirust")
285 rustc_driver::in_rustc_thread(|| {
286 // this conditional check for the --sysroot flag is there so users can call
287 // `cargo-clippy` directly
288 // without having to pass --sysroot or anything
289 let mut args: Vec<String> = if env::args().any(|s| s == "--sysroot") {
290 env::args().collect()
293 .chain(Some("--sysroot".to_owned()))
294 .chain(Some(sys_root))
298 // this check ensures that dependencies are built but not linted and the final
300 // linted but not built
301 let clippy_enabled = env::args().any(|s| s == "--emit=metadata");
304 args.extend_from_slice(&["--cfg".to_owned(), r#"feature="cargo-clippy""#.to_owned()]);
307 let mut ccc = ClippyCompilerCalls::new(clippy_enabled);
308 let (result, _) = rustc_driver::run_compiler(&args, &mut ccc, None, None);
309 if let Err(CompileIncomplete::Errored(_)) = result {
310 std::process::exit(1);
313 .expect("rustc_thread failed");
317 fn process<I>(old_args: I) -> Result<(), i32>
318 where I: Iterator<Item = String>
321 let mut args = vec!["rustc".to_owned()];
323 let mut found_dashes = false;
324 for arg in old_args {
325 found_dashes |= arg == "--";
329 args.push("--".to_owned());
331 args.push("--emit=metadata".to_owned());
332 args.push("--cfg".to_owned());
333 args.push(r#"feature="cargo-clippy""#.to_owned());
335 let path = std::env::current_exe().expect("current executable path invalid");
336 let exit_status = std::process::Command::new("cargo")
340 .expect("could not run cargo")
342 .expect("failed to wait for cargo?");
344 if exit_status.success() {
347 Err(exit_status.code().unwrap_or(-1))