2 #![feature(box_syntax)]
3 #![feature(rustc_private)]
4 #![allow(unknown_lints, missing_docs_in_private_items)]
6 extern crate clippy_lints;
9 extern crate rustc_driver;
10 extern crate rustc_errors;
11 extern crate rustc_plugin;
14 use rustc_driver::{driver, Compilation, CompilerCalls, RustcDefaultCalls};
15 use rustc::session::{config, CompileIncomplete, Session};
16 use rustc::session::config::{ErrorOutputType, Input};
17 use std::collections::HashMap;
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(
87 "at this compilation stage \
88 the krate must be parsed",
92 registry.args_hidden = Some(Vec::new());
93 clippy_lints::register_plugins(&mut registry);
95 let rustc_plugin::registry::Registry {
103 let sess = &state.session;
104 let mut ls = sess.lint_store.borrow_mut();
105 for pass in early_lint_passes {
106 ls.register_early_pass(Some(sess), true, pass);
108 for pass in late_lint_passes {
109 ls.register_late_pass(Some(sess), true, pass);
112 for (name, to) in lint_groups {
113 ls.register_group(Some(sess), true, name, to);
116 sess.plugin_llvm_passes.borrow_mut().extend(llvm_passes);
117 sess.plugin_attributes.borrow_mut().extend(attributes);
129 const CARGO_CLIPPY_HELP: &str = r#"Checks a package to catch common mistakes and improve your Rust code.
132 cargo clippy [options] [--] [<opts>...]
135 -h, --help Print this message
136 --features Features to compile for the package
137 -V, --version Print version info and exit
138 --all Run over all packages in the current workspace
140 Other options are the same as `cargo rustc`.
142 To allow or deny a lint from the command line you can use `cargo clippy --`
145 -W --warn OPT Set lint warnings
146 -A --allow OPT Set lint allowed
147 -D --deny OPT Set lint denied
148 -F --forbid OPT Set lint forbidden
150 The feature `cargo-clippy` is automatically defined for convenience. You can use
151 it to allow or deny lints from the code, eg.:
153 #[cfg_attr(feature = "cargo-clippy", allow(needless_lifetimes))]
156 #[allow(print_stdout)]
158 println!("{}", CARGO_CLIPPY_HELP);
161 #[allow(print_stdout)]
163 println!("{}", env!("CARGO_PKG_VERSION"));
169 if env::var("CLIPPY_DOGFOOD").map(|_| true).unwrap_or(false) {
173 // Check for version and help flags even when invoked as 'cargo-clippy'
174 if std::env::args().any(|a| a == "--help" || a == "-h") {
178 if std::env::args().any(|a| a == "--version" || a == "-V") {
183 if let Some("clippy") = std::env::args().nth(1).as_ref().map(AsRef::as_ref) {
184 // this arm is executed on the initial call to `cargo clippy`
186 let manifest_path_arg = std::env::args()
188 .find(|val| val.starts_with("--manifest-path="));
190 let mut metadata = if let Ok(metadata) = cargo_metadata::metadata(manifest_path_arg.as_ref().map(AsRef::as_ref))
194 let _ = io::stderr().write_fmt(format_args!("error: Could not obtain cargo metadata.\n"));
198 let manifest_path = manifest_path_arg.map(|arg| {
199 Path::new(&arg["--manifest-path=".len()..])
201 .expect("manifest path could not be canonicalized")
204 let packages = if std::env::args().any(|a| a == "--all") {
207 let package_index = {
208 if let Some(manifest_path) = manifest_path {
209 metadata.packages.iter().position(|package| {
210 let package_manifest_path = Path::new(&package.manifest_path)
212 .expect("package manifest path could not be canonicalized");
213 package_manifest_path == manifest_path
216 let package_manifest_paths: HashMap<_, _> = metadata
220 .map(|(i, package)| {
221 let package_manifest_path = Path::new(&package.manifest_path)
223 .expect("could not find parent directory of package manifest")
225 .expect("package directory cannot be canonicalized");
226 (package_manifest_path, i)
230 let current_dir = std::env::current_dir()
231 .expect("could not read current directory")
233 .expect("current directory cannot be canonicalized");
235 let mut current_path: &Path = ¤t_dir;
237 // This gets the most-recent parent (the one that takes the fewest `cd ..`s to
240 if let Some(&package_index) = package_manifest_paths.get(current_path) {
241 break Some(package_index);
243 // We'll never reach the filesystem root, because to get to this point in the
245 // the call to `cargo_metadata::metadata` must have succeeded. So it's okay to
246 // unwrap the current path's parent.
247 current_path = current_path
249 .unwrap_or_else(|| panic!("could not find parent of path {}", current_path.display()));
253 }.expect("could not find matching package");
255 vec![metadata.packages.remove(package_index)]
258 for package in packages {
259 let manifest_path = package.manifest_path;
261 for target in package.targets {
262 let args = std::env::args()
264 .filter(|a| a != "--all" && !a.starts_with("--manifest-path="));
266 let args = std::iter::once(format!("--manifest-path={}", manifest_path)).chain(args);
267 if let Some(first) = target.kind.get(0) {
268 if target.kind.len() > 1 || first.ends_with("lib") {
269 if let Err(code) = process(std::iter::once("--lib".to_owned()).chain(args)) {
270 std::process::exit(code);
272 } else if ["bin", "example", "test", "bench"].contains(&&**first) {
273 if let Err(code) = process(
274 vec![format!("--{}", first), target.name]
278 std::process::exit(code);
282 panic!("badly formatted cargo metadata: target::kind is an empty array");
287 // this arm is executed when cargo-clippy runs `cargo rustc` with the `RUSTC`
288 // env var set to itself
290 let home = option_env!("RUSTUP_HOME").or(option_env!("MULTIRUST_HOME"));
291 let toolchain = option_env!("RUSTUP_TOOLCHAIN").or(option_env!("MULTIRUST_TOOLCHAIN"));
292 let sys_root = if let (Some(home), Some(toolchain)) = (home, toolchain) {
293 format!("{}/toolchains/{}", home, toolchain)
295 option_env!("SYSROOT")
296 .map(|s| s.to_owned())
298 Command::new("rustc")
303 .and_then(|out| String::from_utf8(out.stdout).ok())
304 .map(|s| s.trim().to_owned())
307 "need to specify SYSROOT env var during clippy compilation, or use rustup or multirust",
311 rustc_driver::in_rustc_thread(|| {
312 // this conditional check for the --sysroot flag is there so users can call
313 // `cargo-clippy` directly
314 // without having to pass --sysroot or anything
315 let mut args: Vec<String> = if env::args().any(|s| s == "--sysroot") {
316 env::args().collect()
319 .chain(Some("--sysroot".to_owned()))
320 .chain(Some(sys_root))
324 // this check ensures that dependencies are built but not linted and the final
326 // linted but not built
327 let clippy_enabled = env::args().any(|s| s == "--emit=metadata");
330 args.extend_from_slice(&["--cfg".to_owned(), r#"feature="cargo-clippy""#.to_owned()]);
333 let mut ccc = ClippyCompilerCalls::new(clippy_enabled);
334 let (result, _) = rustc_driver::run_compiler(&args, &mut ccc, None, None);
335 if let Err(CompileIncomplete::Errored(_)) = result {
336 std::process::exit(1);
338 }).expect("rustc_thread failed");
342 fn process<I>(old_args: I) -> Result<(), i32>
344 I: Iterator<Item = String>,
346 let mut args = vec!["rustc".to_owned()];
348 let mut found_dashes = false;
349 for arg in old_args {
350 found_dashes |= arg == "--";
354 args.push("--".to_owned());
356 args.push("--emit=metadata".to_owned());
357 args.push("--cfg".to_owned());
358 args.push(r#"feature="cargo-clippy""#.to_owned());
360 let path = std::env::current_exe().expect("current executable path invalid");
361 let exit_status = std::process::Command::new("cargo")
365 .expect("could not run cargo")
367 .expect("failed to wait for cargo?");
369 if exit_status.success() {
372 Err(exit_status.code().unwrap_or(-1))