src/cargo-fmt/main.rs

   1 // Copyright 2015-2016 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 // Inspired by Paul Woolcock's cargo-fmt (https://github.com/pwoolcoc/cargo-fmt/)
  12
  13 #![cfg(not(test))]
  14 #![deny(warnings)]
  15
  16 extern crate cargo_metadata;
  17 extern crate getopts;
  18 extern crate serde_json as json;
  19
  20 use std::collections::HashSet;
  21 use std::env;
  22 use std::fs;
  23 use std::hash::{Hash, Hasher};
  24 use std::io::{self, Write};
  25 use std::iter::FromIterator;
  26 use std::path::{Path, PathBuf};
  27 use std::process::{Command, ExitStatus};
  28 use std::str;
  29
  30 use getopts::{Matches, Options};
  31
  32 fn main() {
  33     let exit_status = execute();
  34     std::io::stdout().flush().unwrap();
  35     std::process::exit(exit_status);
  36 }
  37
  38 const SUCCESS: i32 = 0;
  39 const FAILURE: i32 = 1;
  40
  41 fn execute() -> i32 {
  42     let mut opts = getopts::Options::new();
  43     opts.optflag("h", "help", "show this message");
  44     opts.optflag("q", "quiet", "no output printed to stdout");
  45     opts.optflag("v", "verbose", "use verbose output");
  46     opts.optmulti(
  47         "p",
  48         "package",
  49         "specify package to format (only usable in workspaces)",
  50         "<package>",
  51     );
  52     opts.optflag("", "version", "print rustfmt version and exit");
  53     opts.optflag("", "all", "format all packages (only usable in workspaces)");
  54
  55     // If there is any invalid argument passed to `cargo fmt`, return without formatting.
  56     let mut is_package_arg = false;
  57     for arg in env::args().skip(2).take_while(|a| a != "--") {
  58         if arg.starts_with('-') {
  59             is_package_arg = arg.starts_with("--package");
  60         } else if !is_package_arg {
  61             print_usage_to_stderr(&opts, &format!("Invalid argument: `{}`.", arg));
  62             return FAILURE;
  63         } else {
  64             is_package_arg = false;
  65         }
  66     }
  67
  68     let matches = match opts.parse(env::args().skip(1).take_while(|a| a != "--")) {
  69         Ok(m) => m,
  70         Err(e) => {
  71             print_usage_to_stderr(&opts, &e.to_string());
  72             return FAILURE;
  73         }
  74     };
  75
  76     let verbosity = match (matches.opt_present("v"), matches.opt_present("q")) {
  77         (false, false) => Verbosity::Normal,
  78         (false, true) => Verbosity::Quiet,
  79         (true, false) => Verbosity::Verbose,
  80         (true, true) => {
  81             print_usage_to_stderr(&opts, "quiet mode and verbose mode are not compatible");
  82             return FAILURE;
  83         }
  84     };
  85
  86     if matches.opt_present("h") {
  87         print_usage_to_stdout(&opts, "");
  88         return SUCCESS;
  89     }
  90
  91     if matches.opt_present("version") {
  92         return handle_command_status(get_version(verbosity), &opts);
  93     }
  94
  95     let strategy = CargoFmtStrategy::from_matches(&matches);
  96     handle_command_status(format_crate(verbosity, &strategy), &opts)
  97 }
  98
  99 macro_rules! print_usage {
 100     ($print:ident, $opts:ident, $reason:expr) => {{
 101         let msg = format!("{}\nusage: cargo fmt [options]", $reason);
 102         $print!(
 103             "{}\nThis utility formats all bin and lib files of the current crate using rustfmt. \
 104              Arguments after `--` are passed to rustfmt.",
 105             $opts.usage(&msg)
 106         );
 107     }};
 108 }
 109
 110 fn print_usage_to_stdout(opts: &Options, reason: &str) {
 111     print_usage!(println, opts, reason);
 112 }
 113
 114 fn print_usage_to_stderr(opts: &Options, reason: &str) {
 115     print_usage!(eprintln, opts, reason);
 116 }
 117
 118 #[derive(Debug, Clone, Copy, PartialEq)]
 119 pub enum Verbosity {
 120     Verbose,
 121     Normal,
 122     Quiet,
 123 }
 124
 125 fn handle_command_status(status: Result<ExitStatus, io::Error>, opts: &getopts::Options) -> i32 {
 126     match status {
 127         Err(e) => {
 128             print_usage_to_stderr(opts, &e.to_string());
 129             FAILURE
 130         }
 131         Ok(status) => {
 132             if status.success() {
 133                 SUCCESS
 134             } else {
 135                 status.code().unwrap_or(FAILURE)
 136             }
 137         }
 138     }
 139 }
 140
 141 fn get_version(verbosity: Verbosity) -> Result<ExitStatus, io::Error> {
 142     run_rustfmt(&[], &[String::from("--version")], verbosity)
 143 }
 144
 145 fn format_crate(
 146     verbosity: Verbosity,
 147     strategy: &CargoFmtStrategy,
 148 ) -> Result<ExitStatus, io::Error> {
 149     let rustfmt_args = get_fmt_args();
 150     let targets = if rustfmt_args
 151         .iter()
 152         .any(|s| ["--print-config", "-h", "--help", "-V", "--verison"]
 153              .contains(&s.as_str()))
 154     {
 155         HashSet::new()
 156     } else {
 157         get_targets(strategy)?
 158     };
 159
 160     // Currently only bin and lib files get formatted
 161     let files: Vec<_> = targets
 162         .into_iter()
 163         .inspect(|t| {
 164             if verbosity == Verbosity::Verbose {
 165                 println!("[{}] {:?}", t.kind, t.path)
 166             }
 167         })
 168         .map(|t| t.path)
 169         .collect();
 170
 171     run_rustfmt(&files, &rustfmt_args, verbosity)
 172 }
 173
 174 fn get_fmt_args() -> Vec<String> {
 175     // All arguments after -- are passed to rustfmt
 176     env::args().skip_while(|a| a != "--").skip(1).collect()
 177 }
 178
 179 /// Target uses a `path` field for equality and hashing.
 180 #[derive(Debug)]
 181 pub struct Target {
 182     /// A path to the main source file of the target.
 183     path: PathBuf,
 184     /// A kind of target (e.g. lib, bin, example, ...).
 185     kind: String,
 186 }
 187
 188 impl Target {
 189     pub fn from_target(target: &cargo_metadata::Target) -> Self {
 190         let path = PathBuf::from(&target.src_path);
 191         let canonicalized = fs::canonicalize(&path).unwrap_or(path);
 192
 193         Target {
 194             path: canonicalized,
 195             kind: target.kind[0].clone(),
 196         }
 197     }
 198 }
 199
 200 impl PartialEq for Target {
 201     fn eq(&self, other: &Target) -> bool {
 202         self.path == other.path
 203     }
 204 }
 205
 206 impl Eq for Target {}
 207
 208 impl Hash for Target {
 209     fn hash<H: Hasher>(&self, state: &mut H) {
 210         self.path.hash(state);
 211     }
 212 }
 213
 214 #[derive(Debug, PartialEq, Eq)]
 215 pub enum CargoFmtStrategy {
 216     /// Format every packages and dependencies.
 217     All,
 218     /// Format packages that are specified by the command line argument.
 219     Some(Vec<String>),
 220     /// Format the root packages only.
 221     Root,
 222 }
 223
 224 impl CargoFmtStrategy {
 225     pub fn from_matches(matches: &Matches) -> CargoFmtStrategy {
 226         match (matches.opt_present("all"), matches.opt_present("p")) {
 227             (false, false) => CargoFmtStrategy::Root,
 228             (true, _) => CargoFmtStrategy::All,
 229             (false, true) => CargoFmtStrategy::Some(matches.opt_strs("p")),
 230         }
 231     }
 232 }
 233
 234 /// Based on the specified `CargoFmtStrategy`, returns a set of main source files.
 235 fn get_targets(strategy: &CargoFmtStrategy) -> Result<HashSet<Target>, io::Error> {
 236     let mut targets = HashSet::new();
 237
 238     match *strategy {
 239         CargoFmtStrategy::Root => get_targets_root_only(&mut targets)?,
 240         CargoFmtStrategy::All => get_targets_recursive(None, &mut targets, &mut HashSet::new())?,
 241         CargoFmtStrategy::Some(ref hitlist) => get_targets_with_hitlist(hitlist, &mut targets)?,
 242     }
 243
 244     if targets.is_empty() {
 245         Err(io::Error::new(
 246             io::ErrorKind::Other,
 247             "Failed to find targets".to_owned(),
 248         ))
 249     } else {
 250         Ok(targets)
 251     }
 252 }
 253
 254 fn get_targets_root_only(targets: &mut HashSet<Target>) -> Result<(), io::Error> {
 255     let metadata = get_cargo_metadata(None)?;
 256     let current_dir = env::current_dir()?.canonicalize()?;
 257     let current_dir_manifest = current_dir.join("Cargo.toml");
 258     let workspace_root_path = PathBuf::from(&metadata.workspace_root).canonicalize()?;
 259     let in_workspace_root = workspace_root_path == current_dir;
 260
 261     for package in metadata.packages {
 262         if in_workspace_root || PathBuf::from(&package.manifest_path) == current_dir_manifest {
 263             for target in package.targets {
 264                 targets.insert(Target::from_target(&target));
 265             }
 266         }
 267     }
 268
 269     Ok(())
 270 }
 271
 272 fn get_targets_recursive(
 273     manifest_path: Option<&Path>,
 274     mut targets: &mut HashSet<Target>,
 275     visited: &mut HashSet<String>,
 276 ) -> Result<(), io::Error> {
 277     let metadata = get_cargo_metadata(manifest_path)?;
 278
 279     for package in metadata.packages {
 280         add_targets(&package.targets, &mut targets);
 281
 282         // Look for local dependencies.
 283         for dependency in package.dependencies {
 284             if dependency.source.is_some() || visited.contains(&dependency.name) {
 285                 continue;
 286             }
 287
 288             let mut manifest_path = PathBuf::from(&package.manifest_path);
 289
 290             manifest_path.pop();
 291             manifest_path.push(&dependency.name);
 292             manifest_path.push("Cargo.toml");
 293
 294             if manifest_path.exists() {
 295                 visited.insert(dependency.name);
 296                 get_targets_recursive(Some(&manifest_path), &mut targets, visited)?;
 297             }
 298         }
 299     }
 300
 301     Ok(())
 302 }
 303
 304 fn get_targets_with_hitlist(
 305     hitlist: &[String],
 306     targets: &mut HashSet<Target>,
 307 ) -> Result<(), io::Error> {
 308     let metadata = get_cargo_metadata(None)?;
 309
 310     let mut workspace_hitlist: HashSet<&String> = HashSet::from_iter(hitlist);
 311
 312     for package in metadata.packages {
 313         if workspace_hitlist.remove(&package.name) {
 314             for target in package.targets {
 315                 targets.insert(Target::from_target(&target));
 316             }
 317         }
 318     }
 319
 320     if workspace_hitlist.is_empty() {
 321         Ok(())
 322     } else {
 323         let package = workspace_hitlist.iter().next().unwrap();
 324         Err(io::Error::new(
 325             io::ErrorKind::InvalidInput,
 326             format!("package `{}` is not a member of the workspace", package),
 327         ))
 328     }
 329 }
 330
 331 fn add_targets(target_paths: &[cargo_metadata::Target], targets: &mut HashSet<Target>) {
 332     for target in target_paths {
 333         targets.insert(Target::from_target(target));
 334     }
 335 }
 336
 337 fn run_rustfmt(
 338     files: &[PathBuf],
 339     fmt_args: &[String],
 340     verbosity: Verbosity,
 341 ) -> Result<ExitStatus, io::Error> {
 342     let stdout = if verbosity == Verbosity::Quiet {
 343         std::process::Stdio::null()
 344     } else {
 345         std::process::Stdio::inherit()
 346     };
 347
 348     if verbosity == Verbosity::Verbose {
 349         print!("rustfmt");
 350         for a in fmt_args {
 351             print!(" {}", a);
 352         }
 353         for f in files {
 354             print!(" {}", f.display());
 355         }
 356         println!();
 357     }
 358
 359     let mut command = Command::new("rustfmt")
 360         .stdout(stdout)
 361         .args(files)
 362         .args(fmt_args)
 363         .spawn()
 364         .map_err(|e| match e.kind() {
 365             io::ErrorKind::NotFound => io::Error::new(
 366                 io::ErrorKind::Other,
 367                 "Could not run rustfmt, please make sure it is in your PATH.",
 368             ),
 369             _ => e,
 370         })?;
 371
 372     command.wait()
 373 }
 374
 375 fn get_cargo_metadata(manifest_path: Option<&Path>) -> Result<cargo_metadata::Metadata, io::Error> {
 376     match cargo_metadata::metadata(manifest_path) {
 377         Ok(metadata) => Ok(metadata),
 378         Err(..) => Err(io::Error::new(
 379             io::ErrorKind::Other,
 380             "`cargo manifest` failed.",
 381         )),
 382     }
 383 }