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
  70     // Ordering
  71     reorder_imports: bool, true, false, "Reorder import and extern crate statements alphabetically";
  72     reorder_modules: bool, true, false, "Reorder module statements alphabetically in group";
  73     reorder_impl_items: bool, false, false, "Reorder impl items";
  74
  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     spaces_within_parens_and_brackets: bool, false, false,
  82         "Put spaces within non-empty parentheses or brackets";
  83     binop_separator: SeparatorPlace, SeparatorPlace::Front, false,
  84         "Where to put a binary operator when a binary expression goes multiline.";
  85
  86     // Misc.
  87     remove_blank_lines_at_start_or_end_of_block: bool, true, false,
  88         "Remove blank lines at start or end of a block";
  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 \
  91                                              threshold.";
  92     match_arm_blocks: bool, true, false, "Wrap the body of arms in blocks when it does not fit on \
  93         the same line with the pattern of arms";
  94     force_multiline_blocks: bool, false, false,
  95         "Force multiline closure bodies and match arms to be wrapped in a block";
  96     fn_args_density: Density, Density::Tall, false, "Argument density in functions";
  97     brace_style: BraceStyle, BraceStyle::SameLineWhere, false, "Brace style for items";
  98     control_brace_style: ControlBraceStyle, ControlBraceStyle::AlwaysSameLine, false,
  99         "Brace style for control flow constructs";
 100     trailing_semicolon: bool, true, false,
 101         "Add trailing semicolon after break, continue and return";
 102     trailing_comma: SeparatorTactic, SeparatorTactic::Vertical, false,
 103         "How to handle trailing commas for lists";
 104     match_block_trailing_comma: bool, false, false,
 105         "Put a trailing comma after a block based match arm (non-block arms are not affected)";
 106     blank_lines_upper_bound: usize, 1, false,
 107         "Maximum number of blank lines which can be put between items.";
 108     blank_lines_lower_bound: usize, 0, false,
 109         "Minimum number of blank lines which must be put between items.";
 110
 111     // Options that can change the source code beyond whitespace/blocks (somewhat linty things)
 112     merge_derives: bool, true, true, "Merge multiple `#[derive(...)]` into a single one";
 113     use_try_shorthand: bool, false, false, "Replace uses of the try! macro by the ? shorthand";
 114     condense_wildcard_suffixes: bool, false, false, "Replace strings of _ wildcards by a single .. \
 115                                               in tuple patterns";
 116     force_explicit_abi: bool, true, true, "Always print the abi for extern items";
 117     use_field_init_shorthand: bool, false, false, "Use field initialization shorthand if possible";
 118
 119     // Control options (changes the operation of rustfmt, rather than the formatting)
 120     write_mode: WriteMode, WriteMode::Overwrite, false,
 121         "What Write Mode to use when none is supplied: \
 122          Replace, Overwrite, Display, Plain, Diff, Coverage";
 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, true,
 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.";
 142
 143     // Not user-facing
 144     verbose: bool, false, false, "Use verbose output";
 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 }
 151
 152 /// Check for the presence of known config file names (`rustfmt.toml, `.rustfmt.toml`) in `dir`
 153 ///
 154 /// Return the path if a config file exists, empty if no file exists, and Error for IO errors
 155 pub fn get_toml_path(dir: &Path) -> Result<Option<PathBuf>, Error> {
 156     const CONFIG_FILE_NAMES: [&str; 2] = [".rustfmt.toml", "rustfmt.toml"];
 157     for config_file_name in &CONFIG_FILE_NAMES {
 158         let config_file = dir.join(config_file_name);
 159         match fs::metadata(&config_file) {
 160             // Only return if it's a file to handle the unlikely situation of a directory named
 161             // `rustfmt.toml`.
 162             Ok(ref md) if md.is_file() => return Ok(Some(config_file)),
 163             // Return the error if it's something other than `NotFound`; otherwise we didn't
 164             // find the project file yet, and continue searching.
 165             Err(e) => {
 166                 if e.kind() != ErrorKind::NotFound {
 167                     return Err(e);
 168                 }
 169             }
 170             _ => {}
 171         }
 172     }
 173     Ok(None)
 174 }
 175
 176 #[cfg(test)]
 177 mod test {
 178     use super::Config;
 179     use std::str;
 180
 181     #[allow(dead_code)]
 182     mod mock {
 183         use super::super::*;
 184
 185         create_config! {
 186             // Options that are used by the generated functions
 187             max_width: usize, 100, true, "Maximum width of each line";
 188             use_small_heuristics: bool, true, false, "Whether to use different formatting for items and \
 189                 expressions if they satisfy a heuristic notion of 'small'.";
 190             license_template_path: String, String::default(), false, "Beginning of file must match license template";
 191             required_version: String, env!("CARGO_PKG_VERSION").to_owned(), false, "Require a specific version of rustfmt.";
 192             ignore: IgnoreList, IgnoreList::default(), false, "Skip formatting the specified files and directories.";
 193             verbose: bool, false, false, "Use verbose output";
 194             file_lines: FileLines, FileLines::all(), false,
 195                 "Lines to format; this is not supported in rustfmt.toml, and can only be specified \
 196                     via the --file-lines option";
 197             width_heuristics: WidthHeuristics, WidthHeuristics::scaled(100), false, "'small' heuristic values";
 198
 199             // Options that are used by the tests
 200             stable_option: bool, false, true, "A stable option";
 201             unstable_option: bool, false, false, "An unstable option";
 202         }
 203     }
 204
 205     #[test]
 206     fn test_config_set() {
 207         let mut config = Config::default();
 208         config.set().verbose(false);
 209         assert_eq!(config.verbose(), false);
 210         config.set().verbose(true);
 211         assert_eq!(config.verbose(), true);
 212     }
 213
 214     #[test]
 215     fn test_config_used_to_toml() {
 216         let config = Config::default();
 217
 218         let merge_derives = config.merge_derives();
 219         let skip_children = config.skip_children();
 220
 221         let used_options = config.used_options();
 222         let toml = used_options.to_toml().unwrap();
 223         assert_eq!(
 224             toml,
 225             format!(
 226                 "merge_derives = {}\nskip_children = {}\n",
 227                 merge_derives, skip_children,
 228             )
 229         );
 230     }
 231
 232     #[test]
 233     fn test_was_set() {
 234         use std::path::Path;
 235         let config = Config::from_toml("hard_tabs = true", Path::new("")).unwrap();
 236
 237         assert_eq!(config.was_set().hard_tabs(), true);
 238         assert_eq!(config.was_set().verbose(), false);
 239     }
 240
 241     #[test]
 242     fn test_print_docs_exclude_unstable() {
 243         use self::mock::Config;
 244
 245         let mut output = Vec::new();
 246         Config::print_docs(&mut output, false);
 247
 248         let s = str::from_utf8(&output).unwrap();
 249
 250         assert_eq!(s.contains("stable_option"), true);
 251         assert_eq!(s.contains("unstable_option"), false);
 252         assert_eq!(s.contains("(unstable)"), false);
 253     }
 254
 255     #[test]
 256     fn test_print_docs_include_unstable() {
 257         use self::mock::Config;
 258
 259         let mut output = Vec::new();
 260         Config::print_docs(&mut output, true);
 261
 262         let s = str::from_utf8(&output).unwrap();
 263         assert_eq!(s.contains("stable_option"), true);
 264         assert_eq!(s.contains("unstable_option"), true);
 265         assert_eq!(s.contains("(unstable)"), true);
 266     }
 267
 268     // FIXME(#2183) these tests cannot be run in parallel because they use env vars
 269     // #[test]
 270     // fn test_as_not_nightly_channel() {
 271     //     let mut config = Config::default();
 272     //     assert_eq!(config.was_set().unstable_features(), false);
 273     //     config.set().unstable_features(true);
 274     //     assert_eq!(config.was_set().unstable_features(), false);
 275     // }
 276
 277     // #[test]
 278     // fn test_as_nightly_channel() {
 279     //     let v = ::std::env::var("CFG_RELEASE_CHANNEL").unwrap_or(String::from(""));
 280     //     ::std::env::set_var("CFG_RELEASE_CHANNEL", "nightly");
 281     //     let mut config = Config::default();
 282     //     config.set().unstable_features(true);
 283     //     assert_eq!(config.was_set().unstable_features(), false);
 284     //     config.set().unstable_features(true);
 285     //     assert_eq!(config.unstable_features(), true);
 286     //     ::std::env::set_var("CFG_RELEASE_CHANNEL", v);
 287     // }
 288
 289     // #[test]
 290     // fn test_unstable_from_toml() {
 291     //     let mut config = Config::from_toml("unstable_features = true").unwrap();
 292     //     assert_eq!(config.was_set().unstable_features(), false);
 293     //     let v = ::std::env::var("CFG_RELEASE_CHANNEL").unwrap_or(String::from(""));
 294     //     ::std::env::set_var("CFG_RELEASE_CHANNEL", "nightly");
 295     //     config = Config::from_toml("unstable_features = true").unwrap();
 296     //     assert_eq!(config.was_set().unstable_features(), true);
 297     //     assert_eq!(config.unstable_features(), true);
 298     //     ::std::env::set_var("CFG_RELEASE_CHANNEL", v);
 299     // }
 300 }