src/config/mod.rs

   1 use std::cell::Cell;
   2 use std::default::Default;
   3 use std::fs::File;
   4 use std::io::{Error, ErrorKind, Read};
   5 use std::path::{Path, PathBuf};
   6 use std::{env, fs};
   7
   8 use regex::Regex;
   9 use thiserror::Error;
  10
  11 use crate::config::config_type::ConfigType;
  12 #[allow(unreachable_pub)]
  13 pub use crate::config::file_lines::{FileLines, FileName, Range};
  14 #[allow(unreachable_pub)]
  15 pub use crate::config::lists::*;
  16 #[allow(unreachable_pub)]
  17 pub use crate::config::options::*;
  18
  19 #[macro_use]
  20 pub(crate) mod config_type;
  21 #[macro_use]
  22 pub(crate) mod options;
  23
  24 pub(crate) mod file_lines;
  25 pub(crate) mod license;
  26 pub(crate) mod lists;
  27
  28 // This macro defines configuration options used in rustfmt. Each option
  29 // is defined as follows:
  30 //
  31 // `name: value type, default value, is stable, description;`
  32 create_config! {
  33     // Fundamental stuff
  34     max_width: usize, 100, true, "Maximum width of each line";
  35     hard_tabs: bool, false, true, "Use tab characters for indentation, spaces for alignment";
  36     tab_spaces: usize, 4, true, "Number of spaces per tab";
  37     newline_style: NewlineStyle, NewlineStyle::Auto, true, "Unix or Windows line endings";
  38     indent_style: IndentStyle, IndentStyle::Block, false, "How do we indent expressions or items";
  39
  40     // Width Heuristics
  41     use_small_heuristics: Heuristics, Heuristics::Default, true, "Whether to use different \
  42         formatting for items and expressions if they satisfy a heuristic notion of 'small'";
  43     width_heuristics: WidthHeuristics, WidthHeuristics::scaled(100), false,
  44         "'small' heuristic values";
  45     fn_call_width: usize, 60, true, "Maximum width of the args of a function call before \
  46         falling back to vertical formatting.";
  47     attr_fn_like_width: usize, 70, true, "Maximum width of the args of a function-like \
  48         attributes before falling back to vertical formatting.";
  49     struct_lit_width: usize, 18, true, "Maximum width in the body of a struct lit before \
  50         falling back to vertical formatting.";
  51     struct_variant_width: usize, 35, true, "Maximum width in the body of a struct variant before \
  52         falling back to vertical formatting.";
  53     array_width: usize, 60, true,  "Maximum width of an array literal before falling \
  54         back to vertical formatting.";
  55     chain_width: usize, 60, true, "Maximum length of a chain to fit on a single line.";
  56     single_line_if_else_max_width: usize, 50, true, "Maximum line length for single line if-else \
  57         expressions. A value of zero means always break if-else expressions.";
  58
  59     // Comments. macros, and strings
  60     wrap_comments: bool, false, false, "Break comments to fit on the line";
  61     format_code_in_doc_comments: bool, false, false, "Format the code snippet in doc comments.";
  62     comment_width: usize, 80, false,
  63         "Maximum length of comments. No effect unless wrap_comments = true";
  64     normalize_comments: bool, false, false, "Convert /* */ comments to // comments where possible";
  65     normalize_doc_attributes: bool, false, false, "Normalize doc attributes as doc comments";
  66     license_template_path: String, String::default(), false,
  67         "Beginning of file must match license template";
  68     format_strings: bool, false, false, "Format string literals where necessary";
  69     format_macro_matchers: bool, false, false,
  70         "Format the metavariable matching patterns in macros";
  71     format_macro_bodies: bool, true, false, "Format the bodies of macros";
  72     hex_literal_case: HexLiteralCase, HexLiteralCase::Preserve, false,
  73         "Format hexadecimal integer literals";
  74
  75     // Single line expressions and items
  76     empty_item_single_line: bool, true, false,
  77         "Put empty-body functions and impls on a single line";
  78     struct_lit_single_line: bool, true, false,
  79         "Put small struct literals on a single line";
  80     fn_single_line: bool, false, false, "Put single-expression functions on a single line";
  81     where_single_line: bool, false, false, "Force where-clauses to be on a single line";
  82
  83     // Imports
  84     imports_indent: IndentStyle, IndentStyle::Block, false, "Indent of imports";
  85     imports_layout: ListTactic, ListTactic::Mixed, false, "Item layout inside a import block";
  86     imports_granularity: ImportGranularity, ImportGranularity::Preserve, false,
  87         "Merge or split imports to the provided granularity";
  88     group_imports: GroupImportsTactic, GroupImportsTactic::Preserve, false,
  89         "Controls the strategy for how imports are grouped together";
  90     merge_imports: bool, false, false, "(deprecated: use imports_granularity instead)";
  91
  92     // Ordering
  93     reorder_imports: bool, true, true, "Reorder import and extern crate statements alphabetically";
  94     reorder_modules: bool, true, true, "Reorder module statements alphabetically in group";
  95     reorder_impl_items: bool, false, false, "Reorder impl items";
  96
  97     // Spaces around punctuation
  98     type_punctuation_density: TypeDensity, TypeDensity::Wide, false,
  99         "Determines if '+' or '=' are wrapped in spaces in the punctuation of types";
 100     space_before_colon: bool, false, false, "Leave a space before the colon";
 101     space_after_colon: bool, true, false, "Leave a space after the colon";
 102     spaces_around_ranges: bool, false, false, "Put spaces around the  .. and ..= range operators";
 103     binop_separator: SeparatorPlace, SeparatorPlace::Front, false,
 104         "Where to put a binary operator when a binary expression goes multiline";
 105
 106     // Misc.
 107     remove_nested_parens: bool, true, true, "Remove nested parens";
 108     combine_control_expr: bool, true, false, "Combine control expressions with function calls";
 109     overflow_delimited_expr: bool, false, false,
 110         "Allow trailing bracket/brace delimited expressions to overflow";
 111     struct_field_align_threshold: usize, 0, false,
 112         "Align struct fields if their diffs fits within threshold";
 113     enum_discrim_align_threshold: usize, 0, false,
 114         "Align enum variants discrims, if their diffs fit within threshold";
 115     match_arm_blocks: bool, true, false, "Wrap the body of arms in blocks when it does not fit on \
 116         the same line with the pattern of arms";
 117     match_arm_leading_pipes: MatchArmLeadingPipe, MatchArmLeadingPipe::Never, true,
 118         "Determines whether leading pipes are emitted on match arms";
 119     force_multiline_blocks: bool, false, false,
 120         "Force multiline closure bodies and match arms to be wrapped in a block";
 121     fn_args_layout: Density, Density::Tall, true,
 122         "Control the layout of arguments in a function";
 123     brace_style: BraceStyle, BraceStyle::SameLineWhere, false, "Brace style for items";
 124     control_brace_style: ControlBraceStyle, ControlBraceStyle::AlwaysSameLine, false,
 125         "Brace style for control flow constructs";
 126     trailing_semicolon: bool, true, false,
 127         "Add trailing semicolon after break, continue and return";
 128     trailing_comma: SeparatorTactic, SeparatorTactic::Vertical, false,
 129         "How to handle trailing commas for lists";
 130     match_block_trailing_comma: bool, false, false,
 131         "Put a trailing comma after a block based match arm (non-block arms are not affected)";
 132     blank_lines_upper_bound: usize, 1, false,
 133         "Maximum number of blank lines which can be put between items";
 134     blank_lines_lower_bound: usize, 0, false,
 135         "Minimum number of blank lines which must be put between items";
 136     edition: Edition, Edition::Edition2015, true, "The edition of the parser (RFC 2052)";
 137     version: Version, Version::One, false, "Version of formatting rules";
 138     inline_attribute_width: usize, 0, false,
 139         "Write an item and its attribute on the same line \
 140         if their combined width is below a threshold";
 141     format_generated_files: bool, false, false, "Format generated files";
 142
 143     // Options that can change the source code beyond whitespace/blocks (somewhat linty things)
 144     merge_derives: bool, true, true, "Merge multiple `#[derive(...)]` into a single one";
 145     use_try_shorthand: bool, false, true, "Replace uses of the try! macro by the ? shorthand";
 146     use_field_init_shorthand: bool, false, true, "Use field initialization shorthand if possible";
 147     force_explicit_abi: bool, true, true, "Always print the abi for extern items";
 148     condense_wildcard_suffixes: bool, false, false, "Replace strings of _ wildcards by a single .. \
 149                                                      in tuple patterns";
 150
 151     // Control options (changes the operation of rustfmt, rather than the formatting)
 152     color: Color, Color::Auto, false,
 153         "What Color option to use when none is supplied: Always, Never, Auto";
 154     required_version: String, env!("CARGO_PKG_VERSION").to_owned(), false,
 155         "Require a specific version of rustfmt";
 156     unstable_features: bool, false, false,
 157             "Enables unstable features. Only available on nightly channel";
 158     disable_all_formatting: bool, false, false, "Don't reformat anything";
 159     skip_children: bool, false, false, "Don't reformat out of line modules";
 160     hide_parse_errors: bool, false, false, "Hide errors from the parser";
 161     error_on_line_overflow: bool, false, false, "Error if unable to get all lines within max_width";
 162     error_on_unformatted: bool, false, false,
 163         "Error if unable to get comments or string literals within max_width, \
 164          or they are left with trailing whitespaces";
 165     report_todo: ReportTactic, ReportTactic::Never, false,
 166         "Report all, none or unnumbered occurrences of TODO in source file comments";
 167     report_fixme: ReportTactic, ReportTactic::Never, false,
 168         "Report all, none or unnumbered occurrences of FIXME in source file comments";
 169     ignore: IgnoreList, IgnoreList::default(), false,
 170         "Skip formatting the specified files and directories";
 171
 172     // Not user-facing
 173     verbose: Verbosity, Verbosity::Normal, false, "How much to information to emit to the user";
 174     file_lines: FileLines, FileLines::all(), false,
 175         "Lines to format; this is not supported in rustfmt.toml, and can only be specified \
 176          via the --file-lines option";
 177     emit_mode: EmitMode, EmitMode::Files, false,
 178         "What emit Mode to use when none is supplied";
 179     make_backup: bool, false, false, "Backup changed files";
 180     print_misformatted_file_names: bool, false, true,
 181         "Prints the names of mismatched files that were formatted. Prints the names of \
 182          files that would be formated when used with `--check` mode. ";
 183 }
 184
 185 #[derive(Error, Debug)]
 186 #[error("Could not output config: {0}")]
 187 pub struct ToTomlError(toml::ser::Error);
 188
 189 impl PartialConfig {
 190     pub fn to_toml(&self) -> Result<String, ToTomlError> {
 191         // Non-user-facing options can't be specified in TOML
 192         let mut cloned = self.clone();
 193         cloned.file_lines = None;
 194         cloned.verbose = None;
 195         cloned.width_heuristics = None;
 196         cloned.print_misformatted_file_names = None;
 197         cloned.merge_imports = None;
 198
 199         ::toml::to_string(&cloned).map_err(ToTomlError)
 200     }
 201 }
 202
 203 impl Config {
 204     pub(crate) fn version_meets_requirement(&self) -> bool {
 205         if self.was_set().required_version() {
 206             let version = env!("CARGO_PKG_VERSION");
 207             let required_version = self.required_version();
 208             if version != required_version {
 209                 println!(
 210                     "Error: rustfmt version ({}) doesn't match the required version ({})",
 211                     version, required_version,
 212                 );
 213                 return false;
 214             }
 215         }
 216
 217         true
 218     }
 219
 220     /// Constructs a `Config` from the toml file specified at `file_path`.
 221     ///
 222     /// This method only looks at the provided path, for a method that
 223     /// searches parents for a `rustfmt.toml` see `from_resolved_toml_path`.
 224     ///
 225     /// Returns a `Config` if the config could be read and parsed from
 226     /// the file, otherwise errors.
 227     pub(super) fn from_toml_path(file_path: &Path) -> Result<Config, Error> {
 228         let mut file = File::open(&file_path)?;
 229         let mut toml = String::new();
 230         file.read_to_string(&mut toml)?;
 231         Config::from_toml(&toml, file_path.parent().unwrap())
 232             .map_err(|err| Error::new(ErrorKind::InvalidData, err))
 233     }
 234
 235     /// Resolves the config for input in `dir`.
 236     ///
 237     /// Searches for `rustfmt.toml` beginning with `dir`, and
 238     /// recursively checking parents of `dir` if no config file is found.
 239     /// If no config file exists in `dir` or in any parent, a
 240     /// default `Config` will be returned (and the returned path will be empty).
 241     ///
 242     /// Returns the `Config` to use, and the path of the project file if there was
 243     /// one.
 244     pub(super) fn from_resolved_toml_path(dir: &Path) -> Result<(Config, Option<PathBuf>), Error> {
 245         /// Try to find a project file in the given directory and its parents.
 246         /// Returns the path of a the nearest project file if one exists,
 247         /// or `None` if no project file was found.
 248         fn resolve_project_file(dir: &Path) -> Result<Option<PathBuf>, Error> {
 249             let mut current = if dir.is_relative() {
 250                 env::current_dir()?.join(dir)
 251             } else {
 252                 dir.to_path_buf()
 253             };
 254
 255             current = fs::canonicalize(current)?;
 256
 257             loop {
 258                 match get_toml_path(&current) {
 259                     Ok(Some(path)) => return Ok(Some(path)),
 260                     Err(e) => return Err(e),
 261                     _ => (),
 262                 }
 263
 264                 // If the current directory has no parent, we're done searching.
 265                 if !current.pop() {
 266                     break;
 267                 }
 268             }
 269
 270             // If nothing was found, check in the home directory.
 271             if let Some(home_dir) = dirs::home_dir() {
 272                 if let Some(path) = get_toml_path(&home_dir)? {
 273                     return Ok(Some(path));
 274                 }
 275             }
 276
 277             // If none was found ther either, check in the user's configuration directory.
 278             if let Some(mut config_dir) = dirs::config_dir() {
 279                 config_dir.push("rustfmt");
 280                 if let Some(path) = get_toml_path(&config_dir)? {
 281                     return Ok(Some(path));
 282                 }
 283             }
 284
 285             Ok(None)
 286         }
 287
 288         match resolve_project_file(dir)? {
 289             None => Ok((Config::default(), None)),
 290             Some(path) => Config::from_toml_path(&path).map(|config| (config, Some(path))),
 291         }
 292     }
 293
 294     pub(crate) fn from_toml(toml: &str, dir: &Path) -> Result<Config, String> {
 295         let parsed: ::toml::Value = toml
 296             .parse()
 297             .map_err(|e| format!("Could not parse TOML: {}", e))?;
 298         let mut err = String::new();
 299         let table = parsed
 300             .as_table()
 301             .ok_or_else(|| String::from("Parsed config was not table"))?;
 302         for key in table.keys() {
 303             if !Config::is_valid_name(key) {
 304                 let msg = &format!("Warning: Unknown configuration option `{}`\n", key);
 305                 err.push_str(msg)
 306             }
 307         }
 308         match parsed.try_into() {
 309             Ok(parsed_config) => {
 310                 if !err.is_empty() {
 311                     eprint!("{}", err);
 312                 }
 313                 Ok(Config::default().fill_from_parsed_config(parsed_config, dir))
 314             }
 315             Err(e) => {
 316                 err.push_str("Error: Decoding config file failed:\n");
 317                 err.push_str(format!("{}\n", e).as_str());
 318                 err.push_str("Please check your config file.");
 319                 Err(err)
 320             }
 321         }
 322     }
 323 }
 324
 325 /// Loads a config by checking the client-supplied options and if appropriate, the
 326 /// file system (including searching the file system for overrides).
 327 pub fn load_config<O: CliOptions>(
 328     file_path: Option<&Path>,
 329     options: Option<O>,
 330 ) -> Result<(Config, Option<PathBuf>), Error> {
 331     let over_ride = match options {
 332         Some(ref opts) => config_path(opts)?,
 333         None => None,
 334     };
 335
 336     let result = if let Some(over_ride) = over_ride {
 337         Config::from_toml_path(over_ride.as_ref()).map(|p| (p, Some(over_ride.to_owned())))
 338     } else if let Some(file_path) = file_path {
 339         Config::from_resolved_toml_path(file_path)
 340     } else {
 341         Ok((Config::default(), None))
 342     };
 343
 344     result.map(|(mut c, p)| {
 345         if let Some(options) = options {
 346             options.apply_to(&mut c);
 347         }
 348         (c, p)
 349     })
 350 }
 351
 352 // Check for the presence of known config file names (`rustfmt.toml, `.rustfmt.toml`) in `dir`
 353 //
 354 // Return the path if a config file exists, empty if no file exists, and Error for IO errors
 355 fn get_toml_path(dir: &Path) -> Result<Option<PathBuf>, Error> {
 356     const CONFIG_FILE_NAMES: [&str; 2] = [".rustfmt.toml", "rustfmt.toml"];
 357     for config_file_name in &CONFIG_FILE_NAMES {
 358         let config_file = dir.join(config_file_name);
 359         match fs::metadata(&config_file) {
 360             // Only return if it's a file to handle the unlikely situation of a directory named
 361             // `rustfmt.toml`.
 362             Ok(ref md) if md.is_file() => return Ok(Some(config_file)),
 363             // Return the error if it's something other than `NotFound`; otherwise we didn't
 364             // find the project file yet, and continue searching.
 365             Err(e) => {
 366                 if e.kind() != ErrorKind::NotFound {
 367                     return Err(e);
 368                 }
 369             }
 370             _ => {}
 371         }
 372     }
 373     Ok(None)
 374 }
 375
 376 fn config_path(options: &dyn CliOptions) -> Result<Option<PathBuf>, Error> {
 377     let config_path_not_found = |path: &str| -> Result<Option<PathBuf>, Error> {
 378         Err(Error::new(
 379             ErrorKind::NotFound,
 380             format!(
 381                 "Error: unable to find a config file for the given path: `{}`",
 382                 path
 383             ),
 384         ))
 385     };
 386
 387     // Read the config_path and convert to parent dir if a file is provided.
 388     // If a config file cannot be found from the given path, return error.
 389     match options.config_path() {
 390         Some(path) if !path.exists() => config_path_not_found(path.to_str().unwrap()),
 391         Some(path) if path.is_dir() => {
 392             let config_file_path = get_toml_path(path)?;
 393             if config_file_path.is_some() {
 394                 Ok(config_file_path)
 395             } else {
 396                 config_path_not_found(path.to_str().unwrap())
 397             }
 398         }
 399         path => Ok(path.map(ToOwned::to_owned)),
 400     }
 401 }
 402
 403 #[cfg(test)]
 404 mod test {
 405     use super::*;
 406     use std::str;
 407
 408     #[allow(dead_code)]
 409     mod mock {
 410         use super::super::*;
 411
 412         create_config! {
 413             // Options that are used by the generated functions
 414             max_width: usize, 100, true, "Maximum width of each line";
 415             license_template_path: String, String::default(), false,
 416                 "Beginning of file must match license template";
 417             required_version: String, env!("CARGO_PKG_VERSION").to_owned(), false,
 418                 "Require a specific version of rustfmt.";
 419             ignore: IgnoreList, IgnoreList::default(), false,
 420                 "Skip formatting the specified files and directories.";
 421             verbose: Verbosity, Verbosity::Normal, false,
 422                 "How much to information to emit to the user";
 423             file_lines: FileLines, FileLines::all(), false,
 424                 "Lines to format; this is not supported in rustfmt.toml, and can only be specified \
 425                     via the --file-lines option";
 426
 427             // merge_imports deprecation
 428             imports_granularity: ImportGranularity, ImportGranularity::Preserve, false,
 429                 "Merge imports";
 430             merge_imports: bool, false, false, "(deprecated: use imports_granularity instead)";
 431
 432             // Width Heuristics
 433             use_small_heuristics: Heuristics, Heuristics::Default, true,
 434                 "Whether to use different formatting for items and \
 435                  expressions if they satisfy a heuristic notion of 'small'.";
 436             width_heuristics: WidthHeuristics, WidthHeuristics::scaled(100), false,
 437                 "'small' heuristic values";
 438
 439             fn_call_width: usize, 60, true, "Maximum width of the args of a function call before \
 440                 falling back to vertical formatting.";
 441             attr_fn_like_width: usize, 70, true, "Maximum width of the args of a function-like \
 442                 attributes before falling back to vertical formatting.";
 443             struct_lit_width: usize, 18, true, "Maximum width in the body of a struct lit before \
 444                 falling back to vertical formatting.";
 445             struct_variant_width: usize, 35, true, "Maximum width in the body of a struct \
 446                 variant before falling back to vertical formatting.";
 447             array_width: usize, 60, true,  "Maximum width of an array literal before falling \
 448                 back to vertical formatting.";
 449             chain_width: usize, 60, true, "Maximum length of a chain to fit on a single line.";
 450             single_line_if_else_max_width: usize, 50, true, "Maximum line length for single \
 451                 line if-else expressions. A value of zero means always break if-else expressions.";
 452
 453             // Options that are used by the tests
 454             stable_option: bool, false, true, "A stable option";
 455             unstable_option: bool, false, false, "An unstable option";
 456         }
 457     }
 458
 459     #[test]
 460     fn test_config_set() {
 461         let mut config = Config::default();
 462         config.set().verbose(Verbosity::Quiet);
 463         assert_eq!(config.verbose(), Verbosity::Quiet);
 464         config.set().verbose(Verbosity::Normal);
 465         assert_eq!(config.verbose(), Verbosity::Normal);
 466     }
 467
 468     #[test]
 469     fn test_config_used_to_toml() {
 470         let config = Config::default();
 471
 472         let merge_derives = config.merge_derives();
 473         let skip_children = config.skip_children();
 474
 475         let used_options = config.used_options();
 476         let toml = used_options.to_toml().unwrap();
 477         assert_eq!(
 478             toml,
 479             format!(
 480                 "merge_derives = {}\nskip_children = {}\n",
 481                 merge_derives, skip_children,
 482             )
 483         );
 484     }
 485
 486     #[test]
 487     fn test_was_set() {
 488         let config = Config::from_toml("hard_tabs = true", Path::new("")).unwrap();
 489
 490         assert_eq!(config.was_set().hard_tabs(), true);
 491         assert_eq!(config.was_set().verbose(), false);
 492     }
 493
 494     #[test]
 495     fn test_print_docs_exclude_unstable() {
 496         use self::mock::Config;
 497
 498         let mut output = Vec::new();
 499         Config::print_docs(&mut output, false);
 500
 501         let s = str::from_utf8(&output).unwrap();
 502
 503         assert_eq!(s.contains("stable_option"), true);
 504         assert_eq!(s.contains("unstable_option"), false);
 505         assert_eq!(s.contains("(unstable)"), false);
 506     }
 507
 508     #[test]
 509     fn test_print_docs_include_unstable() {
 510         use self::mock::Config;
 511
 512         let mut output = Vec::new();
 513         Config::print_docs(&mut output, true);
 514
 515         let s = str::from_utf8(&output).unwrap();
 516         assert_eq!(s.contains("stable_option"), true);
 517         assert_eq!(s.contains("unstable_option"), true);
 518         assert_eq!(s.contains("(unstable)"), true);
 519     }
 520
 521     #[test]
 522     fn test_empty_string_license_template_path() {
 523         let toml = r#"license_template_path = """#;
 524         let config = Config::from_toml(toml, Path::new("")).unwrap();
 525         assert!(config.license_template.is_none());
 526     }
 527
 528     #[test]
 529     fn test_valid_license_template_path() {
 530         if !crate::is_nightly_channel!() {
 531             return;
 532         }
 533         let toml = r#"license_template_path = "tests/license-template/lt.txt""#;
 534         let config = Config::from_toml(toml, Path::new("")).unwrap();
 535         assert!(config.license_template.is_some());
 536     }
 537
 538     #[test]
 539     fn test_override_existing_license_with_no_license() {
 540         if !crate::is_nightly_channel!() {
 541             return;
 542         }
 543         let toml = r#"license_template_path = "tests/license-template/lt.txt""#;
 544         let mut config = Config::from_toml(toml, Path::new("")).unwrap();
 545         assert!(config.license_template.is_some());
 546         config.override_value("license_template_path", "");
 547         assert!(config.license_template.is_none());
 548     }
 549
 550     #[test]
 551     fn test_dump_default_config() {
 552         let default_config = format!(
 553             r#"max_width = 100
 554 hard_tabs = false
 555 tab_spaces = 4
 556 newline_style = "Auto"
 557 indent_style = "Block"
 558 use_small_heuristics = "Default"
 559 fn_call_width = 60
 560 attr_fn_like_width = 70
 561 struct_lit_width = 18
 562 struct_variant_width = 35
 563 array_width = 60
 564 chain_width = 60
 565 single_line_if_else_max_width = 50
 566 wrap_comments = false
 567 format_code_in_doc_comments = false
 568 comment_width = 80
 569 normalize_comments = false
 570 normalize_doc_attributes = false
 571 license_template_path = ""
 572 format_strings = false
 573 format_macro_matchers = false
 574 format_macro_bodies = true
 575 hex_literal_case = "Preserve"
 576 empty_item_single_line = true
 577 struct_lit_single_line = true
 578 fn_single_line = false
 579 where_single_line = false
 580 imports_indent = "Block"
 581 imports_layout = "Mixed"
 582 imports_granularity = "Preserve"
 583 group_imports = "Preserve"
 584 reorder_imports = true
 585 reorder_modules = true
 586 reorder_impl_items = false
 587 type_punctuation_density = "Wide"
 588 space_before_colon = false
 589 space_after_colon = true
 590 spaces_around_ranges = false
 591 binop_separator = "Front"
 592 remove_nested_parens = true
 593 combine_control_expr = true
 594 overflow_delimited_expr = false
 595 struct_field_align_threshold = 0
 596 enum_discrim_align_threshold = 0
 597 match_arm_blocks = true
 598 match_arm_leading_pipes = "Never"
 599 force_multiline_blocks = false
 600 fn_args_layout = "Tall"
 601 brace_style = "SameLineWhere"
 602 control_brace_style = "AlwaysSameLine"
 603 trailing_semicolon = true
 604 trailing_comma = "Vertical"
 605 match_block_trailing_comma = false
 606 blank_lines_upper_bound = 1
 607 blank_lines_lower_bound = 0
 608 edition = "2015"
 609 version = "One"
 610 inline_attribute_width = 0
 611 format_generated_files = false
 612 merge_derives = true
 613 use_try_shorthand = false
 614 use_field_init_shorthand = false
 615 force_explicit_abi = true
 616 condense_wildcard_suffixes = false
 617 color = "Auto"
 618 required_version = "{}"
 619 unstable_features = false
 620 disable_all_formatting = false
 621 skip_children = false
 622 hide_parse_errors = false
 623 error_on_line_overflow = false
 624 error_on_unformatted = false
 625 report_todo = "Never"
 626 report_fixme = "Never"
 627 ignore = []
 628 emit_mode = "Files"
 629 make_backup = false
 630 "#,
 631             env!("CARGO_PKG_VERSION")
 632         );
 633         let toml = Config::default().all_options().to_toml().unwrap();
 634         assert_eq!(&toml, &default_config);
 635     }
 636
 637     // FIXME(#2183): these tests cannot be run in parallel because they use env vars.
 638     // #[test]
 639     // fn test_as_not_nightly_channel() {
 640     //     let mut config = Config::default();
 641     //     assert_eq!(config.was_set().unstable_features(), false);
 642     //     config.set().unstable_features(true);
 643     //     assert_eq!(config.was_set().unstable_features(), false);
 644     // }
 645
 646     // #[test]
 647     // fn test_as_nightly_channel() {
 648     //     let v = ::std::env::var("CFG_RELEASE_CHANNEL").unwrap_or(String::from(""));
 649     //     ::std::env::set_var("CFG_RELEASE_CHANNEL", "nightly");
 650     //     let mut config = Config::default();
 651     //     config.set().unstable_features(true);
 652     //     assert_eq!(config.was_set().unstable_features(), false);
 653     //     config.set().unstable_features(true);
 654     //     assert_eq!(config.unstable_features(), true);
 655     //     ::std::env::set_var("CFG_RELEASE_CHANNEL", v);
 656     // }
 657
 658     // #[test]
 659     // fn test_unstable_from_toml() {
 660     //     let mut config = Config::from_toml("unstable_features = true").unwrap();
 661     //     assert_eq!(config.was_set().unstable_features(), false);
 662     //     let v = ::std::env::var("CFG_RELEASE_CHANNEL").unwrap_or(String::from(""));
 663     //     ::std::env::set_var("CFG_RELEASE_CHANNEL", "nightly");
 664     //     config = Config::from_toml("unstable_features = true").unwrap();
 665     //     assert_eq!(config.was_set().unstable_features(), true);
 666     //     assert_eq!(config.unstable_features(), true);
 667     //     ::std::env::set_var("CFG_RELEASE_CHANNEL", v);
 668     // }
 669
 670     #[cfg(test)]
 671     mod deprecated_option_merge_imports {
 672         use super::*;
 673
 674         #[test]
 675         fn test_old_option_set() {
 676             if !crate::is_nightly_channel!() {
 677                 return;
 678             }
 679             let toml = r#"
 680                 unstable_features = true
 681                 merge_imports = true
 682             "#;
 683             let config = Config::from_toml(toml, Path::new("")).unwrap();
 684             assert_eq!(config.imports_granularity(), ImportGranularity::Crate);
 685         }
 686
 687         #[test]
 688         fn test_both_set() {
 689             if !crate::is_nightly_channel!() {
 690                 return;
 691             }
 692             let toml = r#"
 693                 unstable_features = true
 694                 merge_imports = true
 695                 imports_granularity = "Preserve"
 696             "#;
 697             let config = Config::from_toml(toml, Path::new("")).unwrap();
 698             assert_eq!(config.imports_granularity(), ImportGranularity::Preserve);
 699         }
 700
 701         #[test]
 702         fn test_new_overridden() {
 703             if !crate::is_nightly_channel!() {
 704                 return;
 705             }
 706             let toml = r#"
 707                 unstable_features = true
 708                 merge_imports = true
 709             "#;
 710             let mut config = Config::from_toml(toml, Path::new("")).unwrap();
 711             config.override_value("imports_granularity", "Preserve");
 712             assert_eq!(config.imports_granularity(), ImportGranularity::Preserve);
 713         }
 714
 715         #[test]
 716         fn test_old_overridden() {
 717             if !crate::is_nightly_channel!() {
 718                 return;
 719             }
 720             let toml = r#"
 721                 unstable_features = true
 722                 imports_granularity = "Module"
 723             "#;
 724             let mut config = Config::from_toml(toml, Path::new("")).unwrap();
 725             config.override_value("merge_imports", "true");
 726             // no effect: the new option always takes precedence
 727             assert_eq!(config.imports_granularity(), ImportGranularity::Module);
 728         }
 729     }
 730
 731     #[cfg(test)]
 732     mod use_small_heuristics {
 733         use super::*;
 734
 735         #[test]
 736         fn test_default_sets_correct_widths() {
 737             let toml = r#"
 738                 use_small_heuristics = "Default"
 739                 max_width = 200
 740             "#;
 741             let config = Config::from_toml(toml, Path::new("")).unwrap();
 742             assert_eq!(config.array_width(), 120);
 743             assert_eq!(config.attr_fn_like_width(), 140);
 744             assert_eq!(config.chain_width(), 120);
 745             assert_eq!(config.fn_call_width(), 120);
 746             assert_eq!(config.single_line_if_else_max_width(), 100);
 747             assert_eq!(config.struct_lit_width(), 36);
 748             assert_eq!(config.struct_variant_width(), 70);
 749         }
 750
 751         #[test]
 752         fn test_max_sets_correct_widths() {
 753             let toml = r#"
 754                 use_small_heuristics = "Max"
 755                 max_width = 120
 756             "#;
 757             let config = Config::from_toml(toml, Path::new("")).unwrap();
 758             assert_eq!(config.array_width(), 120);
 759             assert_eq!(config.attr_fn_like_width(), 120);
 760             assert_eq!(config.chain_width(), 120);
 761             assert_eq!(config.fn_call_width(), 120);
 762             assert_eq!(config.single_line_if_else_max_width(), 120);
 763             assert_eq!(config.struct_lit_width(), 120);
 764             assert_eq!(config.struct_variant_width(), 120);
 765         }
 766
 767         #[test]
 768         fn test_off_sets_correct_widths() {
 769             let toml = r#"
 770                 use_small_heuristics = "Off"
 771                 max_width = 100
 772             "#;
 773             let config = Config::from_toml(toml, Path::new("")).unwrap();
 774             assert_eq!(config.array_width(), usize::max_value());
 775             assert_eq!(config.attr_fn_like_width(), usize::max_value());
 776             assert_eq!(config.chain_width(), usize::max_value());
 777             assert_eq!(config.fn_call_width(), usize::max_value());
 778             assert_eq!(config.single_line_if_else_max_width(), 0);
 779             assert_eq!(config.struct_lit_width(), 0);
 780             assert_eq!(config.struct_variant_width(), 0);
 781         }
 782
 783         #[test]
 784         fn test_override_works_with_default() {
 785             let toml = r#"
 786                 use_small_heuristics = "Default"
 787                 array_width = 20
 788                 attr_fn_like_width = 40
 789                 chain_width = 20
 790                 fn_call_width = 90
 791                 single_line_if_else_max_width = 40
 792                 struct_lit_width = 30
 793                 struct_variant_width = 34
 794             "#;
 795             let config = Config::from_toml(toml, Path::new("")).unwrap();
 796             assert_eq!(config.array_width(), 20);
 797             assert_eq!(config.attr_fn_like_width(), 40);
 798             assert_eq!(config.chain_width(), 20);
 799             assert_eq!(config.fn_call_width(), 90);
 800             assert_eq!(config.single_line_if_else_max_width(), 40);
 801             assert_eq!(config.struct_lit_width(), 30);
 802             assert_eq!(config.struct_variant_width(), 34);
 803         }
 804
 805         #[test]
 806         fn test_override_with_max() {
 807             let toml = r#"
 808                 use_small_heuristics = "Max"
 809                 array_width = 20
 810                 attr_fn_like_width = 40
 811                 chain_width = 20
 812                 fn_call_width = 90
 813                 single_line_if_else_max_width = 40
 814                 struct_lit_width = 30
 815                 struct_variant_width = 34
 816             "#;
 817             let config = Config::from_toml(toml, Path::new("")).unwrap();
 818             assert_eq!(config.array_width(), 20);
 819             assert_eq!(config.attr_fn_like_width(), 40);
 820             assert_eq!(config.chain_width(), 20);
 821             assert_eq!(config.fn_call_width(), 90);
 822             assert_eq!(config.single_line_if_else_max_width(), 40);
 823             assert_eq!(config.struct_lit_width(), 30);
 824             assert_eq!(config.struct_variant_width(), 34);
 825         }
 826
 827         #[test]
 828         fn test_override_with_off() {
 829             let toml = r#"
 830                 use_small_heuristics = "Off"
 831                 array_width = 20
 832                 attr_fn_like_width = 40
 833                 chain_width = 20
 834                 fn_call_width = 90
 835                 single_line_if_else_max_width = 40
 836                 struct_lit_width = 30
 837                 struct_variant_width = 34
 838             "#;
 839             let config = Config::from_toml(toml, Path::new("")).unwrap();
 840             assert_eq!(config.array_width(), 20);
 841             assert_eq!(config.attr_fn_like_width(), 40);
 842             assert_eq!(config.chain_width(), 20);
 843             assert_eq!(config.fn_call_width(), 90);
 844             assert_eq!(config.single_line_if_else_max_width(), 40);
 845             assert_eq!(config.struct_lit_width(), 30);
 846             assert_eq!(config.struct_variant_width(), 34);
 847         }
 848
 849         #[test]
 850         fn test_fn_call_width_config_exceeds_max_width() {
 851             let toml = r#"
 852                 max_width = 90
 853                 fn_call_width = 95
 854             "#;
 855             let config = Config::from_toml(toml, Path::new("")).unwrap();
 856             assert_eq!(config.fn_call_width(), 90);
 857         }
 858
 859         #[test]
 860         fn test_attr_fn_like_width_config_exceeds_max_width() {
 861             let toml = r#"
 862                 max_width = 80
 863                 attr_fn_like_width = 90
 864             "#;
 865             let config = Config::from_toml(toml, Path::new("")).unwrap();
 866             assert_eq!(config.attr_fn_like_width(), 80);
 867         }
 868
 869         #[test]
 870         fn test_struct_lit_config_exceeds_max_width() {
 871             let toml = r#"
 872                 max_width = 78
 873                 struct_lit_width = 90
 874             "#;
 875             let config = Config::from_toml(toml, Path::new("")).unwrap();
 876             assert_eq!(config.struct_lit_width(), 78);
 877         }
 878
 879         #[test]
 880         fn test_struct_variant_width_config_exceeds_max_width() {
 881             let toml = r#"
 882                 max_width = 80
 883                 struct_variant_width = 90
 884             "#;
 885             let config = Config::from_toml(toml, Path::new("")).unwrap();
 886             assert_eq!(config.struct_variant_width(), 80);
 887         }
 888
 889         #[test]
 890         fn test_array_width_config_exceeds_max_width() {
 891             let toml = r#"
 892                 max_width = 60
 893                 array_width = 80
 894             "#;
 895             let config = Config::from_toml(toml, Path::new("")).unwrap();
 896             assert_eq!(config.array_width(), 60);
 897         }
 898
 899         #[test]
 900         fn test_chain_width_config_exceeds_max_width() {
 901             let toml = r#"
 902                 max_width = 80
 903                 chain_width = 90
 904             "#;
 905             let config = Config::from_toml(toml, Path::new("")).unwrap();
 906             assert_eq!(config.chain_width(), 80);
 907         }
 908
 909         #[test]
 910         fn test_single_line_if_else_max_width_config_exceeds_max_width() {
 911             let toml = r#"
 912                 max_width = 70
 913                 single_line_if_else_max_width = 90
 914             "#;
 915             let config = Config::from_toml(toml, Path::new("")).unwrap();
 916             assert_eq!(config.single_line_if_else_max_width(), 70);
 917         }
 918
 919         #[test]
 920         fn test_override_fn_call_width_exceeds_max_width() {
 921             let mut config = Config::default();
 922             config.override_value("fn_call_width", "101");
 923             assert_eq!(config.fn_call_width(), 100);
 924         }
 925
 926         #[test]
 927         fn test_override_attr_fn_like_width_exceeds_max_width() {
 928             let mut config = Config::default();
 929             config.override_value("attr_fn_like_width", "101");
 930             assert_eq!(config.attr_fn_like_width(), 100);
 931         }
 932
 933         #[test]
 934         fn test_override_struct_lit_exceeds_max_width() {
 935             let mut config = Config::default();
 936             config.override_value("struct_lit_width", "101");
 937             assert_eq!(config.struct_lit_width(), 100);
 938         }
 939
 940         #[test]
 941         fn test_override_struct_variant_width_exceeds_max_width() {
 942             let mut config = Config::default();
 943             config.override_value("struct_variant_width", "101");
 944             assert_eq!(config.struct_variant_width(), 100);
 945         }
 946
 947         #[test]
 948         fn test_override_array_width_exceeds_max_width() {
 949             let mut config = Config::default();
 950             config.override_value("array_width", "101");
 951             assert_eq!(config.array_width(), 100);
 952         }
 953
 954         #[test]
 955         fn test_override_chain_width_exceeds_max_width() {
 956             let mut config = Config::default();
 957             config.override_value("chain_width", "101");
 958             assert_eq!(config.chain_width(), 100);
 959         }
 960
 961         #[test]
 962         fn test_override_single_line_if_else_max_width_exceeds_max_width() {
 963             let mut config = Config::default();
 964             config.override_value("single_line_if_else_max_width", "101");
 965             assert_eq!(config.single_line_if_else_max_width(), 100);
 966         }
 967     }
 968 }