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