src/bin/rustfmt.rs

   1 // Copyright 2015 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 #![cfg(not(test))]
  12
  13
  14 extern crate log;
  15 extern crate rustfmt;
  16 extern crate toml;
  17 extern crate env_logger;
  18 extern crate getopts;
  19
  20 use rustfmt::{run, Input, Summary};
  21 use rustfmt::file_lines::FileLines;
  22 use rustfmt::config::{Config, WriteMode};
  23
  24 use std::{env, error};
  25 use std::fs::{self, File};
  26 use std::io::{self, ErrorKind, Read, Write};
  27 use std::path::{Path, PathBuf};
  28 use std::str::FromStr;
  29
  30 use getopts::{Matches, Options};
  31
  32 // Include git commit hash and worktree status; contents are like
  33 //   const COMMIT_HASH: Option<&'static str> = Some("c31a366");
  34 //   const WORKTREE_CLEAN: Option<bool> = Some(false);
  35 // with `None` if running git failed, eg if it is not installed.
  36 include!(concat!(env!("OUT_DIR"), "/git_info.rs"));
  37
  38 type FmtError = Box<error::Error + Send + Sync>;
  39 type FmtResult<T> = std::result::Result<T, FmtError>;
  40
  41 /// Rustfmt operations.
  42 enum Operation {
  43     /// Format files and their child modules.
  44     Format {
  45         files: Vec<PathBuf>,
  46         config_path: Option<PathBuf>,
  47     },
  48     /// Print the help message.
  49     Help,
  50     // Print version information
  51     Version,
  52     /// Print detailed configuration help.
  53     ConfigHelp,
  54     /// No file specified, read from stdin
  55     Stdin {
  56         input: String,
  57         config_path: Option<PathBuf>,
  58     },
  59 }
  60
  61 /// Parsed command line options.
  62 #[derive(Clone, Debug, Default)]
  63 struct CliOptions {
  64     skip_children: bool,
  65     verbose: bool,
  66     write_mode: Option<WriteMode>,
  67     file_lines: FileLines, // Default is all lines in all files.
  68 }
  69
  70 impl CliOptions {
  71     fn from_matches(matches: &Matches) -> FmtResult<CliOptions> {
  72         let mut options = CliOptions::default();
  73         options.skip_children = matches.opt_present("skip-children");
  74         options.verbose = matches.opt_present("verbose");
  75
  76         if let Some(ref write_mode) = matches.opt_str("write-mode") {
  77             if let Ok(write_mode) = WriteMode::from_str(write_mode) {
  78                 options.write_mode = Some(write_mode);
  79             } else {
  80                 return Err(FmtError::from(format!("Invalid write-mode: {}", write_mode)));
  81             }
  82         }
  83
  84         if let Some(ref file_lines) = matches.opt_str("file-lines") {
  85             options.file_lines = try!(file_lines.parse());
  86         }
  87
  88         Ok(options)
  89     }
  90
  91     fn apply_to(self, config: &mut Config) {
  92         config.skip_children = self.skip_children;
  93         config.verbose = self.verbose;
  94         config.file_lines = self.file_lines;
  95         if let Some(write_mode) = self.write_mode {
  96             config.write_mode = write_mode;
  97         }
  98     }
  99 }
 100
 101 /// Try to find a project file in the given directory and its parents. Returns the path of a the
 102 /// nearest project file if one exists, or `None` if no project file was found.
 103 fn lookup_project_file(dir: &Path) -> FmtResult<Option<PathBuf>> {
 104     let mut current = if dir.is_relative() {
 105         try!(env::current_dir()).join(dir)
 106     } else {
 107         dir.to_path_buf()
 108     };
 109
 110     current = try!(fs::canonicalize(current));
 111
 112     const CONFIG_FILE_NAMES: [&'static str; 2] = [".rustfmt.toml", "rustfmt.toml"];
 113
 114     loop {
 115         for config_file_name in &CONFIG_FILE_NAMES {
 116             let config_file = current.join(config_file_name);
 117             match fs::metadata(&config_file) {
 118                 // Only return if it's a file to handle the unlikely situation of a directory named
 119                 // `rustfmt.toml`.
 120                 Ok(ref md) if md.is_file() => return Ok(Some(config_file)),
 121                 // Return the error if it's something other than `NotFound`; otherwise we didn't
 122                 // find the project file yet, and continue searching.
 123                 Err(e) => {
 124                     if e.kind() != ErrorKind::NotFound {
 125                         return Err(FmtError::from(e));
 126                     }
 127                 }
 128                 _ => {}
 129             }
 130         }
 131
 132         // If the current directory has no parent, we're done searching.
 133         if !current.pop() {
 134             return Ok(None);
 135         }
 136     }
 137 }
 138
 139 /// Resolve the config for input in `dir`.
 140 ///
 141 /// Returns the `Config` to use, and the path of the project file if there was
 142 /// one.
 143 fn resolve_config(dir: &Path) -> FmtResult<(Config, Option<PathBuf>)> {
 144     let path = try!(lookup_project_file(dir));
 145     if path.is_none() {
 146         return Ok((Config::default(), None));
 147     }
 148     let path = path.unwrap();
 149     let mut file = try!(File::open(&path));
 150     let mut toml = String::new();
 151     try!(file.read_to_string(&mut toml));
 152     Ok((Config::from_toml(&toml), Some(path)))
 153 }
 154
 155 /// read the given config file path recursively if present else read the project file path
 156 fn match_cli_path_or_file(config_path: Option<PathBuf>,
 157                           input_file: &Path)
 158                           -> FmtResult<(Config, Option<PathBuf>)> {
 159
 160     if let Some(config_file) = config_path {
 161         let (toml, path) = try!(resolve_config(config_file.as_ref()));
 162         if path.is_some() {
 163             return Ok((toml, path));
 164         }
 165     }
 166     resolve_config(input_file)
 167 }
 168
 169 fn make_opts() -> Options {
 170     let mut opts = Options::new();
 171     opts.optflag("h", "help", "show this message");
 172     opts.optflag("V", "version", "show version information");
 173     opts.optflag("v", "verbose", "print verbose output");
 174     opts.optopt("",
 175                 "write-mode",
 176                 "mode to write in (not usable when piping from stdin)",
 177                 "[replace|overwrite|display|diff|coverage|checkstyle]");
 178     opts.optflag("", "skip-children", "don't reformat child modules");
 179
 180     opts.optflag("",
 181                  "config-help",
 182                  "show details of rustfmt configuration options");
 183     opts.optopt("",
 184                 "config-path",
 185                 "Recursively searches the given path for the rustfmt.toml config file. If not \
 186                  found reverts to the input file path",
 187                 "[Path for the configuration file]");
 188     opts.optopt("",
 189                 "file-lines",
 190                 "Format specified line ranges. See README for more detail on the JSON format.",
 191                 "JSON");
 192
 193     opts
 194 }
 195
 196 fn execute(opts: &Options) -> FmtResult<Summary> {
 197     let matches = try!(opts.parse(env::args().skip(1)));
 198
 199     match try!(determine_operation(&matches)) {
 200         Operation::Help => {
 201             print_usage(opts, "");
 202             Ok(Summary::new())
 203         }
 204         Operation::Version => {
 205             print_version();
 206             Ok(Summary::new())
 207         }
 208         Operation::ConfigHelp => {
 209             Config::print_docs();
 210             Ok(Summary::new())
 211         }
 212         Operation::Stdin { input, config_path } => {
 213             // try to read config from local directory
 214             let (mut config, _) = match_cli_path_or_file(config_path, &env::current_dir().unwrap())
 215                 .expect("Error resolving config");
 216
 217             // write_mode is always Plain for Stdin.
 218             config.write_mode = WriteMode::Plain;
 219
 220             Ok(run(Input::Text(input), &config))
 221         }
 222         Operation::Format {
 223             mut files,
 224             config_path,
 225         } => {
 226             let options = try!(CliOptions::from_matches(&matches));
 227
 228             // Add any additional files that were specified via `--file-lines`.
 229             files.extend(options.file_lines
 230                              .files()
 231                              .cloned()
 232                              .map(PathBuf::from));
 233
 234             let mut config = Config::default();
 235             let mut path = None;
 236             // Load the config path file if provided
 237             if let Some(config_file) = config_path {
 238                 let (cfg_tmp, path_tmp) = resolve_config(config_file.as_ref())
 239                     .expect(&format!("Error resolving config for {:?}", config_file));
 240                 config = cfg_tmp;
 241                 path = path_tmp;
 242             };
 243
 244             if options.verbose {
 245                 if let Some(path) = path.as_ref() {
 246                     println!("Using rustfmt config file {}", path.display());
 247                 }
 248             }
 249
 250             let mut error_summary = Summary::new();
 251             for file in files {
 252                 // Check the file directory if the config-path could not be read or not provided
 253                 if path.is_none() {
 254                     let (config_tmp, path_tmp) = resolve_config(file.parent().unwrap())
 255                         .expect(&format!("Error resolving config for {}", file.display()));
 256                     if options.verbose {
 257                         if let Some(path) = path_tmp.as_ref() {
 258                             println!("Using rustfmt config file {} for {}",
 259                                      path.display(),
 260                                      file.display());
 261                         }
 262                     }
 263                     config = config_tmp;
 264                 }
 265
 266                 options.clone().apply_to(&mut config);
 267                 error_summary.add(run(Input::File(file), &config));
 268             }
 269             Ok(error_summary)
 270         }
 271     }
 272 }
 273
 274 fn main() {
 275     let _ = env_logger::init();
 276
 277     let opts = make_opts();
 278
 279     let exit_code = match execute(&opts) {
 280         Ok(summary) => {
 281             if summary.has_operational_errors() {
 282                 1
 283             } else if summary.has_parsing_errors() {
 284                 2
 285             } else if summary.has_formatting_errors() {
 286                 3
 287             } else if summary.has_diff {
 288                 // should only happen in diff mode
 289                 4
 290             } else {
 291                 assert!(summary.has_no_errors());
 292                 0
 293             }
 294         }
 295         Err(e) => {
 296             print_usage(&opts, &e.to_string());
 297             1
 298         }
 299     };
 300     // Make sure standard output is flushed before we exit.
 301     std::io::stdout().flush().unwrap();
 302
 303     // Exit with given exit code.
 304     //
 305     // NOTE: This immediately terminates the process without doing any cleanup,
 306     // so make sure to finish all necessary cleanup before this is called.
 307     std::process::exit(exit_code);
 308 }
 309
 310 fn print_usage(opts: &Options, reason: &str) {
 311     let reason = format!("{}\nusage: {} [options] <file>...",
 312                          reason,
 313                          env::args_os().next().unwrap().to_string_lossy());
 314     println!("{}", opts.usage(&reason));
 315 }
 316
 317 fn print_version() {
 318     println!("{} ({}{})",
 319              option_env!("CARGO_PKG_VERSION").unwrap_or("unknown"),
 320              COMMIT_HASH.unwrap_or("git commit unavailable"),
 321              match WORKTREE_CLEAN {
 322                  Some(false) => " worktree dirty",
 323                  _ => "",
 324              });
 325 }
 326
 327 fn determine_operation(matches: &Matches) -> FmtResult<Operation> {
 328     if matches.opt_present("h") {
 329         return Ok(Operation::Help);
 330     }
 331
 332     if matches.opt_present("config-help") {
 333         return Ok(Operation::ConfigHelp);
 334     }
 335
 336     if matches.opt_present("version") {
 337         return Ok(Operation::Version);
 338     }
 339
 340     // Read the config_path and convert to parent dir if a file is provided.
 341     let config_path: Option<PathBuf> = matches.opt_str("config-path")
 342         .map(PathBuf::from)
 343         .and_then(|dir| {
 344                       if dir.is_file() {
 345                           return dir.parent().map(|v| v.into());
 346                       }
 347                       Some(dir)
 348                   });
 349
 350     // if no file argument is supplied and `--file-lines` is not specified, read from stdin
 351     if matches.free.is_empty() && !matches.opt_present("file-lines") {
 352
 353         let mut buffer = String::new();
 354         try!(io::stdin().read_to_string(&mut buffer));
 355
 356         return Ok(Operation::Stdin {
 357                       input: buffer,
 358                       config_path: config_path,
 359                   });
 360     }
 361
 362     // We append files from `--file-lines` later in `execute()`.
 363     let files: Vec<_> = matches.free
 364         .iter()
 365         .map(PathBuf::from)
 366         .collect();
 367
 368     Ok(Operation::Format {
 369            files: files,
 370            config_path: config_path,
 371        })
 372 }