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 #[macro_use]
  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, run_from_stdin};
  21 use rustfmt::config::{Config, WriteMode};
  22
  23 use std::env;
  24 use std::fs::{self, File};
  25 use std::io::{self, Read, Write};
  26 use std::path::{Path, PathBuf};
  27
  28 use getopts::{Matches, Options};
  29
  30 /// Rustfmt operations.
  31 enum Operation {
  32     /// Format files and their child modules.
  33     Format(Vec<PathBuf>, WriteMode),
  34     /// Print the help message.
  35     Help,
  36     // Print version information
  37     Version,
  38     /// Print detailed configuration help.
  39     ConfigHelp,
  40     /// Invalid program input, including reason.
  41     InvalidInput(String),
  42     /// No file specified, read from stdin
  43     Stdin(String, WriteMode),
  44 }
  45
  46 /// Try to find a project file in the input file directory and its parents.
  47 fn lookup_project_file(input_file: &Path) -> io::Result<PathBuf> {
  48     let mut current = if input_file.is_relative() {
  49         try!(env::current_dir()).join(input_file)
  50     } else {
  51         input_file.to_path_buf()
  52     };
  53
  54     current = try!(fs::canonicalize(current));
  55
  56     loop {
  57         let config_file = current.join("rustfmt.toml");
  58         if let Ok(md) = fs::metadata(&config_file) {
  59             // Properly handle unlikely situation of a directory named `rustfmt.toml`.
  60             if md.is_file() {
  61                 return Ok(config_file);
  62             }
  63         }
  64
  65         // If the current directory has no parent, we're done searching.
  66         if !current.pop() {
  67             return Err(io::Error::new(io::ErrorKind::NotFound, "Config not found"));
  68         }
  69     }
  70 }
  71
  72 /// Try to find a project file. If it's found, read it.
  73 fn lookup_and_read_project_file(input_file: &Path) -> io::Result<(PathBuf, String)> {
  74     let path = try!(lookup_project_file(input_file));
  75     let mut file = try!(File::open(&path));
  76     let mut toml = String::new();
  77     try!(file.read_to_string(&mut toml));
  78     Ok((path, toml))
  79 }
  80
  81 fn update_config(config: &mut Config, matches: &Matches) {
  82     config.verbose = matches.opt_present("verbose");
  83     config.skip_children = matches.opt_present("skip-children");
  84 }
  85
  86 fn execute() -> i32 {
  87     let mut opts = Options::new();
  88     opts.optflag("h", "help", "show this message");
  89     opts.optflag("V", "version", "show version information");
  90     opts.optflag("v", "verbose", "show progress");
  91     opts.optopt("",
  92                 "write-mode",
  93                 "mode to write in (not usable when piping from stdin)",
  94                 "[replace|overwrite|display|diff|coverage|checkstyle]");
  95     opts.optflag("", "skip-children", "don't reformat child modules");
  96
  97     opts.optflag("",
  98                  "config-help",
  99                  "show details of rustfmt configuration options");
 100
 101     let matches = match opts.parse(env::args().skip(1)) {
 102         Ok(m) => m,
 103         Err(e) => {
 104             print_usage(&opts, &e.to_string());
 105             return 1;
 106         }
 107     };
 108
 109     let operation = determine_operation(&matches);
 110
 111     match operation {
 112         Operation::InvalidInput(reason) => {
 113             print_usage(&opts, &reason);
 114             1
 115         }
 116         Operation::Help => {
 117             print_usage(&opts, "");
 118             0
 119         }
 120         Operation::Version => {
 121             print_version();
 122             0
 123         }
 124         Operation::ConfigHelp => {
 125             Config::print_docs();
 126             0
 127         }
 128         Operation::Stdin(input, write_mode) => {
 129             // try to read config from local directory
 130             let config = match lookup_and_read_project_file(&Path::new(".")) {
 131                 Ok((_, toml)) => Config::from_toml(&toml),
 132                 Err(_) => Default::default(),
 133             };
 134
 135             run_from_stdin(input, write_mode, &config);
 136             0
 137         }
 138         Operation::Format(files, write_mode) => {
 139             for file in files {
 140                 let mut config = match lookup_and_read_project_file(&file) {
 141                     Ok((path, toml)) => {
 142                         println!("Using rustfmt config file {} for {}",
 143                                  path.display(),
 144                                  file.display());
 145                         Config::from_toml(&toml)
 146                     }
 147                     Err(_) => Default::default(),
 148                 };
 149
 150                 update_config(&mut config, &matches);
 151                 run(&file, write_mode, &config);
 152             }
 153             0
 154         }
 155     }
 156 }
 157
 158 fn main() {
 159     let _ = env_logger::init();
 160     let exit_code = execute();
 161
 162     // Make sure standard output is flushed before we exit.
 163     std::io::stdout().flush().unwrap();
 164
 165     // Exit with given exit code.
 166     //
 167     // NOTE: This immediately terminates the process without doing any cleanup,
 168     // so make sure to finish all necessary cleanup before this is called.
 169     std::process::exit(exit_code);
 170 }
 171
 172 fn print_usage(opts: &Options, reason: &str) {
 173     let reason = format!("{}\nusage: {} [options] <file>...",
 174                          reason,
 175                          env::args_os().next().unwrap().to_string_lossy());
 176     println!("{}", opts.usage(&reason));
 177 }
 178
 179 fn print_version() {
 180     println!("{}.{}.{}{}",
 181              option_env!("CARGO_PKG_VERSION_MAJOR").unwrap_or("X"),
 182              option_env!("CARGO_PKG_VERSION_MINOR").unwrap_or("X"),
 183              option_env!("CARGO_PKG_VERSION_PATCH").unwrap_or("X"),
 184              option_env!("CARGO_PKG_VERSION_PRE").unwrap_or(""));
 185 }
 186
 187 fn determine_operation(matches: &Matches) -> Operation {
 188     if matches.opt_present("h") {
 189         return Operation::Help;
 190     }
 191
 192     if matches.opt_present("config-help") {
 193         return Operation::ConfigHelp;
 194     }
 195
 196     if matches.opt_present("version") {
 197         return Operation::Version;
 198     }
 199
 200     // if no file argument is supplied, read from stdin
 201     if matches.free.is_empty() {
 202
 203         let mut buffer = String::new();
 204         match io::stdin().read_to_string(&mut buffer) {
 205             Ok(..) => (),
 206             Err(e) => return Operation::InvalidInput(e.to_string()),
 207         }
 208
 209         // WriteMode is always plain for Stdin
 210         return Operation::Stdin(buffer, WriteMode::Plain);
 211     }
 212
 213     let write_mode = match matches.opt_str("write-mode") {
 214         Some(mode) => {
 215             match mode.parse() {
 216                 Ok(mode) => mode,
 217                 Err(..) => return Operation::InvalidInput("Unrecognized write mode".into()),
 218             }
 219         }
 220         None => WriteMode::Default,
 221     };
 222
 223     let files: Vec<_> = matches.free.iter().map(PathBuf::from).collect();
 224
 225     Operation::Format(files, write_mode)
 226 }