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