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.
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.
17 extern crate env_logger;
20 use rustfmt::{run, Input, Summary};
21 use rustfmt::file_lines::FileLines;
22 use rustfmt::config::{Config, WriteMode};
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;
30 use getopts::{Matches, Options};
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"));
38 type FmtError = Box<error::Error + Send + Sync>;
39 type FmtResult<T> = std::result::Result<T, FmtError>;
41 /// Rustfmt operations.
43 /// Format files and their child modules.
46 config_path: Option<PathBuf>,
48 /// Print the help message.
50 // Print version information
52 /// Print detailed configuration help.
54 /// No file specified, read from stdin
57 config_path: Option<PathBuf>,
61 /// Parsed command line options.
62 #[derive(Clone, Debug, Default)]
66 write_mode: Option<WriteMode>,
67 file_lines: FileLines, // Default is all lines in all files.
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");
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);
80 return Err(FmtError::from(format!("Invalid write-mode: {}", write_mode)));
84 if let Some(ref file_lines) = matches.opt_str("file-lines") {
85 options.file_lines = try!(file_lines.parse());
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;
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)
110 current = try!(fs::canonicalize(current));
112 const CONFIG_FILE_NAMES: [&'static str; 2] = [".rustfmt.toml", "rustfmt.toml"];
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
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.
124 if e.kind() != ErrorKind::NotFound {
125 return Err(FmtError::from(e));
132 // If the current directory has no parent, we're done searching.
139 /// Resolve the config for input in `dir`.
141 /// Returns the `Config` to use, and the path of the project file if there was
143 fn resolve_config(dir: &Path) -> FmtResult<(Config, Option<PathBuf>)> {
144 let path = try!(lookup_project_file(dir));
146 return Ok((Config::default(), None));
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)),
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>,
161 -> FmtResult<(Config, Option<PathBuf>)> {
163 if let Some(config_file) = config_path {
164 let (toml, path) = try!(resolve_config(config_file.as_ref()));
166 return Ok((toml, path));
169 resolve_config(input_file)
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");
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");
185 "show details of rustfmt configuration options");
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]");
193 "Format specified line ranges. See README for more detail on the JSON format.",
199 fn execute(opts: &Options) -> FmtResult<Summary> {
200 let matches = try!(opts.parse(env::args().skip(1)));
202 match try!(determine_operation(&matches)) {
204 print_usage(opts, "");
205 Summary::print_exit_codes();
208 Operation::Version => {
212 Operation::ConfigHelp => {
213 Config::print_docs();
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())?;
221 // write_mode is always Plain for Stdin.
222 config.write_mode = WriteMode::Plain;
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() {
229 println!("Warning: Extra file listed in file_lines option '{}'", f);
234 Ok(run(Input::Text(input), &config))
236 Operation::Format { files, config_path } => {
237 let options = try!(CliOptions::from_matches(&matches));
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);
245 let mut config = Config::default();
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())?;
255 if let Some(path) = path.as_ref() {
256 println!("Using rustfmt config file {}", path.display());
260 let mut error_summary = Summary::new();
263 println!("Error: file `{}` does not exist", file.to_str().unwrap());
264 error_summary.add_operational_error();
265 } else if file.is_dir() {
266 println!("Error: `{}` is a directory", file.to_str().unwrap());
267 error_summary.add_operational_error();
269 // Check the file directory if the config-path could not be read or not provided
271 let (config_tmp, path_tmp) = resolve_config(file.parent().unwrap())?;
273 if let Some(path) = path_tmp.as_ref() {
274 println!("Using rustfmt config file {} for {}",
282 options.clone().apply_to(&mut config);
283 error_summary.add(run(Input::File(file), &config));
292 let _ = env_logger::init();
294 let opts = make_opts();
296 let exit_code = match execute(&opts) {
298 if summary.has_operational_errors() {
300 } else if summary.has_parsing_errors() {
302 } else if summary.has_formatting_errors() {
304 } else if summary.has_diff {
305 // should only happen in diff mode
308 assert!(summary.has_no_errors());
313 print_usage(&opts, &e.to_string());
317 // Make sure standard output is flushed before we exit.
318 std::io::stdout().flush().unwrap();
320 // Exit with given exit code.
322 // NOTE: This immediately terminates the process without doing any cleanup,
323 // so make sure to finish all necessary cleanup before this is called.
324 std::process::exit(exit_code);
327 fn print_usage(opts: &Options, reason: &str) {
328 let reason = format!("{}\nusage: {} [options] <file>...",
330 env::args_os().next().unwrap().to_string_lossy());
331 println!("{}", opts.usage(&reason));
335 println!("{} ({}{})",
336 option_env!("CARGO_PKG_VERSION").unwrap_or("unknown"),
337 COMMIT_HASH.unwrap_or("git commit unavailable"),
338 match WORKTREE_CLEAN {
339 Some(false) => " worktree dirty",
344 fn determine_operation(matches: &Matches) -> FmtResult<Operation> {
345 if matches.opt_present("h") {
346 return Ok(Operation::Help);
349 if matches.opt_present("config-help") {
350 return Ok(Operation::ConfigHelp);
353 if matches.opt_present("version") {
354 return Ok(Operation::Version);
357 // Read the config_path and convert to parent dir if a file is provided.
358 let config_path: Option<PathBuf> = matches
359 .opt_str("config-path")
363 return dir.parent().map(|v| v.into());
368 // if no file argument is supplied, read from stdin
369 if matches.free.is_empty() {
370 let mut buffer = String::new();
371 try!(io::stdin().read_to_string(&mut buffer));
373 return Ok(Operation::Stdin {
375 config_path: config_path,
379 let files: Vec<_> = matches
383 let p = PathBuf::from(s);
384 // we will do comparison later, so here tries to canonicalize first
385 // to get the expected behavior.
386 p.canonicalize().unwrap_or(p)
390 Ok(Operation::Format {
392 config_path: config_path,