src/config/mod.rs

   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.
   4 //
   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.
  10
  11 use std::cell::Cell;
  12 use std::default::Default;
  13 use std::fs::File;
  14 use std::io::{Error, ErrorKind, Read};
  15 use std::path::{Path, PathBuf};
  16 use std::{env, fs};
  17
  18 use regex::Regex;
  19
  20 #[macro_use]
  21 mod config_type;
  22 #[macro_use]
  23 mod options;
  24
  25 pub mod file_lines;
  26 pub mod license;
  27 pub mod lists;
  28 pub mod summary;
  29
  30 use config::config_type::ConfigType;
  31 use config::file_lines::FileLines;
  32 pub use config::lists::*;
  33 pub use config::options::*;
  34 use config::summary::Summary;
  35
  36 /// This macro defines configuration options used in rustfmt. Each option
  37 /// is defined as follows:
  38 ///
  39 /// `name: value type, default value, is stable, description;`
  40 create_config! {
  41     // Fundamental stuff
  42     max_width: usize, 100, true, "Maximum width of each line";
  43     hard_tabs: bool, false, true, "Use tab characters for indentation, spaces for alignment";
  44     tab_spaces: usize, 4, true, "Number of spaces per tab";
  45     newline_style: NewlineStyle, NewlineStyle::Unix, true, "Unix or Windows line endings";
  46     use_small_heuristics: bool, true, false, "Whether to use different formatting for items and \
  47         expressions if they satisfy a heuristic notion of 'small'.";
  48     indent_style: IndentStyle, IndentStyle::Block, false, "How do we indent expressions or items.";
  49
  50     // Comments and strings
  51     wrap_comments: bool, false, true, "Break comments to fit on the line";
  52     comment_width: usize, 80, false,
  53         "Maximum length of comments. No effect unless wrap_comments = true";
  54     normalize_comments: bool, false, true, "Convert /* */ comments to // comments where possible";
  55     license_template_path: String, String::default(), false, "Beginning of file must match license template";
  56     format_strings: bool, false, false, "Format string literals where necessary";
  57
  58     // Single line expressions and items
  59     empty_item_single_line: bool, true, false,
  60         "Put empty-body functions and impls on a single line";
  61     struct_lit_single_line: bool, true, false,
  62         "Put small struct literals on a single line";
  63     fn_single_line: bool, false, false, "Put single-expression functions on a single line";
  64     where_single_line: bool, false, false, "Force where clauses to be on a single line";
  65
  66     // Imports
  67     imports_indent: IndentStyle, IndentStyle::Visual, false, "Indent of imports";
  68     imports_layout: ListTactic, ListTactic::Mixed, false, "Item layout inside a import block";
  69     merge_imports: bool, false, false, "Merge imports";
  70
  71     // Ordering
  72     reorder_imports: bool, true, false, "Reorder import and extern crate statements alphabetically";
  73     reorder_modules: bool, true, false, "Reorder module statements alphabetically in group";
  74     reorder_impl_items: bool, false, false, "Reorder impl items";
  75
  76     // Spaces around punctuation
  77     type_punctuation_density: TypeDensity, TypeDensity::Wide, false,
  78         "Determines if '+' or '=' are wrapped in spaces in the punctuation of types";
  79     space_before_colon: bool, false, false, "Leave a space before the colon";
  80     space_after_colon: bool, true, false, "Leave a space after the colon";
  81     spaces_around_ranges: bool, false, false, "Put spaces around the  .. and ... range operators";
  82     spaces_within_parens_and_brackets: bool, false, false,
  83         "Put spaces within non-empty parentheses or brackets";
  84     binop_separator: SeparatorPlace, SeparatorPlace::Front, false,
  85         "Where to put a binary operator when a binary expression goes multiline.";
  86
  87     // Misc.
  88     remove_blank_lines_at_start_or_end_of_block: bool, true, false,
  89         "Remove blank lines at start or end of a block";
  90     combine_control_expr: bool, true, false, "Combine control expressions with function calls.";
  91     struct_field_align_threshold: usize, 0, false, "Align struct fields if their diffs fits within \
  92                                              threshold.";
  93     match_arm_blocks: bool, true, false, "Wrap the body of arms in blocks when it does not fit on \
  94         the same line with the pattern of arms";
  95     force_multiline_blocks: bool, false, false,
  96         "Force multiline closure bodies and match arms to be wrapped in a block";
  97     fn_args_density: Density, Density::Tall, false, "Argument density in functions";
  98     brace_style: BraceStyle, BraceStyle::SameLineWhere, false, "Brace style for items";
  99     control_brace_style: ControlBraceStyle, ControlBraceStyle::AlwaysSameLine, false,
 100         "Brace style for control flow constructs";
 101     trailing_semicolon: bool, true, false,
 102         "Add trailing semicolon after break, continue and return";
 103     trailing_comma: SeparatorTactic, SeparatorTactic::Vertical, false,
 104         "How to handle trailing commas for lists";
 105     match_block_trailing_comma: bool, false, false,
 106         "Put a trailing comma after a block based match arm (non-block arms are not affected)";
 107     blank_lines_upper_bound: usize, 1, false,
 108         "Maximum number of blank lines which can be put between items.";
 109     blank_lines_lower_bound: usize, 0, false,
 110         "Minimum number of blank lines which must be put between items.";
 111
 112     // Options that can change the source code beyond whitespace/blocks (somewhat linty things)
 113     merge_derives: bool, true, true, "Merge multiple `#[derive(...)]` into a single one";
 114     use_try_shorthand: bool, false, false, "Replace uses of the try! macro by the ? shorthand";
 115     condense_wildcard_suffixes: bool, false, false, "Replace strings of _ wildcards by a single .. \
 116                                               in tuple patterns";
 117     force_explicit_abi: bool, true, true, "Always print the abi for extern items";
 118     use_field_init_shorthand: bool, false, false, "Use field initialization shorthand if possible";
 119
 120     // Control options (changes the operation of rustfmt, rather than the formatting)
 121     write_mode: WriteMode, WriteMode::Overwrite, false,
 122         "What Write Mode to use when none is supplied: \
 123          Replace, Overwrite, Display, Plain, Diff, Coverage, Check";
 124     color: Color, Color::Auto, false,
 125         "What Color option to use when none is supplied: Always, Never, Auto";
 126     required_version: String, env!("CARGO_PKG_VERSION").to_owned(), false,
 127         "Require a specific version of rustfmt.";
 128     unstable_features: bool, false, true,
 129             "Enables unstable features. Only available on nightly channel";
 130     disable_all_formatting: bool, false, false, "Don't reformat anything";
 131     skip_children: bool, false, false, "Don't reformat out of line modules";
 132     hide_parse_errors: bool, false, false, "Hide errors from the parser";
 133     error_on_line_overflow: bool, false, false, "Error if unable to get all lines within max_width";
 134     error_on_unformatted: bool, false, false,
 135         "Error if unable to get comments or string literals within max_width, \
 136          or they are left with trailing whitespaces";
 137     report_todo: ReportTactic, ReportTactic::Never, false,
 138         "Report all, none or unnumbered occurrences of TODO in source file comments";
 139     report_fixme: ReportTactic, ReportTactic::Never, false,
 140         "Report all, none or unnumbered occurrences of FIXME in source file comments";
 141     ignore: IgnoreList, IgnoreList::default(), false,
 142         "Skip formatting the specified files and directories.";
 143
 144     // Not user-facing
 145     verbose: bool, false, false, "Use verbose output";
 146     verbose_diff: bool, false, false, "Emit verbose diffs";
 147     file_lines: FileLines, FileLines::all(), false,
 148         "Lines to format; this is not supported in rustfmt.toml, and can only be specified \
 149          via the --file-lines option";
 150     width_heuristics: WidthHeuristics, WidthHeuristics::scaled(100), false,
 151         "'small' heuristic values";
 152 }
 153
 154 /// Check for the presence of known config file names (`rustfmt.toml, `.rustfmt.toml`) in `dir`
 155 ///
 156 /// Return the path if a config file exists, empty if no file exists, and Error for IO errors
 157 pub fn get_toml_path(dir: &Path) -> Result<Option<PathBuf>, Error> {
 158     const CONFIG_FILE_NAMES: [&str; 2] = [".rustfmt.toml", "rustfmt.toml"];
 159     for config_file_name in &CONFIG_FILE_NAMES {
 160         let config_file = dir.join(config_file_name);
 161         match fs::metadata(&config_file) {
 162             // Only return if it's a file to handle the unlikely situation of a directory named
 163             // `rustfmt.toml`.
 164             Ok(ref md) if md.is_file() => return Ok(Some(config_file)),
 165             // Return the error if it's something other than `NotFound`; otherwise we didn't
 166             // find the project file yet, and continue searching.
 167             Err(e) => {
 168                 if e.kind() != ErrorKind::NotFound {
 169                     return Err(e);
 170                 }
 171             }
 172             _ => {}
 173         }
 174     }
 175     Ok(None)
 176 }
 177
 178 #[cfg(test)]
 179 mod test {
 180     use super::Config;
 181     use std::str;
 182
 183     #[allow(dead_code)]
 184     mod mock {
 185         use super::super::*;
 186
 187         create_config! {
 188             // Options that are used by the generated functions
 189             max_width: usize, 100, true, "Maximum width of each line";
 190             use_small_heuristics: bool, true, false, "Whether to use different formatting for items and \
 191                 expressions if they satisfy a heuristic notion of 'small'.";
 192             license_template_path: String, String::default(), false, "Beginning of file must match license template";
 193             required_version: String, env!("CARGO_PKG_VERSION").to_owned(), false, "Require a specific version of rustfmt.";
 194             ignore: IgnoreList, IgnoreList::default(), false, "Skip formatting the specified files and directories.";
 195             verbose: bool, false, false, "Use verbose output";
 196             file_lines: FileLines, FileLines::all(), false,
 197                 "Lines to format; this is not supported in rustfmt.toml, and can only be specified \
 198                     via the --file-lines option";
 199             width_heuristics: WidthHeuristics, WidthHeuristics::scaled(100), false, "'small' heuristic values";
 200
 201             // Options that are used by the tests
 202             stable_option: bool, false, true, "A stable option";
 203             unstable_option: bool, false, false, "An unstable option";
 204         }
 205     }
 206
 207     #[test]
 208     fn test_config_set() {
 209         let mut config = Config::default();
 210         config.set().verbose(false);
 211         assert_eq!(config.verbose(), false);
 212         config.set().verbose(true);
 213         assert_eq!(config.verbose(), true);
 214     }
 215
 216     #[test]
 217     fn test_config_used_to_toml() {
 218         let config = Config::default();
 219
 220         let merge_derives = config.merge_derives();
 221         let skip_children = config.skip_children();
 222
 223         let used_options = config.used_options();
 224         let toml = used_options.to_toml().unwrap();
 225         assert_eq!(
 226             toml,
 227             format!(
 228                 "merge_derives = {}\nskip_children = {}\n",
 229                 merge_derives, skip_children,
 230             )
 231         );
 232     }
 233
 234     #[test]
 235     fn test_was_set() {
 236         use std::path::Path;
 237         let config = Config::from_toml("hard_tabs = true", Path::new("")).unwrap();
 238
 239         assert_eq!(config.was_set().hard_tabs(), true);
 240         assert_eq!(config.was_set().verbose(), false);
 241     }
 242
 243     #[test]
 244     fn test_print_docs_exclude_unstable() {
 245         use self::mock::Config;
 246
 247         let mut output = Vec::new();
 248         Config::print_docs(&mut output, false);
 249
 250         let s = str::from_utf8(&output).unwrap();
 251
 252         assert_eq!(s.contains("stable_option"), true);
 253         assert_eq!(s.contains("unstable_option"), false);
 254         assert_eq!(s.contains("(unstable)"), false);
 255     }
 256
 257     #[test]
 258     fn test_print_docs_include_unstable() {
 259         use self::mock::Config;
 260
 261         let mut output = Vec::new();
 262         Config::print_docs(&mut output, true);
 263
 264         let s = str::from_utf8(&output).unwrap();
 265         assert_eq!(s.contains("stable_option"), true);
 266         assert_eq!(s.contains("unstable_option"), true);
 267         assert_eq!(s.contains("(unstable)"), true);
 268     }
 269
 270     // FIXME(#2183) these tests cannot be run in parallel because they use env vars
 271     // #[test]
 272     // fn test_as_not_nightly_channel() {
 273     //     let mut config = Config::default();
 274     //     assert_eq!(config.was_set().unstable_features(), false);
 275     //     config.set().unstable_features(true);
 276     //     assert_eq!(config.was_set().unstable_features(), false);
 277     // }
 278
 279     // #[test]
 280     // fn test_as_nightly_channel() {
 281     //     let v = ::std::env::var("CFG_RELEASE_CHANNEL").unwrap_or(String::from(""));
 282     //     ::std::env::set_var("CFG_RELEASE_CHANNEL", "nightly");
 283     //     let mut config = Config::default();
 284     //     config.set().unstable_features(true);
 285     //     assert_eq!(config.was_set().unstable_features(), false);
 286     //     config.set().unstable_features(true);
 287     //     assert_eq!(config.unstable_features(), true);
 288     //     ::std::env::set_var("CFG_RELEASE_CHANNEL", v);
 289     // }
 290
 291     // #[test]
 292     // fn test_unstable_from_toml() {
 293     //     let mut config = Config::from_toml("unstable_features = true").unwrap();
 294     //     assert_eq!(config.was_set().unstable_features(), false);
 295     //     let v = ::std::env::var("CFG_RELEASE_CHANNEL").unwrap_or(String::from(""));
 296     //     ::std::env::set_var("CFG_RELEASE_CHANNEL", "nightly");
 297     //     config = Config::from_toml("unstable_features = true").unwrap();
 298     //     assert_eq!(config.was_set().unstable_features(), true);
 299     //     assert_eq!(config.unstable_features(), true);
 300     //     ::std::env::set_var("CFG_RELEASE_CHANNEL", v);
 301     // }
 302 }