]> git.lizzy.rs Git - rust.git/blobdiff - src/main.rs
Fix small nits on the help message
[rust.git] / src / main.rs
index db0c6613f3fcf97a6713dc8909151b43a574d126..44c3b61d22cc181fd35ec65a663e221f18d01440 100644 (file)
@@ -1,36 +1,38 @@
 // error-pattern:yummy
 #![feature(box_syntax)]
 #![feature(rustc_private)]
-#![feature(slice_patterns)]
+#![feature(static_in_const)]
 
-extern crate rustc_driver;
+#![allow(unknown_lints, missing_docs_in_private_items)]
+
+extern crate clippy_lints;
 extern crate getopts;
 extern crate rustc;
-extern crate syntax;
+extern crate rustc_driver;
+extern crate rustc_errors;
 extern crate rustc_plugin;
-extern crate clippy_lints;
-extern crate rustc_serialize;
+extern crate syntax;
 
 use rustc_driver::{driver, CompilerCalls, RustcDefaultCalls, Compilation};
 use rustc::session::{config, Session};
 use rustc::session::config::{Input, ErrorOutputType};
-use syntax::diagnostics;
 use std::path::PathBuf;
 use std::process::Command;
+use syntax::ast;
 
 use clippy_lints::utils::cargo;
 
-struct ClippyCompilerCalls(RustcDefaultCalls);
-
-impl std::default::Default for ClippyCompilerCalls {
-    fn default() -> Self {
-        Self::new()
-    }
+struct ClippyCompilerCalls {
+    default: RustcDefaultCalls,
+    run_lints: bool,
 }
 
 impl ClippyCompilerCalls {
-    fn new() -> Self {
-        ClippyCompilerCalls(RustcDefaultCalls)
+    fn new(run_lints: bool) -> Self {
+        ClippyCompilerCalls {
+            default: RustcDefaultCalls,
+            run_lints: run_lints,
+        }
     }
 }
 
@@ -38,59 +40,70 @@ impl<'a> CompilerCalls<'a> for ClippyCompilerCalls {
     fn early_callback(&mut self,
                       matches: &getopts::Matches,
                       sopts: &config::Options,
-                      descriptions: &diagnostics::registry::Registry,
+                      cfg: &ast::CrateConfig,
+                      descriptions: &rustc_errors::registry::Registry,
                       output: ErrorOutputType)
                       -> Compilation {
-        self.0.early_callback(matches, sopts, descriptions, output)
+        self.default.early_callback(matches, sopts, cfg, descriptions, output)
     }
     fn no_input(&mut self,
                 matches: &getopts::Matches,
                 sopts: &config::Options,
+                cfg: &ast::CrateConfig,
                 odir: &Option<PathBuf>,
                 ofile: &Option<PathBuf>,
-                descriptions: &diagnostics::registry::Registry)
+                descriptions: &rustc_errors::registry::Registry)
                 -> Option<(Input, Option<PathBuf>)> {
-        self.0.no_input(matches, sopts, odir, ofile, descriptions)
+        self.default.no_input(matches, sopts, cfg, odir, ofile, descriptions)
     }
     fn late_callback(&mut self,
                      matches: &getopts::Matches,
                      sess: &Session,
+                     cfg: &ast::CrateConfig,
                      input: &Input,
                      odir: &Option<PathBuf>,
                      ofile: &Option<PathBuf>)
                      -> Compilation {
-        self.0.late_callback(matches, sess, input, odir, ofile)
+        self.default.late_callback(matches, sess, cfg, input, odir, ofile)
     }
     fn build_controller(&mut self, sess: &Session, matches: &getopts::Matches) -> driver::CompileController<'a> {
-        let mut control = self.0.build_controller(sess, matches);
-
-        let old = std::mem::replace(&mut control.after_parse.callback, box |_| {});
-        control.after_parse.callback = Box::new(move |state| {
-            {
-                let mut registry = rustc_plugin::registry::Registry::new(state.session, state.krate.as_ref().expect("at this compilation stage the krate must be parsed"));
-                registry.args_hidden = Some(Vec::new());
-                clippy_lints::register_plugins(&mut registry);
-
-                let rustc_plugin::registry::Registry { early_lint_passes, late_lint_passes, lint_groups, llvm_passes, attributes, mir_passes, .. } = registry;
-                let sess = &state.session;
-                let mut ls = sess.lint_store.borrow_mut();
-                for pass in early_lint_passes {
-                    ls.register_early_pass(Some(sess), true, pass);
-                }
-                for pass in late_lint_passes {
-                    ls.register_late_pass(Some(sess), true, pass);
-                }
+        let mut control = self.default.build_controller(sess, matches);
 
-                for (name, to) in lint_groups {
-                    ls.register_group(Some(sess), true, name, to);
-                }
+        if self.run_lints {
+            let old = std::mem::replace(&mut control.after_parse.callback, box |_| {});
+            control.after_parse.callback = Box::new(move |state| {
+                {
+                    let mut registry = rustc_plugin::registry::Registry::new(state.session, state.krate.as_ref().expect("at this compilation stage the krate must be parsed").span);
+                    registry.args_hidden = Some(Vec::new());
+                    clippy_lints::register_plugins(&mut registry);
 
-                sess.plugin_llvm_passes.borrow_mut().extend(llvm_passes);
-                sess.mir_passes.borrow_mut().extend(mir_passes);
-                sess.plugin_attributes.borrow_mut().extend(attributes);
-            }
-            old(state);
-        });
+                    let rustc_plugin::registry::Registry { early_lint_passes,
+                                                           late_lint_passes,
+                                                           lint_groups,
+                                                           llvm_passes,
+                                                           attributes,
+                                                           mir_passes,
+                                                           .. } = registry;
+                    let sess = &state.session;
+                    let mut ls = sess.lint_store.borrow_mut();
+                    for pass in early_lint_passes {
+                        ls.register_early_pass(Some(sess), true, pass);
+                    }
+                    for pass in late_lint_passes {
+                        ls.register_late_pass(Some(sess), true, pass);
+                    }
+
+                    for (name, to) in lint_groups {
+                        ls.register_group(Some(sess), true, name, to);
+                    }
+
+                    sess.plugin_llvm_passes.borrow_mut().extend(llvm_passes);
+                    sess.mir_passes.borrow_mut().extend(mir_passes);
+                    sess.plugin_attributes.borrow_mut().extend(attributes);
+                }
+                old(state);
+            });
+        }
 
         control
     }
@@ -98,6 +111,36 @@ fn build_controller(&mut self, sess: &Session, matches: &getopts::Matches) -> dr
 
 use std::path::Path;
 
+const CARGO_CLIPPY_HELP: &str = r#"Checks a package to catch common mistakes and improve your Rust code.
+
+Usage:
+    cargo clippy [options] [--] [<opts>...]
+
+Common options:
+    -h, --help               Print this message
+    --features               Features to compile for the package
+
+Other options are the same as `cargo rustc`.
+
+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
+
+The feature `cargo-clippy` is automatically defined for convenience. You can use
+it to allow or deny lints from the code, eg.:
+
+    #[cfg_attr(feature = "cargo-clippy", allow(needless_lifetimes))]
+"#;
+
+#[allow(print_stdout)]
+fn show_help() {
+    println!("{}", CARGO_CLIPPY_HELP);
+}
+
 pub fn main() {
     use std::env;
 
@@ -109,40 +152,85 @@ pub fn main() {
 
     let home = option_env!("RUSTUP_HOME").or(option_env!("MULTIRUST_HOME"));
     let toolchain = option_env!("RUSTUP_TOOLCHAIN").or(option_env!("MULTIRUST_TOOLCHAIN"));
-    let sys_root = match (home, toolchain) {
-        (Some(home), Some(toolchain)) => format!("{}/toolchains/{}", home, toolchain),
-        _ => option_env!("SYSROOT").map(|s| s.to_owned())
-                                   .or(Command::new("rustc").arg("--print")
-                                                            .arg("sysroot")
-                                                            .output().ok()
-                                                            .and_then(|out| String::from_utf8(out.stdout).ok())
-                                                            .map(|s| s.trim().to_owned())
-                                                            )
-                .expect("need to specify SYSROOT env var during clippy compilation, or use rustup or multirust"),
+    let sys_root = if let (Some(home), Some(toolchain)) = (home, toolchain) {
+        format!("{}/toolchains/{}", home, toolchain)
+    } else {
+        option_env!("SYSROOT")
+            .map(|s| s.to_owned())
+            .or(Command::new("rustc")
+                .arg("--print")
+                .arg("sysroot")
+                .output()
+                .ok()
+                .and_then(|out| String::from_utf8(out.stdout).ok())
+                .map(|s| s.trim().to_owned()))
+            .expect("need to specify SYSROOT env var during clippy compilation, or use rustup or multirust")
     };
 
     if let Some("clippy") = std::env::args().nth(1).as_ref().map(AsRef::as_ref) {
-        let mut metadata = cargo::metadata().expect("could not obtain cargo metadata");
+        // this arm is executed on the initial call to `cargo clippy`
+
+        if std::env::args().any(|a| a == "--help" || a == "-h") {
+            show_help();
+            return;
+        }
+
+        let manifest_path_arg = std::env::args().skip(2).find(|val| val.starts_with("--manifest-path="));
+
+        let mut metadata = cargo::metadata(manifest_path_arg.as_ref().map(AsRef::as_ref)).expect("could not obtain cargo metadata");
+
         assert_eq!(metadata.version, 1);
-        for target in metadata.packages.remove(0).targets {
+
+        let manifest_path = manifest_path_arg.map(|arg| PathBuf::from(Path::new(&arg["--manifest-path=".len()..])));
+
+        let current_dir = std::env::current_dir();
+
+        let package_index = metadata.packages.iter()
+            .position(|package| {
+                let package_manifest_path = Path::new(&package.manifest_path);
+                if let Some(ref manifest_path) = manifest_path {
+                    package_manifest_path == manifest_path
+                } else {
+                    let current_dir = current_dir.as_ref().expect("could not read current directory");
+                    let package_manifest_directory = package_manifest_path.parent().expect("could not find parent directory of package manifest");
+                    package_manifest_directory == current_dir
+                }
+            })
+            .expect("could not find matching package");
+        let package = metadata.packages.remove(package_index);
+        for target in package.targets {
             let args = std::env::args().skip(2);
             if let Some(first) = target.kind.get(0) {
                 if target.kind.len() > 1 || first.ends_with("lib") {
-                    process(std::iter::once("--lib".to_owned()).chain(args), &dep_path, &sys_root);
-                } else if first == "bin" {
-                    process(vec!["--bin".to_owned(), target.name].into_iter().chain(args), &dep_path, &sys_root);
+                    if let Err(code) = process(std::iter::once("--lib".to_owned()).chain(args), &dep_path, &sys_root) {
+                        std::process::exit(code);
+                    }
+                } else if ["bin", "example", "test", "bench"].contains(&&**first) {
+                    if let Err(code) = process(vec![format!("--{}", first), target.name].into_iter().chain(args), &dep_path, &sys_root) {
+                        std::process::exit(code);
+                    }
                 }
             } else {
                 panic!("badly formatted cargo metadata: target::kind is an empty array");
             }
         }
     } else {
-        let args: Vec<String> = if env::args().any(|s| s == "--sysroot") {
+        // this arm is executed when cargo-clippy runs `cargo rustc` with the `RUSTC` env var set to itself
+
+        // this conditional check for the --sysroot flag is there so users can call `cargo-clippy` directly
+        // without having to pass --sysroot or anything
+        let mut args: Vec<String> = if env::args().any(|s| s == "--sysroot") {
             env::args().collect()
         } else {
             env::args().chain(Some("--sysroot".to_owned())).chain(Some(sys_root)).collect()
         };
-        let (result, _) = rustc_driver::run_compiler(&args, &mut ClippyCompilerCalls::new());
+
+        // this check ensures that dependencies are built but not linted and the final crate is
+        // linted but not built
+        args.extend_from_slice(&["--cfg".to_owned(), r#"feature="cargo-clippy""#.to_owned()]);
+
+        let mut ccc = ClippyCompilerCalls::new(env::args().any(|s| s == "-Zno-trans"));
+        let (result, _) = rustc_driver::run_compiler(&args, &mut ccc, None, None);
 
         if let Err(err_count) = result {
             if err_count > 0 {
@@ -152,8 +240,10 @@ pub fn main() {
     }
 }
 
-fn process<P, I>(old_args: I, dep_path: P, sysroot: &str)
-    where P: AsRef<Path>, I: Iterator<Item=String> {
+fn process<P, I>(old_args: I, dep_path: P, sysroot: &str) -> Result<(), i32>
+    where P: AsRef<Path>,
+          I: Iterator<Item = String>
+{
 
     let mut args = vec!["rustc".to_owned()];
 
@@ -170,6 +260,8 @@ fn process<P, I>(old_args: I, dep_path: P, sysroot: &str)
     args.push(String::from("--sysroot"));
     args.push(sysroot.to_owned());
     args.push("-Zno-trans".to_owned());
+    args.push("--cfg".to_owned());
+    args.push(r#"feature="cargo-clippy""#.to_owned());
 
     let path = std::env::current_exe().expect("current executable path invalid");
     let exit_status = std::process::Command::new("cargo")
@@ -178,7 +270,9 @@ fn process<P, I>(old_args: I, dep_path: P, sysroot: &str)
         .spawn().expect("could not run cargo")
         .wait().expect("failed to wait for cargo?");
 
-    if let Some(code) = exit_status.code() {
-        std::process::exit(code);
+    if exit_status.success() {
+        Ok(())
+    } else {
+        Err(exit_status.code().unwrap_or(-1))
     }
 }