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 comment_width: usize, 80, false,
50 "Maximum length of comments. No effect unless wrap_comments = true";
51 normalize_comments: bool, false, false, "Convert /* */ comments to // comments where possible";
52 normalize_doc_attributes: bool, false, false, "Normalize doc attributes as doc comments";
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";
56 format_macro_matchers: bool, false, false,
57 "Format the metavariable matching patterns in macros";
58 format_macro_bodies: bool, true, false, "Format the bodies of macros";
60 // Single line expressions and items
61 empty_item_single_line: bool, true, false,
62 "Put empty-body functions and impls on a single line";
63 struct_lit_single_line: bool, true, false,
64 "Put small struct literals on a single line";
65 fn_single_line: bool, false, false, "Put single-expression functions on a single line";
66 where_single_line: bool, false, false, "Force where clauses to be on a single line";
69 imports_indent: IndentStyle, IndentStyle::Block, false, "Indent of imports";
70 imports_layout: ListTactic, ListTactic::Mixed, false, "Item layout inside a import block";
71 merge_imports: bool, false, false, "Merge imports";
74 reorder_imports: bool, true, true, "Reorder import and extern crate statements alphabetically";
75 reorder_modules: bool, true, true, "Reorder module statements alphabetically in group";
76 reorder_impl_items: bool, false, false, "Reorder impl items";
78 // Spaces around punctuation
79 type_punctuation_density: TypeDensity, TypeDensity::Wide, false,
80 "Determines if '+' or '=' are wrapped in spaces in the punctuation of types";
81 space_before_colon: bool, false, false, "Leave a space before the colon";
82 space_after_colon: bool, true, false, "Leave a space after the colon";
83 spaces_around_ranges: bool, false, false, "Put spaces around the .. and ..= range operators";
84 binop_separator: SeparatorPlace, SeparatorPlace::Front, false,
85 "Where to put a binary operator when a binary expression goes multiline";
88 remove_nested_parens: bool, true, true, "Remove nested parens";
89 combine_control_expr: bool, true, false, "Combine control expressions with function calls";
90 struct_field_align_threshold: usize, 0, false, "Align struct fields if their diffs fits within \
92 enum_discrim_align_threshold: usize, 0, false,
93 "Align enum variants discrims, if their diffs fit within threshold";
94 match_arm_blocks: bool, true, false, "Wrap the body of arms in blocks when it does not fit on \
95 the same line with the pattern of arms";
96 force_multiline_blocks: bool, false, false,
97 "Force multiline closure bodies and match arms to be wrapped in a block";
98 fn_args_density: Density, Density::Tall, false, "Argument density in functions";
99 brace_style: BraceStyle, BraceStyle::SameLineWhere, false, "Brace style for items";
100 control_brace_style: ControlBraceStyle, ControlBraceStyle::AlwaysSameLine, false,
101 "Brace style for control flow constructs";
102 trailing_semicolon: bool, true, false,
103 "Add trailing semicolon after break, continue and return";
104 trailing_comma: SeparatorTactic, SeparatorTactic::Vertical, false,
105 "How to handle trailing commas for lists";
106 match_block_trailing_comma: bool, false, false,
107 "Put a trailing comma after a block based match arm (non-block arms are not affected)";
108 blank_lines_upper_bound: usize, 1, false,
109 "Maximum number of blank lines which can be put between items";
110 blank_lines_lower_bound: usize, 0, false,
111 "Minimum number of blank lines which must be put between items";
112 edition: Edition, Edition::Edition2015, false, "The edition of the parser (RFC 2052)";
114 // Options that can change the source code beyond whitespace/blocks (somewhat linty things)
115 merge_derives: bool, true, true, "Merge multiple `#[derive(...)]` into a single one";
116 use_try_shorthand: bool, false, true, "Replace uses of the try! macro by the ? shorthand";
117 use_field_init_shorthand: bool, false, true, "Use field initialization shorthand if possible";
118 force_explicit_abi: bool, true, true, "Always print the abi for extern items";
119 condense_wildcard_suffixes: bool, false, false, "Replace strings of _ wildcards by a single .. \
122 // Control options (changes the operation of rustfmt, rather than the formatting)
123 color: Color, Color::Auto, false,
124 "What Color option to use when none is supplied: Always, Never, Auto";
125 required_version: String, env!("CARGO_PKG_VERSION").to_owned(), false,
126 "Require a specific version of rustfmt";
127 unstable_features: bool, false, false,
128 "Enables unstable features. Only available on nightly channel";
129 disable_all_formatting: bool, false, false, "Don't reformat anything";
130 skip_children: bool, false, false, "Don't reformat out of line modules";
131 hide_parse_errors: bool, false, false, "Hide errors from the parser";
132 error_on_line_overflow: bool, false, false, "Error if unable to get all lines within max_width";
133 error_on_unformatted: bool, false, false,
134 "Error if unable to get comments or string literals within max_width, \
135 or they are left with trailing whitespaces";
136 report_todo: ReportTactic, ReportTactic::Never, false,
137 "Report all, none or unnumbered occurrences of TODO in source file comments";
138 report_fixme: ReportTactic, ReportTactic::Never, false,
139 "Report all, none or unnumbered occurrences of FIXME in source file comments";
140 ignore: IgnoreList, IgnoreList::default(), false,
141 "Skip formatting the specified files and directories";
144 verbose: Verbosity, Verbosity::Normal, false, "How much to information to emit to the user";
145 file_lines: FileLines, FileLines::all(), false,
146 "Lines to format; this is not supported in rustfmt.toml, and can only be specified \
147 via the --file-lines option";
148 width_heuristics: WidthHeuristics, WidthHeuristics::scaled(100), false,
149 "'small' heuristic values";
150 emit_mode: EmitMode, EmitMode::Files, false,
151 "What emit Mode to use when none is supplied";
152 make_backup: bool, false, false, "Backup changed files";
155 /// Load a config by checking the client-supplied options and if appropriate, the
156 /// file system (including searching the file system for overrides).
157 pub fn load_config<O: CliOptions>(
158 file_path: Option<&Path>,
160 ) -> Result<(Config, Option<PathBuf>), Error> {
161 let over_ride = match options {
162 Some(ref opts) => config_path(opts)?,
166 let result = if let Some(over_ride) = over_ride {
167 Config::from_toml_path(over_ride.as_ref()).map(|p| (p, Some(over_ride.to_owned())))
168 } else if let Some(file_path) = file_path {
169 Config::from_resolved_toml_path(file_path)
171 Ok((Config::default(), None))
174 result.map(|(mut c, p)| {
175 if let Some(options) = options {
176 options.apply_to(&mut c);
182 // Check for the presence of known config file names (`rustfmt.toml, `.rustfmt.toml`) in `dir`
184 // Return the path if a config file exists, empty if no file exists, and Error for IO errors
185 fn get_toml_path(dir: &Path) -> Result<Option<PathBuf>, Error> {
186 const CONFIG_FILE_NAMES: [&str; 2] = [".rustfmt.toml", "rustfmt.toml"];
187 for config_file_name in &CONFIG_FILE_NAMES {
188 let config_file = dir.join(config_file_name);
189 match fs::metadata(&config_file) {
190 // Only return if it's a file to handle the unlikely situation of a directory named
192 Ok(ref md) if md.is_file() => return Ok(Some(config_file)),
193 // Return the error if it's something other than `NotFound`; otherwise we didn't
194 // find the project file yet, and continue searching.
196 if e.kind() != ErrorKind::NotFound {
206 fn config_path(options: &CliOptions) -> Result<Option<PathBuf>, Error> {
207 let config_path_not_found = |path: &str| -> Result<Option<PathBuf>, Error> {
211 "Error: unable to find a config file for the given path: `{}`",
217 // Read the config_path and convert to parent dir if a file is provided.
218 // If a config file cannot be found from the given path, return error.
219 match options.config_path() {
220 Some(path) if !path.exists() => config_path_not_found(path.to_str().unwrap()),
221 Some(path) if path.is_dir() => {
222 let config_file_path = get_toml_path(path)?;
223 if config_file_path.is_some() {
226 config_path_not_found(path.to_str().unwrap())
229 path => Ok(path.map(|p| p.to_owned())),
243 // Options that are used by the generated functions
244 max_width: usize, 100, true, "Maximum width of each line";
245 use_small_heuristics: Heuristics, Heuristics::Default, true,
246 "Whether to use different formatting for items and \
247 expressions if they satisfy a heuristic notion of 'small'.";
248 license_template_path: String, String::default(), false,
249 "Beginning of file must match license template";
250 required_version: String, env!("CARGO_PKG_VERSION").to_owned(), false,
251 "Require a specific version of rustfmt.";
252 ignore: IgnoreList, IgnoreList::default(), false,
253 "Skip formatting the specified files and directories.";
254 verbose: Verbosity, Verbosity::Normal, false,
255 "How much to information to emit to the user";
256 file_lines: FileLines, FileLines::all(), false,
257 "Lines to format; this is not supported in rustfmt.toml, and can only be specified \
258 via the --file-lines option";
259 width_heuristics: WidthHeuristics, WidthHeuristics::scaled(100), false,
260 "'small' heuristic values";
262 // Options that are used by the tests
263 stable_option: bool, false, true, "A stable option";
264 unstable_option: bool, false, false, "An unstable option";
269 fn test_config_set() {
270 let mut config = Config::default();
271 config.set().verbose(Verbosity::Quiet);
272 assert_eq!(config.verbose(), Verbosity::Quiet);
273 config.set().verbose(Verbosity::Normal);
274 assert_eq!(config.verbose(), Verbosity::Normal);
278 fn test_config_used_to_toml() {
279 let config = Config::default();
281 let merge_derives = config.merge_derives();
282 let skip_children = config.skip_children();
284 let used_options = config.used_options();
285 let toml = used_options.to_toml().unwrap();
289 "merge_derives = {}\nskip_children = {}\n",
290 merge_derives, skip_children,
298 let config = Config::from_toml("hard_tabs = true", Path::new("")).unwrap();
300 assert_eq!(config.was_set().hard_tabs(), true);
301 assert_eq!(config.was_set().verbose(), false);
305 fn test_print_docs_exclude_unstable() {
306 use self::mock::Config;
308 let mut output = Vec::new();
309 Config::print_docs(&mut output, false);
311 let s = str::from_utf8(&output).unwrap();
313 assert_eq!(s.contains("stable_option"), true);
314 assert_eq!(s.contains("unstable_option"), false);
315 assert_eq!(s.contains("(unstable)"), false);
319 fn test_print_docs_include_unstable() {
320 use self::mock::Config;
322 let mut output = Vec::new();
323 Config::print_docs(&mut output, true);
325 let s = str::from_utf8(&output).unwrap();
326 assert_eq!(s.contains("stable_option"), true);
327 assert_eq!(s.contains("unstable_option"), true);
328 assert_eq!(s.contains("(unstable)"), true);
331 // FIXME(#2183) these tests cannot be run in parallel because they use env vars
333 // fn test_as_not_nightly_channel() {
334 // let mut config = Config::default();
335 // assert_eq!(config.was_set().unstable_features(), false);
336 // config.set().unstable_features(true);
337 // assert_eq!(config.was_set().unstable_features(), false);
341 // fn test_as_nightly_channel() {
342 // let v = ::std::env::var("CFG_RELEASE_CHANNEL").unwrap_or(String::from(""));
343 // ::std::env::set_var("CFG_RELEASE_CHANNEL", "nightly");
344 // let mut config = Config::default();
345 // config.set().unstable_features(true);
346 // assert_eq!(config.was_set().unstable_features(), false);
347 // config.set().unstable_features(true);
348 // assert_eq!(config.unstable_features(), true);
349 // ::std::env::set_var("CFG_RELEASE_CHANNEL", v);
353 // fn test_unstable_from_toml() {
354 // let mut config = Config::from_toml("unstable_features = true").unwrap();
355 // assert_eq!(config.was_set().unstable_features(), false);
356 // let v = ::std::env::var("CFG_RELEASE_CHANNEL").unwrap_or(String::from(""));
357 // ::std::env::set_var("CFG_RELEASE_CHANNEL", "nightly");
358 // config = Config::from_toml("unstable_features = true").unwrap();
359 // assert_eq!(config.was_set().unstable_features(), true);
360 // assert_eq!(config.unstable_features(), true);
361 // ::std::env::set_var("CFG_RELEASE_CHANNEL", v);