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.
13 use std::default::Default;
15 use std::io::{Error, ErrorKind, Read};
16 use std::path::{Path, PathBuf};
19 use config::config_type::ConfigType;
20 pub use config::file_lines::{FileLines, FileName, Range};
21 pub use config::lists::*;
22 pub use config::options::*;
34 /// This macro defines configuration options used in rustfmt. Each option
35 /// is defined as follows:
37 /// `name: value type, default value, is stable, description;`
40 max_width: usize, 100, true, "Maximum width of each line";
41 hard_tabs: bool, false, true, "Use tab characters for indentation, spaces for alignment";
42 tab_spaces: usize, 4, true, "Number of spaces per tab";
43 newline_style: NewlineStyle, NewlineStyle::Unix, true, "Unix or Windows line endings";
44 use_small_heuristics: Heuristics, Heuristics::Default, true, "Whether to use different \
45 formatting for items and expressions if they satisfy a heuristic notion of 'small'.";
46 indent_style: IndentStyle, IndentStyle::Block, false, "How do we indent expressions or items.";
48 // Comments and strings
49 wrap_comments: bool, false, false, "Break comments to fit on the line";
50 comment_width: usize, 80, false,
51 "Maximum length of comments. No effect unless wrap_comments = true";
52 normalize_comments: bool, false, false, "Convert /* */ comments to // comments where possible";
53 license_template_path: String, String::default(), false,
54 "Beginning of file must match license template";
55 format_strings: bool, false, false, "Format string literals where necessary";
57 // Single line expressions and items
58 empty_item_single_line: bool, true, false,
59 "Put empty-body functions and impls on a single line";
60 struct_lit_single_line: bool, true, false,
61 "Put small struct literals on a single line";
62 fn_single_line: bool, false, false, "Put single-expression functions on a single line";
63 where_single_line: bool, false, false, "Force where clauses to be on a single line";
66 imports_indent: IndentStyle, IndentStyle::Block, false, "Indent of imports";
67 imports_layout: ListTactic, ListTactic::Mixed, false, "Item layout inside a import block";
68 merge_imports: bool, false, false, "Merge imports";
71 reorder_imports: bool, true, true, "Reorder import and extern crate statements alphabetically";
72 reorder_modules: bool, true, true, "Reorder module statements alphabetically in group";
73 reorder_impl_items: bool, false, false, "Reorder impl items";
75 // Spaces around punctuation
76 type_punctuation_density: TypeDensity, TypeDensity::Wide, false,
77 "Determines if '+' or '=' are wrapped in spaces in the punctuation of types";
78 space_before_colon: bool, false, false, "Leave a space before the colon";
79 space_after_colon: bool, true, false, "Leave a space after the colon";
80 spaces_around_ranges: bool, false, false, "Put spaces around the .. and ..= range operators";
81 binop_separator: SeparatorPlace, SeparatorPlace::Front, false,
82 "Where to put a binary operator when a binary expression goes multiline.";
85 remove_nested_parens: bool, true, true, "Remove nested parens.";
86 combine_control_expr: bool, true, false, "Combine control expressions with function calls.";
87 struct_field_align_threshold: usize, 0, false, "Align struct fields if their diffs fits within \
89 match_arm_blocks: bool, true, false, "Wrap the body of arms in blocks when it does not fit on \
90 the same line with the pattern of arms";
91 force_multiline_blocks: bool, false, false,
92 "Force multiline closure bodies and match arms to be wrapped in a block";
93 fn_args_density: Density, Density::Tall, false, "Argument density in functions";
94 brace_style: BraceStyle, BraceStyle::SameLineWhere, false, "Brace style for items";
95 control_brace_style: ControlBraceStyle, ControlBraceStyle::AlwaysSameLine, false,
96 "Brace style for control flow constructs";
97 trailing_semicolon: bool, true, false,
98 "Add trailing semicolon after break, continue and return";
99 trailing_comma: SeparatorTactic, SeparatorTactic::Vertical, false,
100 "How to handle trailing commas for lists";
101 match_block_trailing_comma: bool, false, false,
102 "Put a trailing comma after a block based match arm (non-block arms are not affected)";
103 blank_lines_upper_bound: usize, 1, false,
104 "Maximum number of blank lines which can be put between items.";
105 blank_lines_lower_bound: usize, 0, false,
106 "Minimum number of blank lines which must be put between items.";
108 // Options that can change the source code beyond whitespace/blocks (somewhat linty things)
109 merge_derives: bool, true, true, "Merge multiple `#[derive(...)]` into a single one";
110 use_try_shorthand: bool, false, true, "Replace uses of the try! macro by the ? shorthand";
111 use_field_init_shorthand: bool, false, true, "Use field initialization shorthand if possible";
112 force_explicit_abi: bool, true, true, "Always print the abi for extern items";
113 condense_wildcard_suffixes: bool, false, false, "Replace strings of _ wildcards by a single .. \
116 // Control options (changes the operation of rustfmt, rather than the formatting)
117 color: Color, Color::Auto, false,
118 "What Color option to use when none is supplied: Always, Never, Auto";
119 required_version: String, env!("CARGO_PKG_VERSION").to_owned(), false,
120 "Require a specific version of rustfmt.";
121 unstable_features: bool, false, false,
122 "Enables unstable features. Only available on nightly channel";
123 disable_all_formatting: bool, false, false, "Don't reformat anything";
124 skip_children: bool, false, false, "Don't reformat out of line modules";
125 hide_parse_errors: bool, false, false, "Hide errors from the parser";
126 error_on_line_overflow: bool, false, false, "Error if unable to get all lines within max_width";
127 error_on_unformatted: bool, false, false,
128 "Error if unable to get comments or string literals within max_width, \
129 or they are left with trailing whitespaces";
130 report_todo: ReportTactic, ReportTactic::Never, false,
131 "Report all, none or unnumbered occurrences of TODO in source file comments";
132 report_fixme: ReportTactic, ReportTactic::Never, false,
133 "Report all, none or unnumbered occurrences of FIXME in source file comments";
134 ignore: IgnoreList, IgnoreList::default(), false,
135 "Skip formatting the specified files and directories.";
138 verbose: Verbosity, Verbosity::Normal, false, "How much to information to emit to the user";
139 file_lines: FileLines, FileLines::all(), false,
140 "Lines to format; this is not supported in rustfmt.toml, and can only be specified \
141 via the --file-lines option";
142 width_heuristics: WidthHeuristics, WidthHeuristics::scaled(100), false,
143 "'small' heuristic values";
144 emit_mode: EmitMode, EmitMode::Files, false,
145 "What emit Mode to use when none is supplied";
146 make_backup: bool, false, false, "Backup changed files";
149 /// Load a config by checking the client-supplied options and if appropriate, the
150 /// file system (including searching the file system for overrides).
151 pub fn load_config<O: CliOptions>(
152 file_path: Option<&Path>,
154 ) -> Result<(Config, Option<PathBuf>), Error> {
155 let over_ride = match options {
156 Some(ref opts) => config_path(opts)?,
160 let result = if let Some(over_ride) = over_ride {
161 Config::from_toml_path(over_ride.as_ref()).map(|p| (p, Some(over_ride.to_owned())))
162 } else if let Some(file_path) = file_path {
163 Config::from_resolved_toml_path(file_path)
165 Ok((Config::default(), None))
168 result.map(|(mut c, p)| {
169 if let Some(options) = options {
170 options.apply_to(&mut c);
176 // Check for the presence of known config file names (`rustfmt.toml, `.rustfmt.toml`) in `dir`
178 // Return the path if a config file exists, empty if no file exists, and Error for IO errors
179 fn get_toml_path(dir: &Path) -> Result<Option<PathBuf>, Error> {
180 const CONFIG_FILE_NAMES: [&str; 2] = [".rustfmt.toml", "rustfmt.toml"];
181 for config_file_name in &CONFIG_FILE_NAMES {
182 let config_file = dir.join(config_file_name);
183 match fs::metadata(&config_file) {
184 // Only return if it's a file to handle the unlikely situation of a directory named
186 Ok(ref md) if md.is_file() => return Ok(Some(config_file)),
187 // Return the error if it's something other than `NotFound`; otherwise we didn't
188 // find the project file yet, and continue searching.
190 if e.kind() != ErrorKind::NotFound {
200 fn config_path(options: &CliOptions) -> Result<Option<PathBuf>, Error> {
201 let config_path_not_found = |path: &str| -> Result<Option<PathBuf>, Error> {
205 "Error: unable to find a config file for the given path: `{}`",
211 // Read the config_path and convert to parent dir if a file is provided.
212 // If a config file cannot be found from the given path, return error.
213 match options.config_path() {
214 Some(path) if !path.exists() => config_path_not_found(path.to_str().unwrap()),
215 Some(path) if path.is_dir() => {
216 let config_file_path = get_toml_path(path)?;
217 if config_file_path.is_some() {
220 config_path_not_found(path.to_str().unwrap())
223 path => Ok(path.map(|p| p.to_owned())),
237 // Options that are used by the generated functions
238 max_width: usize, 100, true, "Maximum width of each line";
239 use_small_heuristics: Heuristics, Heuristics::Default, true,
240 "Whether to use different formatting for items and \
241 expressions if they satisfy a heuristic notion of 'small'.";
242 license_template_path: String, String::default(), false,
243 "Beginning of file must match license template";
244 required_version: String, env!("CARGO_PKG_VERSION").to_owned(), false,
245 "Require a specific version of rustfmt.";
246 ignore: IgnoreList, IgnoreList::default(), false,
247 "Skip formatting the specified files and directories.";
248 verbose: Verbosity, Verbosity::Normal, false,
249 "How much to information to emit to the user";
250 file_lines: FileLines, FileLines::all(), false,
251 "Lines to format; this is not supported in rustfmt.toml, and can only be specified \
252 via the --file-lines option";
253 width_heuristics: WidthHeuristics, WidthHeuristics::scaled(100), false,
254 "'small' heuristic values";
256 // Options that are used by the tests
257 stable_option: bool, false, true, "A stable option";
258 unstable_option: bool, false, false, "An unstable option";
263 fn test_config_set() {
264 let mut config = Config::default();
265 config.set().verbose(Verbosity::Quiet);
266 assert_eq!(config.verbose(), Verbosity::Quiet);
267 config.set().verbose(Verbosity::Normal);
268 assert_eq!(config.verbose(), Verbosity::Normal);
272 fn test_config_used_to_toml() {
273 let config = Config::default();
275 let merge_derives = config.merge_derives();
276 let skip_children = config.skip_children();
278 let used_options = config.used_options();
279 let toml = used_options.to_toml().unwrap();
283 "merge_derives = {}\nskip_children = {}\n",
284 merge_derives, skip_children,
292 let config = Config::from_toml("hard_tabs = true", Path::new("")).unwrap();
294 assert_eq!(config.was_set().hard_tabs(), true);
295 assert_eq!(config.was_set().verbose(), false);
299 fn test_print_docs_exclude_unstable() {
300 use self::mock::Config;
302 let mut output = Vec::new();
303 Config::print_docs(&mut output, false);
305 let s = str::from_utf8(&output).unwrap();
307 assert_eq!(s.contains("stable_option"), true);
308 assert_eq!(s.contains("unstable_option"), false);
309 assert_eq!(s.contains("(unstable)"), false);
313 fn test_print_docs_include_unstable() {
314 use self::mock::Config;
316 let mut output = Vec::new();
317 Config::print_docs(&mut output, true);
319 let s = str::from_utf8(&output).unwrap();
320 assert_eq!(s.contains("stable_option"), true);
321 assert_eq!(s.contains("unstable_option"), true);
322 assert_eq!(s.contains("(unstable)"), true);
325 // FIXME(#2183) these tests cannot be run in parallel because they use env vars
327 // fn test_as_not_nightly_channel() {
328 // let mut config = Config::default();
329 // assert_eq!(config.was_set().unstable_features(), false);
330 // config.set().unstable_features(true);
331 // assert_eq!(config.was_set().unstable_features(), false);
335 // fn test_as_nightly_channel() {
336 // let v = ::std::env::var("CFG_RELEASE_CHANNEL").unwrap_or(String::from(""));
337 // ::std::env::set_var("CFG_RELEASE_CHANNEL", "nightly");
338 // let mut config = Config::default();
339 // config.set().unstable_features(true);
340 // assert_eq!(config.was_set().unstable_features(), false);
341 // config.set().unstable_features(true);
342 // assert_eq!(config.unstable_features(), true);
343 // ::std::env::set_var("CFG_RELEASE_CHANNEL", v);
347 // fn test_unstable_from_toml() {
348 // let mut config = Config::from_toml("unstable_features = true").unwrap();
349 // assert_eq!(config.was_set().unstable_features(), false);
350 // let v = ::std::env::var("CFG_RELEASE_CHANNEL").unwrap_or(String::from(""));
351 // ::std::env::set_var("CFG_RELEASE_CHANNEL", "nightly");
352 // config = Config::from_toml("unstable_features = true").unwrap();
353 // assert_eq!(config.was_set().unstable_features(), true);
354 // assert_eq!(config.unstable_features(), true);
355 // ::std::env::set_var("CFG_RELEASE_CHANNEL", v);