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_nightly as 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, get_toml_path};
  23
  24 use std::{env, error};
  25 use std::fs::File;
  26 use std::io::{self, Read, Write};
  27 use std::path::{Path, PathBuf};
  28 use std::str::FromStr;
  29
  30 use getopts::{Matches, Options};
  31
  32 type FmtError = Box<error::Error + Send + Sync>;
  33 type FmtResult<T> = std::result::Result<T, FmtError>;
  34
  35 /// Rustfmt operations.
  36 enum Operation {
  37     /// Format files and their child modules.
  38     Format {
  39         files: Vec<PathBuf>,
  40         config_path: Option<PathBuf>,
  41         minimal_config_path: Option<String>,
  42     },
  43     /// Print the help message.
  44     Help,
  45     // Print version information
  46     Version,
  47     /// Print detailed configuration help.
  48     ConfigHelp,
  49     /// Output default config to a file
  50     ConfigOutputDefault { path: String },
  51     /// No file specified, read from stdin
  52     Stdin {
  53         input: String,
  54         config_path: Option<PathBuf>,
  55     },
  56 }
  57
  58 /// Parsed command line options.
  59 #[derive(Clone, Debug, Default)]
  60 struct CliOptions {
  61     skip_children: bool,
  62     verbose: bool,
  63     write_mode: Option<WriteMode>,
  64     file_lines: FileLines, // Default is all lines in all files.
  65 }
  66
  67 impl CliOptions {
  68     fn from_matches(matches: &Matches) -> FmtResult<CliOptions> {
  69         let mut options = CliOptions::default();
  70         options.skip_children = matches.opt_present("skip-children");
  71         options.verbose = matches.opt_present("verbose");
  72
  73         if let Some(ref write_mode) = matches.opt_str("write-mode") {
  74             if let Ok(write_mode) = WriteMode::from_str(write_mode) {
  75                 options.write_mode = Some(write_mode);
  76             } else {
  77                 return Err(FmtError::from(
  78                     format!("Invalid write-mode: {}", write_mode),
  79                 ));
  80             }
  81         } else if !matches.opt_present("no-warn-write-mode") {
  82             println!(
  83                 "Warning: the default write-mode for Rustfmt will soon change to overwrite \
  84                  - this will not leave backups of changed files."
  85             );
  86         }
  87
  88         if let Some(ref file_lines) = matches.opt_str("file-lines") {
  89             options.file_lines = file_lines.parse()?;
  90         }
  91
  92         Ok(options)
  93     }
  94
  95     fn apply_to(self, config: &mut Config) {
  96         config.set().skip_children(self.skip_children);
  97         config.set().verbose(self.verbose);
  98         config.set().file_lines(self.file_lines);
  99         if let Some(write_mode) = self.write_mode {
 100             config.set().write_mode(write_mode);
 101         }
 102     }
 103 }
 104
 105 /// read the given config file path recursively if present else read the project file path
 106 fn match_cli_path_or_file(
 107     config_path: Option<PathBuf>,
 108     input_file: &Path,
 109 ) -> FmtResult<(Config, Option<PathBuf>)> {
 110
 111     if let Some(config_file) = config_path {
 112         let toml = Config::from_toml_path(config_file.as_ref())?;
 113         return Ok((toml, Some(config_file)));
 114     }
 115     Config::from_resolved_toml_path(input_file).map_err(|e| FmtError::from(e))
 116 }
 117
 118 fn make_opts() -> Options {
 119     let mut opts = Options::new();
 120     opts.optflag("h", "help", "show this message");
 121     opts.optflag("V", "version", "show version information");
 122     opts.optflag("v", "verbose", "print verbose output");
 123     // Suppress warning. Remove this option after the default write mode changed to overwrite.
 124     opts.optflag(
 125         "w",
 126         "no-warn-write-mode",
 127         "inhibit warning about write-mode change",
 128     );
 129     opts.optopt(
 130         "",
 131         "write-mode",
 132         "mode to write in (not usable when piping from stdin)",
 133         "[replace|overwrite|display|diff|coverage|checkstyle]",
 134     );
 135     opts.optflag("", "skip-children", "don't reformat child modules");
 136
 137     opts.optflag(
 138         "",
 139         "config-help",
 140         "show details of rustfmt configuration options",
 141     );
 142     opts.optopt(
 143         "",
 144         "dump-default-config",
 145         "Dumps the default configuration to a file and exits.",
 146         "PATH",
 147     );
 148     opts.optopt(
 149         "",
 150         "dump-minimal-config",
 151         "Dumps configuration options that were checked during formatting to a file.",
 152         "PATH",
 153     );
 154     opts.optopt(
 155         "",
 156         "config-path",
 157         "Recursively searches the given path for the rustfmt.toml config file. If not \
 158          found reverts to the input file path",
 159         "[Path for the configuration file]",
 160     );
 161     opts.optopt(
 162         "",
 163         "file-lines",
 164         "Format specified line ranges. See README for more detail on the JSON format.",
 165         "JSON",
 166     );
 167
 168     opts
 169 }
 170
 171 fn execute(opts: &Options) -> FmtResult<Summary> {
 172     let matches = opts.parse(env::args().skip(1))?;
 173
 174     match determine_operation(&matches)? {
 175         Operation::Help => {
 176             print_usage(opts, "");
 177             Summary::print_exit_codes();
 178             Ok(Summary::new())
 179         }
 180         Operation::Version => {
 181             print_version();
 182             Ok(Summary::new())
 183         }
 184         Operation::ConfigHelp => {
 185             Config::print_docs();
 186             Ok(Summary::new())
 187         }
 188         Operation::ConfigOutputDefault { path } => {
 189             let mut file = File::create(path)?;
 190             let toml = Config::default().all_options().to_toml()?;
 191             file.write_all(toml.as_bytes())?;
 192             Ok(Summary::new())
 193         }
 194         Operation::Stdin { input, config_path } => {
 195             // try to read config from local directory
 196             let (mut config, _) =
 197                 match_cli_path_or_file(config_path, &env::current_dir().unwrap())?;
 198
 199             // write_mode is always Plain for Stdin.
 200             config.set().write_mode(WriteMode::Plain);
 201
 202             // parse file_lines
 203             if let Some(ref file_lines) = matches.opt_str("file-lines") {
 204                 config.set().file_lines(file_lines.parse()?);
 205                 for f in config.file_lines().files() {
 206                     if f != "stdin" {
 207                         println!("Warning: Extra file listed in file_lines option '{}'", f);
 208                     }
 209                 }
 210             }
 211
 212             Ok(run(Input::Text(input), &config))
 213         }
 214         Operation::Format {
 215             files,
 216             config_path,
 217             minimal_config_path,
 218         } => {
 219             let options = CliOptions::from_matches(&matches)?;
 220
 221             for f in options.file_lines.files() {
 222                 if !files.contains(&PathBuf::from(f)) {
 223                     println!("Warning: Extra file listed in file_lines option '{}'", f);
 224                 }
 225             }
 226
 227             let mut config = Config::default();
 228             // Load the config path file if provided
 229             if let Some(config_file) = config_path.as_ref() {
 230                 config = Config::from_toml_path(config_file.as_ref())?;
 231             };
 232
 233             if options.verbose {
 234                 if let Some(path) = config_path.as_ref() {
 235                     println!("Using rustfmt config file {}", path.display());
 236                 }
 237             }
 238
 239             let mut error_summary = Summary::new();
 240             for file in files {
 241                 if !file.exists() {
 242                     println!("Error: file `{}` does not exist", file.to_str().unwrap());
 243                     error_summary.add_operational_error();
 244                 } else if file.is_dir() {
 245                     println!("Error: `{}` is a directory", file.to_str().unwrap());
 246                     error_summary.add_operational_error();
 247                 } else {
 248                     // Check the file directory if the config-path could not be read or not provided
 249                     if config_path.is_none() {
 250                         let (config_tmp, path_tmp) =
 251                             Config::from_resolved_toml_path(file.parent().unwrap())?;
 252                         if options.verbose {
 253                             if let Some(path) = path_tmp.as_ref() {
 254                                 println!(
 255                                     "Using rustfmt config file {} for {}",
 256                                     path.display(),
 257                                     file.display()
 258                                 );
 259                             }
 260                         }
 261                         config = config_tmp;
 262                     }
 263
 264                     options.clone().apply_to(&mut config);
 265                     error_summary.add(run(Input::File(file), &config));
 266                 }
 267             }
 268
 269             // If we were given a path via dump-minimal-config, output any options
 270             // that were used during formatting as TOML.
 271             if let Some(path) = minimal_config_path {
 272                 let mut file = File::create(path)?;
 273                 let toml = config.used_options().to_toml()?;
 274                 file.write_all(toml.as_bytes())?;
 275             }
 276
 277             Ok(error_summary)
 278         }
 279     }
 280 }
 281
 282 fn main() {
 283     let _ = env_logger::init();
 284
 285     let opts = make_opts();
 286
 287     let exit_code = match execute(&opts) {
 288         Ok(summary) => {
 289             if summary.has_operational_errors() {
 290                 1
 291             } else if summary.has_parsing_errors() {
 292                 2
 293             } else if summary.has_formatting_errors() {
 294                 3
 295             } else if summary.has_diff {
 296                 // should only happen in diff mode
 297                 4
 298             } else {
 299                 assert!(summary.has_no_errors());
 300                 0
 301             }
 302         }
 303         Err(e) => {
 304             print_usage(&opts, &e.to_string());
 305             1
 306         }
 307     };
 308     // Make sure standard output is flushed before we exit.
 309     std::io::stdout().flush().unwrap();
 310
 311     // Exit with given exit code.
 312     //
 313     // NOTE: This immediately terminates the process without doing any cleanup,
 314     // so make sure to finish all necessary cleanup before this is called.
 315     std::process::exit(exit_code);
 316 }
 317
 318 fn print_usage(opts: &Options, reason: &str) {
 319     let reason = format!(
 320         "{}\n\nusage: {} [options] <file>...",
 321         reason,
 322         env::args_os().next().unwrap().to_string_lossy()
 323     );
 324     println!("{}", opts.usage(&reason));
 325 }
 326
 327 fn print_version() {
 328     println!(
 329         "{}-nightly{}",
 330         env!("CARGO_PKG_VERSION"),
 331         include_str!(concat!(env!("OUT_DIR"), "/commit-info.txt"))
 332     )
 333 }
 334
 335 fn determine_operation(matches: &Matches) -> FmtResult<Operation> {
 336     if matches.opt_present("h") {
 337         return Ok(Operation::Help);
 338     }
 339
 340     if matches.opt_present("config-help") {
 341         return Ok(Operation::ConfigHelp);
 342     }
 343
 344     if let Some(path) = matches.opt_str("dump-default-config") {
 345         return Ok(Operation::ConfigOutputDefault { path });
 346     }
 347
 348     if matches.opt_present("version") {
 349         return Ok(Operation::Version);
 350     }
 351
 352     let config_path_not_found = |path: &str| -> FmtResult<Operation> {
 353         Err(FmtError::from(format!(
 354             "Error: unable to find a config file for the given path: `{}`",
 355             path
 356         )))
 357     };
 358
 359     // Read the config_path and convert to parent dir if a file is provided.
 360     // If a config file cannot be found from the given path, return error.
 361     let config_path: Option<PathBuf> = match matches.opt_str("config-path").map(PathBuf::from) {
 362         Some(ref path) if !path.exists() => return config_path_not_found(path.to_str().unwrap()),
 363         Some(ref path) if path.is_dir() => {
 364             let config_file_path = get_toml_path(path)?;
 365             if config_file_path.is_some() {
 366                 config_file_path
 367             } else {
 368                 return config_path_not_found(path.to_str().unwrap());
 369             }
 370         }
 371         path @ _ => path,
 372     };
 373
 374     // If no path is given, we won't output a minimal config.
 375     let minimal_config_path = matches.opt_str("dump-minimal-config");
 376
 377     // if no file argument is supplied, read from stdin
 378     if matches.free.is_empty() {
 379         let mut buffer = String::new();
 380         io::stdin().read_to_string(&mut buffer)?;
 381
 382         return Ok(Operation::Stdin {
 383             input: buffer,
 384             config_path: config_path,
 385         });
 386     }
 387
 388     let files: Vec<_> = matches
 389         .free
 390         .iter()
 391         .map(|s| {
 392             let p = PathBuf::from(s);
 393             // we will do comparison later, so here tries to canonicalize first
 394             // to get the expected behavior.
 395             p.canonicalize().unwrap_or(p)
 396         })
 397         .collect();
 398
 399     Ok(Operation::Format {
 400         files: files,
 401         config_path: config_path,
 402         minimal_config_path: minimal_config_path,
 403     })
 404 }