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::{env, fs};
  12 use std::cell::Cell;
  13 use std::default::Default;
  14 use std::fs::File;
  15 use std::io::{Error, ErrorKind, Read};
  16 use std::path::{Path, PathBuf};
  17
  18 #[macro_use]
  19 mod config_type;
  20 #[macro_use]
  21 mod options;
  22
  23 pub mod file_lines;
  24 pub mod lists;
  25 pub mod summary;
  26
  27 use config::config_type::ConfigType;
  28 use config::file_lines::FileLines;
  29 pub use config::lists::*;
  30 pub use config::options::*;
  31 use config::summary::Summary;
  32
  33 /// This macro defines configuration options used in rustfmt. Each option
  34 /// is defined as follows:
  35 ///
  36 /// `name: value type, default value, is stable, description;`
  37 create_config! {
  38     // Fundamental stuff
  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::Unix, true, "Unix or Windows line endings";
  43     indent_style: IndentStyle, IndentStyle::Block, false, "How do we indent expressions or items.";
  44     use_small_heuristics: bool, true, false, "Whether to use different formatting for items and \
  45         expressions if they satisfy a heuristic notion of 'small'.";
  46
  47     // strings and comments
  48     format_strings: bool, false, false, "Format string literals where necessary";
  49     wrap_comments: bool, false, true, "Break comments to fit on the line";
  50     comment_width: usize, 80, false,
  51         "Maximum length of comments. No effect unless wrap_comments = true";
  52     normalize_comments: bool, false, true, "Convert /* */ comments to // comments where possible";
  53     license_template: String, String::default(), false, "Check for license";
  54
  55     // Single line expressions and items.
  56     empty_item_single_line: bool, true, false,
  57         "Put empty-body functions and impls on a single line";
  58     struct_lit_single_line: bool, true, false,
  59         "Put small struct literals on a single line";
  60     fn_single_line: bool, false, false, "Put single-expression functions on a single line";
  61     where_single_line: bool, false, false, "To force single line where layout";
  62
  63     // Imports
  64     imports_indent: IndentStyle, IndentStyle::Visual, false, "Indent of imports";
  65     imports_layout: ListTactic, ListTactic::Mixed, false, "Item layout inside a import block";
  66
  67     // Ordering
  68     reorder_extern_crates: bool, true, false, "Reorder extern crate statements alphabetically";
  69     reorder_extern_crates_in_group: bool, true, false, "Reorder extern crate statements in group";
  70     reorder_imports: bool, false, false, "Reorder import statements alphabetically";
  71     reorder_imports_in_group: bool, false, false, "Reorder import statements in group";
  72     reorder_imported_names: bool, true, false,
  73         "Reorder lists of names in import statements alphabetically";
  74     reorder_modules: bool, false, false, "Reorder module statemtents alphabetically in group";
  75
  76     // Spaces around punctuation
  77     binop_separator: SeparatorPlace, SeparatorPlace::Front, false,
  78         "Where to put a binary operator when a binary expression goes multiline.";
  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     spaces_within_parens_and_brackets: bool, false, false,
  85         "Put spaces within non-empty parentheses or brackets";
  86
  87     // Misc.
  88     combine_control_expr: bool, true, false, "Combine control expressions with function calls.";
  89     struct_field_align_threshold: usize, 0, false, "Align struct fields if their diffs fits within \
  90                                              threshold.";
  91     remove_blank_lines_at_start_or_end_of_block: bool, true, false,
  92         "Remove blank lines at start or end of a block";
  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_comma: SeparatorTactic, SeparatorTactic::Vertical, false,
 102         "How to handle trailing commas for lists";
 103     trailing_semicolon: bool, true, false,
 104         "Add trailing semicolon after break, continue and return";
 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";
 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, true, 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
 142     // Not user-facing.
 143     verbose: bool, false, false, "Use verbose output";
 144     file_lines: FileLines, FileLines::all(), false,
 145         "Lines to format; this is not supported in rustfmt.toml, and can only be specified \
 146          via the --file-lines option";
 147     width_heuristics: WidthHeuristics, WidthHeuristics::scaled(100), false,
 148         "'small' heuristic values";
 149 }
 150
 151 /// Check for the presence of known config file names (`rustfmt.toml, `.rustfmt.toml`) in `dir`
 152 ///
 153 /// Return the path if a config file exists, empty if no file exists, and Error for IO errors
 154 pub fn get_toml_path(dir: &Path) -> Result<Option<PathBuf>, Error> {
 155     const CONFIG_FILE_NAMES: [&str; 2] = [".rustfmt.toml", "rustfmt.toml"];
 156     for config_file_name in &CONFIG_FILE_NAMES {
 157         let config_file = dir.join(config_file_name);
 158         match fs::metadata(&config_file) {
 159             // Only return if it's a file to handle the unlikely situation of a directory named
 160             // `rustfmt.toml`.
 161             Ok(ref md) if md.is_file() => return Ok(Some(config_file)),
 162             // Return the error if it's something other than `NotFound`; otherwise we didn't
 163             // find the project file yet, and continue searching.
 164             Err(e) => {
 165                 if e.kind() != ErrorKind::NotFound {
 166                     return Err(e);
 167                 }
 168             }
 169             _ => {}
 170         }
 171     }
 172     Ok(None)
 173 }
 174
 175 #[cfg(test)]
 176 mod test {
 177     use super::Config;
 178
 179     #[test]
 180     fn test_config_set() {
 181         let mut config = Config::default();
 182         config.set().verbose(false);
 183         assert_eq!(config.verbose(), false);
 184         config.set().verbose(true);
 185         assert_eq!(config.verbose(), true);
 186     }
 187
 188     #[test]
 189     fn test_config_used_to_toml() {
 190         let config = Config::default();
 191
 192         let merge_derives = config.merge_derives();
 193         let skip_children = config.skip_children();
 194
 195         let used_options = config.used_options();
 196         let toml = used_options.to_toml().unwrap();
 197         assert_eq!(
 198             toml,
 199             format!(
 200                 "merge_derives = {}\nskip_children = {}\n",
 201                 merge_derives, skip_children,
 202             )
 203         );
 204     }
 205
 206     #[test]
 207     fn test_was_set() {
 208         let config = Config::from_toml("hard_tabs = true").unwrap();
 209
 210         assert_eq!(config.was_set().hard_tabs(), true);
 211         assert_eq!(config.was_set().verbose(), false);
 212     }
 213
 214     // FIXME(#2183) these tests cannot be run in parallel because they use env vars
 215     // #[test]
 216     // fn test_as_not_nightly_channel() {
 217     //     let mut config = Config::default();
 218     //     assert_eq!(config.was_set().unstable_features(), false);
 219     //     config.set().unstable_features(true);
 220     //     assert_eq!(config.was_set().unstable_features(), false);
 221     // }
 222
 223     // #[test]
 224     // fn test_as_nightly_channel() {
 225     //     let v = ::std::env::var("CFG_RELEASE_CHANNEL").unwrap_or(String::from(""));
 226     //     ::std::env::set_var("CFG_RELEASE_CHANNEL", "nightly");
 227     //     let mut config = Config::default();
 228     //     config.set().unstable_features(true);
 229     //     assert_eq!(config.was_set().unstable_features(), false);
 230     //     config.set().unstable_features(true);
 231     //     assert_eq!(config.unstable_features(), true);
 232     //     ::std::env::set_var("CFG_RELEASE_CHANNEL", v);
 233     // }
 234
 235     // #[test]
 236     // fn test_unstable_from_toml() {
 237     //     let mut config = Config::from_toml("unstable_features = true").unwrap();
 238     //     assert_eq!(config.was_set().unstable_features(), false);
 239     //     let v = ::std::env::var("CFG_RELEASE_CHANNEL").unwrap_or(String::from(""));
 240     //     ::std::env::set_var("CFG_RELEASE_CHANNEL", "nightly");
 241     //     config = Config::from_toml("unstable_features = true").unwrap();
 242     //     assert_eq!(config.was_set().unstable_features(), true);
 243     //     assert_eq!(config.unstable_features(), true);
 244     //     ::std::env::set_var("CFG_RELEASE_CHANNEL", v);
 245     // }
 246 }