src/bin/cargo-fmt.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::env;
  21 use std::fs;
  22 use std::hash::{Hash, Hasher};
  23 use std::io::{self, Write};
  24 use std::path::{Path, PathBuf};
  25 use std::process::{Command, ExitStatus};
  26 use std::str;
  27 use std::collections::HashSet;
  28 use std::iter::FromIterator;
  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(&vec![], &vec![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.iter().any(|s| s == "--dump-default-config") {
 151         HashSet::new()
 152     } else {
 153         get_targets(strategy)?
 154     };
 155
 156     // Currently only bin and lib files get formatted
 157     let files: Vec<_> = targets
 158         .into_iter()
 159         .inspect(|t| {
 160             if verbosity == Verbosity::Verbose {
 161                 println!("[{}] {:?}", t.kind, t.path)
 162             }
 163         })
 164         .map(|t| t.path)
 165         .collect();
 166
 167     run_rustfmt(&files, &rustfmt_args, verbosity)
 168 }
 169
 170 fn get_fmt_args() -> Vec<String> {
 171     // All arguments after -- are passed to rustfmt
 172     env::args().skip_while(|a| a != "--").skip(1).collect()
 173 }
 174
 175 /// Target uses a `path` field for equality and hashing.
 176 #[derive(Debug)]
 177 pub struct Target {
 178     /// A path to the main source file of the target.
 179     path: PathBuf,
 180     /// A kind of target (e.g. lib, bin, example, ...).
 181     kind: String,
 182 }
 183
 184 impl Target {
 185     pub fn from_target(target: &cargo_metadata::Target) -> Self {
 186         let path = PathBuf::from(&target.src_path);
 187         let canonicalized = fs::canonicalize(&path).unwrap_or(path);
 188
 189         Target {
 190             path: canonicalized,
 191             kind: target.kind[0].clone(),
 192         }
 193     }
 194 }
 195
 196 impl PartialEq for Target {
 197     fn eq(&self, other: &Target) -> bool {
 198         self.path == other.path
 199     }
 200 }
 201
 202 impl Eq for Target {}
 203
 204 impl Hash for Target {
 205     fn hash<H: Hasher>(&self, state: &mut H) {
 206         self.path.hash(state);
 207     }
 208 }
 209
 210 #[derive(Debug, PartialEq, Eq)]
 211 pub enum CargoFmtStrategy {
 212     /// Format every packages and dependencies.
 213     All,
 214     /// Format pacakges that are specified by the command line argument.
 215     Some(Vec<String>),
 216     /// Format the root packages only.
 217     Root,
 218 }
 219
 220 impl CargoFmtStrategy {
 221     pub fn from_matches(matches: &Matches) -> CargoFmtStrategy {
 222         match (matches.opt_present("all"), matches.opt_present("p")) {
 223             (false, false) => CargoFmtStrategy::Root,
 224             (true, _) => CargoFmtStrategy::All,
 225             (false, true) => CargoFmtStrategy::Some(matches.opt_strs("p")),
 226         }
 227     }
 228 }
 229
 230 /// Based on the specified `CargoFmtStrategy`, returns a set of main source files.
 231 fn get_targets(strategy: &CargoFmtStrategy) -> Result<HashSet<Target>, io::Error> {
 232     let mut targets = HashSet::new();
 233
 234     match *strategy {
 235         CargoFmtStrategy::Root => get_targets_root_only(&mut targets)?,
 236         CargoFmtStrategy::All => get_targets_recursive(None, &mut targets, &mut HashSet::new())?,
 237         CargoFmtStrategy::Some(ref hitlist) => get_targets_with_hitlist(hitlist, &mut targets)?,
 238     }
 239
 240     if targets.is_empty() {
 241         Err(io::Error::new(
 242             io::ErrorKind::Other,
 243             "Failed to find targets".to_owned(),
 244         ))
 245     } else {
 246         Ok(targets)
 247     }
 248 }
 249
 250 fn get_targets_root_only(targets: &mut HashSet<Target>) -> Result<(), io::Error> {
 251     let metadata = get_cargo_metadata(None)?;
 252
 253     for package in metadata.packages {
 254         for target in package.targets {
 255             targets.insert(Target::from_target(&target));
 256         }
 257     }
 258
 259     Ok(())
 260 }
 261
 262 fn get_targets_recursive(
 263     manifest_path: Option<&Path>,
 264     mut targets: &mut HashSet<Target>,
 265     visited: &mut HashSet<String>,
 266 ) -> Result<(), io::Error> {
 267     let metadata = get_cargo_metadata(manifest_path)?;
 268
 269     for package in metadata.packages {
 270         add_targets(&package.targets, &mut targets);
 271
 272         // Look for local dependencies.
 273         for dependency in package.dependencies {
 274             if dependency.source.is_some() || visited.contains(&dependency.name) {
 275                 continue;
 276             }
 277
 278             let mut manifest_path = PathBuf::from(&package.manifest_path);
 279
 280             manifest_path.pop();
 281             manifest_path.push(&dependency.name);
 282             manifest_path.push("Cargo.toml");
 283
 284             if manifest_path.exists() {
 285                 visited.insert(dependency.name);
 286                 get_targets_recursive(Some(&manifest_path), &mut targets, visited)?;
 287             }
 288         }
 289     }
 290
 291     Ok(())
 292 }
 293
 294 fn get_targets_with_hitlist(
 295     hitlist: &[String],
 296     targets: &mut HashSet<Target>,
 297 ) -> Result<(), io::Error> {
 298     let metadata = get_cargo_metadata(None)?;
 299
 300     let mut workspace_hitlist: HashSet<&String> = HashSet::from_iter(hitlist);
 301
 302     for package in metadata.packages {
 303         if workspace_hitlist.remove(&package.name) {
 304             for target in package.targets {
 305                 targets.insert(Target::from_target(&target));
 306             }
 307         }
 308     }
 309
 310     if workspace_hitlist.is_empty() {
 311         Ok(())
 312     } else {
 313         let package = workspace_hitlist.iter().next().unwrap();
 314         Err(io::Error::new(
 315             io::ErrorKind::InvalidInput,
 316             format!("package `{}` is not a member of the workspace", package),
 317         ))
 318     }
 319 }
 320
 321 fn add_targets(target_paths: &[cargo_metadata::Target], targets: &mut HashSet<Target>) {
 322     for target in target_paths {
 323         targets.insert(Target::from_target(target));
 324     }
 325 }
 326
 327 fn run_rustfmt(
 328     files: &[PathBuf],
 329     fmt_args: &[String],
 330     verbosity: Verbosity,
 331 ) -> Result<ExitStatus, io::Error> {
 332     let stdout = if verbosity == Verbosity::Quiet {
 333         std::process::Stdio::null()
 334     } else {
 335         std::process::Stdio::inherit()
 336     };
 337
 338     if verbosity == Verbosity::Verbose {
 339         print!("rustfmt");
 340         for a in fmt_args {
 341             print!(" {}", a);
 342         }
 343         for f in files {
 344             print!(" {}", f.display());
 345         }
 346         println!();
 347     }
 348
 349     let mut command = Command::new("rustfmt")
 350         .stdout(stdout)
 351         .args(files)
 352         .args(fmt_args)
 353         .spawn()
 354         .map_err(|e| match e.kind() {
 355             io::ErrorKind::NotFound => io::Error::new(
 356                 io::ErrorKind::Other,
 357                 "Could not run rustfmt, please make sure it is in your PATH.",
 358             ),
 359             _ => e,
 360         })?;
 361
 362     command.wait()
 363 }
 364
 365 fn get_cargo_metadata(manifest_path: Option<&Path>) -> Result<cargo_metadata::Metadata, io::Error> {
 366     match cargo_metadata::metadata(manifest_path) {
 367         Ok(metadata) => Ok(metadata),
 368         Err(..) => Err(io::Error::new(
 369             io::ErrorKind::Other,
 370             "`cargo manifest` failed.",
 371         )),
 372     }
 373 }