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     match Config::from_toml(&toml) {
 153         Ok(cfg) => Ok((cfg, Some(path))),
 154         Err(err) => Err(FmtError::from(err)),
 155     }
 156 }
 157
 158 /// read the given config file path recursively if present else read the project file path
 159 fn match_cli_path_or_file(config_path: Option<PathBuf>,
 160                           input_file: &Path)
 161                           -> FmtResult<(Config, Option<PathBuf>)> {
 162
 163     if let Some(config_file) = config_path {
 164         let (toml, path) = try!(resolve_config(config_file.as_ref()));
 165         if path.is_some() {
 166             return Ok((toml, path));
 167         }
 168     }
 169     resolve_config(input_file)
 170 }
 171
 172 fn make_opts() -> Options {
 173     let mut opts = Options::new();
 174     opts.optflag("h", "help", "show this message");
 175     opts.optflag("V", "version", "show version information");
 176     opts.optflag("v", "verbose", "print verbose output");
 177     opts.optopt("",
 178                 "write-mode",
 179                 "mode to write in (not usable when piping from stdin)",
 180                 "[replace|overwrite|display|diff|coverage|checkstyle]");
 181     opts.optflag("", "skip-children", "don't reformat child modules");
 182
 183     opts.optflag("",
 184                  "config-help",
 185                  "show details of rustfmt configuration options");
 186     opts.optopt("",
 187                 "config-path",
 188                 "Recursively searches the given path for the rustfmt.toml config file. If not \
 189                  found reverts to the input file path",
 190                 "[Path for the configuration file]");
 191     opts.optopt("",
 192                 "file-lines",
 193                 "Format specified line ranges. See README for more detail on the JSON format.",
 194                 "JSON");
 195
 196     opts
 197 }
 198
 199 fn execute(opts: &Options) -> FmtResult<Summary> {
 200     let matches = try!(opts.parse(env::args().skip(1)));
 201
 202     match try!(determine_operation(&matches)) {
 203         Operation::Help => {
 204             print_usage(opts, "");
 205             Summary::print_exit_codes();
 206             Ok(Summary::new())
 207         }
 208         Operation::Version => {
 209             print_version();
 210             Ok(Summary::new())
 211         }
 212         Operation::ConfigHelp => {
 213             Config::print_docs();
 214             Ok(Summary::new())
 215         }
 216         Operation::Stdin { input, config_path } => {
 217             // try to read config from local directory
 218             let (mut config, _) = match_cli_path_or_file(config_path,
 219                                                          &env::current_dir().unwrap())?;
 220
 221             // write_mode is always Plain for Stdin.
 222             config.write_mode = WriteMode::Plain;
 223
 224             // parse file_lines
 225             if let Some(ref file_lines) = matches.opt_str("file-lines") {
 226                 config.file_lines = try!(file_lines.parse());
 227                 for f in config.file_lines.files() {
 228                     if f != "stdin" {
 229                         println!("Warning: Extra file listed in file_lines option '{}'", f);
 230                     }
 231                 }
 232             }
 233
 234             Ok(run(Input::Text(input), &config))
 235         }
 236         Operation::Format { files, config_path } => {
 237             let options = try!(CliOptions::from_matches(&matches));
 238
 239             for f in options.file_lines.files() {
 240                 if !files.contains(&PathBuf::from(f)) {
 241                     println!("Warning: Extra file listed in file_lines option '{}'", f);
 242                 }
 243             }
 244
 245             let mut config = Config::default();
 246             let mut path = None;
 247             // Load the config path file if provided
 248             if let Some(config_file) = config_path {
 249                 let (cfg_tmp, path_tmp) = resolve_config(config_file.as_ref())?;
 250                 config = cfg_tmp;
 251                 path = path_tmp;
 252             };
 253
 254             if options.verbose {
 255                 if let Some(path) = path.as_ref() {
 256                     println!("Using rustfmt config file {}", path.display());
 257                 }
 258             }
 259
 260             let mut error_summary = Summary::new();
 261             for file in files {
 262                 // Check the file directory if the config-path could not be read or not provided
 263                 if path.is_none() {
 264                     let (config_tmp, path_tmp) = resolve_config(file.parent().unwrap())?;
 265                     if options.verbose {
 266                         if let Some(path) = path_tmp.as_ref() {
 267                             println!("Using rustfmt config file {} for {}",
 268                                      path.display(),
 269                                      file.display());
 270                         }
 271                     }
 272                     config = config_tmp;
 273                 }
 274
 275                 options.clone().apply_to(&mut config);
 276                 error_summary.add(run(Input::File(file), &config));
 277             }
 278             Ok(error_summary)
 279         }
 280     }
 281 }
 282
 283 fn main() {
 284     let _ = env_logger::init();
 285
 286     let opts = make_opts();
 287
 288     let exit_code = match execute(&opts) {
 289         Ok(summary) => {
 290             if summary.has_operational_errors() {
 291                 1
 292             } else if summary.has_parsing_errors() {
 293                 2
 294             } else if summary.has_formatting_errors() {
 295                 3
 296             } else if summary.has_diff {
 297                 // should only happen in diff mode
 298                 4
 299             } else {
 300                 assert!(summary.has_no_errors());
 301                 0
 302             }
 303         }
 304         Err(e) => {
 305             print_usage(&opts, &e.to_string());
 306             1
 307         }
 308     };
 309     // Make sure standard output is flushed before we exit.
 310     std::io::stdout().flush().unwrap();
 311
 312     // Exit with given exit code.
 313     //
 314     // NOTE: This immediately terminates the process without doing any cleanup,
 315     // so make sure to finish all necessary cleanup before this is called.
 316     std::process::exit(exit_code);
 317 }
 318
 319 fn print_usage(opts: &Options, reason: &str) {
 320     let reason = format!("{}\nusage: {} [options] <file>...",
 321                          reason,
 322                          env::args_os().next().unwrap().to_string_lossy());
 323     println!("{}", opts.usage(&reason));
 324 }
 325
 326 fn print_version() {
 327     println!("{} ({}{})",
 328              option_env!("CARGO_PKG_VERSION").unwrap_or("unknown"),
 329              COMMIT_HASH.unwrap_or("git commit unavailable"),
 330              match WORKTREE_CLEAN {
 331                  Some(false) => " worktree dirty",
 332                  _ => "",
 333              });
 334 }
 335
 336 fn determine_operation(matches: &Matches) -> FmtResult<Operation> {
 337     if matches.opt_present("h") {
 338         return Ok(Operation::Help);
 339     }
 340
 341     if matches.opt_present("config-help") {
 342         return Ok(Operation::ConfigHelp);
 343     }
 344
 345     if matches.opt_present("version") {
 346         return Ok(Operation::Version);
 347     }
 348
 349     // Read the config_path and convert to parent dir if a file is provided.
 350     let config_path: Option<PathBuf> = matches
 351         .opt_str("config-path")
 352         .map(PathBuf::from)
 353         .and_then(|dir| {
 354                       if dir.is_file() {
 355                           return dir.parent().map(|v| v.into());
 356                       }
 357                       Some(dir)
 358                   });
 359
 360     // if no file argument is supplied, read from stdin
 361     if matches.free.is_empty() {
 362         let mut buffer = String::new();
 363         try!(io::stdin().read_to_string(&mut buffer));
 364
 365         return Ok(Operation::Stdin {
 366                       input: buffer,
 367                       config_path: config_path,
 368                   });
 369     }
 370
 371     let files: Vec<_> = matches
 372         .free
 373         .iter()
 374         .map(|s| {
 375                  let p = PathBuf::from(s);
 376                  // we will do comparison later, so here tries to canonicalize first
 377                  // to get the expected behavior.
 378                  p.canonicalize().unwrap_or(p)
 379              })
 380         .collect();
 381
 382     Ok(Operation::Format {
 383            files: files,
 384            config_path: config_path,
 385        })
 386 }