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::*;
33 /// This macro defines configuration options used in rustfmt. Each option
34 /// is defined as follows:
36 /// `name: value type, default value, is stable, description;`
39 max_width: usize, 100, true, "Maximum width of each line";
40 hard_tabs: bool, false, true, "Use tab characters for indentation, spaces for alignment";
41 tab_spaces: usize, 4, true, "Number of spaces per tab";
42 newline_style: NewlineStyle, NewlineStyle::Auto, true, "Unix or Windows line endings";
43 use_small_heuristics: Heuristics, Heuristics::Default, true, "Whether to use different \
44 formatting for items and expressions if they satisfy a heuristic notion of 'small'";
45 indent_style: IndentStyle, IndentStyle::Block, false, "How do we indent expressions or items";
47 // Comments. macros, and strings
48 wrap_comments: bool, false, false, "Break comments to fit on the line";
49 format_doc_comments: bool, false, false, "Format doc comments.";
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 normalize_doc_attributes: bool, false, false, "Normalize doc attributes as doc comments";
54 license_template_path: String, String::default(), false,
55 "Beginning of file must match license template";
56 format_strings: bool, false, false, "Format string literals where necessary";
57 format_macro_matchers: bool, false, false,
58 "Format the metavariable matching patterns in macros";
59 format_macro_bodies: bool, true, false, "Format the bodies of macros";
61 // Single line expressions and items
62 empty_item_single_line: bool, true, false,
63 "Put empty-body functions and impls on a single line";
64 struct_lit_single_line: bool, true, false,
65 "Put small struct literals on a single line";
66 fn_single_line: bool, false, false, "Put single-expression functions on a single line";
67 where_single_line: bool, false, false, "Force where clauses to be on a single line";
70 imports_indent: IndentStyle, IndentStyle::Block, false, "Indent of imports";
71 imports_layout: ListTactic, ListTactic::Mixed, false, "Item layout inside a import block";
72 merge_imports: bool, false, false, "Merge imports";
75 reorder_imports: bool, true, true, "Reorder import and extern crate statements alphabetically";
76 reorder_modules: bool, true, true, "Reorder module statements alphabetically in group";
77 reorder_impl_items: bool, false, false, "Reorder impl items";
79 // Spaces around punctuation
80 type_punctuation_density: TypeDensity, TypeDensity::Wide, false,
81 "Determines if '+' or '=' are wrapped in spaces in the punctuation of types";
82 space_before_colon: bool, false, false, "Leave a space before the colon";
83 space_after_colon: bool, true, false, "Leave a space after the colon";
84 spaces_around_ranges: bool, false, false, "Put spaces around the .. and ..= range operators";
85 binop_separator: SeparatorPlace, SeparatorPlace::Front, false,
86 "Where to put a binary operator when a binary expression goes multiline";
89 remove_nested_parens: bool, true, true, "Remove nested parens";
90 combine_control_expr: bool, true, false, "Combine control expressions with function calls";
91 overflow_delimited_expr: bool, false, false,
92 "Allow trailing bracket/brace delimited expressions to overflow";
93 struct_field_align_threshold: usize, 0, false,
94 "Align struct fields if their diffs fits within threshold";
95 enum_discrim_align_threshold: usize, 0, false,
96 "Align enum variants discrims, if their diffs fit within threshold";
97 match_arm_blocks: bool, true, false, "Wrap the body of arms in blocks when it does not fit on \
98 the same line with the pattern of arms";
99 force_multiline_blocks: bool, false, false,
100 "Force multiline closure bodies and match arms to be wrapped in a block";
101 fn_args_density: Density, Density::Tall, false, "Argument density in functions";
102 brace_style: BraceStyle, BraceStyle::SameLineWhere, false, "Brace style for items";
103 control_brace_style: ControlBraceStyle, ControlBraceStyle::AlwaysSameLine, false,
104 "Brace style for control flow constructs";
105 trailing_semicolon: bool, true, false,
106 "Add trailing semicolon after break, continue and return";
107 trailing_comma: SeparatorTactic, SeparatorTactic::Vertical, false,
108 "How to handle trailing commas for lists";
109 match_block_trailing_comma: bool, false, false,
110 "Put a trailing comma after a block based match arm (non-block arms are not affected)";
111 blank_lines_upper_bound: usize, 1, false,
112 "Maximum number of blank lines which can be put between items";
113 blank_lines_lower_bound: usize, 0, false,
114 "Minimum number of blank lines which must be put between items";
115 edition: Edition, Edition::Edition2015, true, "The edition of the parser (RFC 2052)";
117 // Options that can change the source code beyond whitespace/blocks (somewhat linty things)
118 merge_derives: bool, true, true, "Merge multiple `#[derive(...)]` into a single one";
119 use_try_shorthand: bool, false, true, "Replace uses of the try! macro by the ? shorthand";
120 use_field_init_shorthand: bool, false, true, "Use field initialization shorthand if possible";
121 force_explicit_abi: bool, true, true, "Always print the abi for extern items";
122 condense_wildcard_suffixes: bool, false, false, "Replace strings of _ wildcards by a single .. \
125 // Control options (changes the operation of rustfmt, rather than the formatting)
126 color: Color, Color::Auto, false,
127 "What Color option to use when none is supplied: Always, Never, Auto";
128 required_version: String, env!("CARGO_PKG_VERSION").to_owned(), false,
129 "Require a specific version of rustfmt";
130 unstable_features: bool, false, false,
131 "Enables unstable features. Only available on nightly channel";
132 disable_all_formatting: bool, false, false, "Don't reformat anything";
133 skip_children: bool, false, false, "Don't reformat out of line modules";
134 hide_parse_errors: bool, false, false, "Hide errors from the parser";
135 error_on_line_overflow: bool, false, false, "Error if unable to get all lines within max_width";
136 error_on_unformatted: bool, false, false,
137 "Error if unable to get comments or string literals within max_width, \
138 or they are left with trailing whitespaces";
139 report_todo: ReportTactic, ReportTactic::Never, false,
140 "Report all, none or unnumbered occurrences of TODO in source file comments";
141 report_fixme: ReportTactic, ReportTactic::Never, false,
142 "Report all, none or unnumbered occurrences of FIXME in source file comments";
143 ignore: IgnoreList, IgnoreList::default(), false,
144 "Skip formatting the specified files and directories";
147 verbose: Verbosity, Verbosity::Normal, false, "How much to information to emit to the user";
148 file_lines: FileLines, FileLines::all(), false,
149 "Lines to format; this is not supported in rustfmt.toml, and can only be specified \
150 via the --file-lines option";
151 width_heuristics: WidthHeuristics, WidthHeuristics::scaled(100), false,
152 "'small' heuristic values";
153 emit_mode: EmitMode, EmitMode::Files, false,
154 "What emit Mode to use when none is supplied";
155 make_backup: bool, false, false, "Backup changed files";
158 /// Load a config by checking the client-supplied options and if appropriate, the
159 /// file system (including searching the file system for overrides).
160 pub fn load_config<O: CliOptions>(
161 file_path: Option<&Path>,
163 ) -> Result<(Config, Option<PathBuf>), Error> {
164 let over_ride = match options {
165 Some(ref opts) => config_path(opts)?,
169 let result = if let Some(over_ride) = over_ride {
170 Config::from_toml_path(over_ride.as_ref()).map(|p| (p, Some(over_ride.to_owned())))
171 } else if let Some(file_path) = file_path {
172 Config::from_resolved_toml_path(file_path)
174 Ok((Config::default(), None))
177 result.map(|(mut c, p)| {
178 if let Some(options) = options {
179 options.apply_to(&mut c);
185 // Check for the presence of known config file names (`rustfmt.toml, `.rustfmt.toml`) in `dir`
187 // Return the path if a config file exists, empty if no file exists, and Error for IO errors
188 fn get_toml_path(dir: &Path) -> Result<Option<PathBuf>, Error> {
189 const CONFIG_FILE_NAMES: [&str; 2] = [".rustfmt.toml", "rustfmt.toml"];
190 for config_file_name in &CONFIG_FILE_NAMES {
191 let config_file = dir.join(config_file_name);
192 match fs::metadata(&config_file) {
193 // Only return if it's a file to handle the unlikely situation of a directory named
195 Ok(ref md) if md.is_file() => return Ok(Some(config_file)),
196 // Return the error if it's something other than `NotFound`; otherwise we didn't
197 // find the project file yet, and continue searching.
199 if e.kind() != ErrorKind::NotFound {
209 fn config_path(options: &CliOptions) -> Result<Option<PathBuf>, Error> {
210 let config_path_not_found = |path: &str| -> Result<Option<PathBuf>, Error> {
214 "Error: unable to find a config file for the given path: `{}`",
220 // Read the config_path and convert to parent dir if a file is provided.
221 // If a config file cannot be found from the given path, return error.
222 match options.config_path() {
223 Some(path) if !path.exists() => config_path_not_found(path.to_str().unwrap()),
224 Some(path) if path.is_dir() => {
225 let config_file_path = get_toml_path(path)?;
226 if config_file_path.is_some() {
229 config_path_not_found(path.to_str().unwrap())
232 path => Ok(path.map(|p| p.to_owned())),
246 // Options that are used by the generated functions
247 max_width: usize, 100, true, "Maximum width of each line";
248 use_small_heuristics: Heuristics, Heuristics::Default, true,
249 "Whether to use different formatting for items and \
250 expressions if they satisfy a heuristic notion of 'small'.";
251 license_template_path: String, String::default(), false,
252 "Beginning of file must match license template";
253 required_version: String, env!("CARGO_PKG_VERSION").to_owned(), false,
254 "Require a specific version of rustfmt.";
255 ignore: IgnoreList, IgnoreList::default(), false,
256 "Skip formatting the specified files and directories.";
257 verbose: Verbosity, Verbosity::Normal, false,
258 "How much to information to emit to the user";
259 file_lines: FileLines, FileLines::all(), false,
260 "Lines to format; this is not supported in rustfmt.toml, and can only be specified \
261 via the --file-lines option";
262 width_heuristics: WidthHeuristics, WidthHeuristics::scaled(100), false,
263 "'small' heuristic values";
265 // Options that are used by the tests
266 stable_option: bool, false, true, "A stable option";
267 unstable_option: bool, false, false, "An unstable option";
272 fn test_config_set() {
273 let mut config = Config::default();
274 config.set().verbose(Verbosity::Quiet);
275 assert_eq!(config.verbose(), Verbosity::Quiet);
276 config.set().verbose(Verbosity::Normal);
277 assert_eq!(config.verbose(), Verbosity::Normal);
281 fn test_config_used_to_toml() {
282 let config = Config::default();
284 let merge_derives = config.merge_derives();
285 let skip_children = config.skip_children();
287 let used_options = config.used_options();
288 let toml = used_options.to_toml().unwrap();
292 "merge_derives = {}\nskip_children = {}\n",
293 merge_derives, skip_children,
301 let config = Config::from_toml("hard_tabs = true", Path::new("")).unwrap();
303 assert_eq!(config.was_set().hard_tabs(), true);
304 assert_eq!(config.was_set().verbose(), false);
308 fn test_print_docs_exclude_unstable() {
309 use self::mock::Config;
311 let mut output = Vec::new();
312 Config::print_docs(&mut output, false);
314 let s = str::from_utf8(&output).unwrap();
316 assert_eq!(s.contains("stable_option"), true);
317 assert_eq!(s.contains("unstable_option"), false);
318 assert_eq!(s.contains("(unstable)"), false);
322 fn test_print_docs_include_unstable() {
323 use self::mock::Config;
325 let mut output = Vec::new();
326 Config::print_docs(&mut output, true);
328 let s = str::from_utf8(&output).unwrap();
329 assert_eq!(s.contains("stable_option"), true);
330 assert_eq!(s.contains("unstable_option"), true);
331 assert_eq!(s.contains("(unstable)"), true);
334 // FIXME(#2183) these tests cannot be run in parallel because they use env vars
336 // fn test_as_not_nightly_channel() {
337 // let mut config = Config::default();
338 // assert_eq!(config.was_set().unstable_features(), false);
339 // config.set().unstable_features(true);
340 // assert_eq!(config.was_set().unstable_features(), false);
344 // fn test_as_nightly_channel() {
345 // let v = ::std::env::var("CFG_RELEASE_CHANNEL").unwrap_or(String::from(""));
346 // ::std::env::set_var("CFG_RELEASE_CHANNEL", "nightly");
347 // let mut config = Config::default();
348 // config.set().unstable_features(true);
349 // assert_eq!(config.was_set().unstable_features(), false);
350 // config.set().unstable_features(true);
351 // assert_eq!(config.unstable_features(), true);
352 // ::std::env::set_var("CFG_RELEASE_CHANNEL", v);
356 // fn test_unstable_from_toml() {
357 // let mut config = Config::from_toml("unstable_features = true").unwrap();
358 // assert_eq!(config.was_set().unstable_features(), false);
359 // let v = ::std::env::var("CFG_RELEASE_CHANNEL").unwrap_or(String::from(""));
360 // ::std::env::set_var("CFG_RELEASE_CHANNEL", "nightly");
361 // config = Config::from_toml("unstable_features = true").unwrap();
362 // assert_eq!(config.was_set().unstable_features(), true);
363 // assert_eq!(config.unstable_features(), true);
364 // ::std::env::set_var("CFG_RELEASE_CHANNEL", v);