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
  54     // Single line expressions and items.
  55     empty_item_single_line: bool, true, false,
  56         "Put empty-body functions and impls on a single line";
  57     struct_lit_single_line: bool, true, false,
  58         "Put small struct literals on a single line";
  59     fn_single_line: bool, false, false, "Put single-expression functions on a single line";
  60     where_single_line: bool, false, false, "To force single line where layout";
  61
  62     // Imports
  63     imports_indent: IndentStyle, IndentStyle::Visual, false, "Indent of imports";
  64     imports_layout: ListTactic, ListTactic::Mixed, false, "Item layout inside a import block";
  65
  66     // Ordering
  67     reorder_extern_crates: bool, true, false, "Reorder extern crate statements alphabetically";
  68     reorder_extern_crates_in_group: bool, true, false, "Reorder extern crate statements in group";
  69     reorder_imports: bool, false, false, "Reorder import statements alphabetically";
  70     reorder_imports_in_group: bool, false, false, "Reorder import statements in group";
  71     reorder_imported_names: bool, true, false,
  72         "Reorder lists of names in import statements alphabetically";
  73     reorder_modules: bool, false, false, "Reorder module statemtents alphabetically in group";
  74
  75     // Spaces around punctuation
  76     binop_separator: SeparatorPlace, SeparatorPlace::Front, false,
  77         "Where to put a binary operator when a binary expression goes multiline.";
  78     type_punctuation_density: TypeDensity, TypeDensity::Wide, false,
  79         "Determines if '+' or '=' are wrapped in spaces in the punctuation of types";
  80     space_before_colon: bool, false, false, "Leave a space before the colon";
  81     space_after_colon: bool, true, false, "Leave a space after the colon";
  82     spaces_around_ranges: bool, false, false, "Put spaces around the  .. and ... range operators";
  83     spaces_within_parens_and_brackets: bool, false, false,
  84         "Put spaces within non-empty parentheses or brackets";
  85
  86     // Misc.
  87     combine_control_expr: bool, true, false, "Combine control expressions with function calls.";
  88     struct_field_align_threshold: usize, 0, false, "Align struct fields if their diffs fits within \
  89                                              threshold.";
  90     remove_blank_lines_at_start_or_end_of_block: bool, true, false,
  91         "Remove blank lines at start or end of a block";
  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_comma: SeparatorTactic, SeparatorTactic::Vertical, false,
 101         "How to handle trailing commas for lists";
 102     trailing_semicolon: bool, true, false,
 103         "Add trailing semicolon after break, continue and return";
 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, true, 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
 141     // Not user-facing.
 142     verbose: bool, false, false, "Use verbose output";
 143     file_lines: FileLines, FileLines::all(), false,
 144         "Lines to format; this is not supported in rustfmt.toml, and can only be specified \
 145          via the --file-lines option";
 146     width_heuristics: WidthHeuristics, WidthHeuristics::scaled(100), false,
 147         "'small' heuristic values";
 148 }
 149
 150 /// Check for the presence of known config file names (`rustfmt.toml, `.rustfmt.toml`) in `dir`
 151 ///
 152 /// Return the path if a config file exists, empty if no file exists, and Error for IO errors
 153 pub fn get_toml_path(dir: &Path) -> Result<Option<PathBuf>, Error> {
 154     const CONFIG_FILE_NAMES: [&str; 2] = [".rustfmt.toml", "rustfmt.toml"];
 155     for config_file_name in &CONFIG_FILE_NAMES {
 156         let config_file = dir.join(config_file_name);
 157         match fs::metadata(&config_file) {
 158             // Only return if it's a file to handle the unlikely situation of a directory named
 159             // `rustfmt.toml`.
 160             Ok(ref md) if md.is_file() => return Ok(Some(config_file)),
 161             // Return the error if it's something other than `NotFound`; otherwise we didn't
 162             // find the project file yet, and continue searching.
 163             Err(e) => {
 164                 if e.kind() != ErrorKind::NotFound {
 165                     return Err(e);
 166                 }
 167             }
 168             _ => {}
 169         }
 170     }
 171     Ok(None)
 172 }
 173
 174 #[cfg(test)]
 175 mod test {
 176     use super::Config;
 177
 178     #[test]
 179     fn test_config_set() {
 180         let mut config = Config::default();
 181         config.set().verbose(false);
 182         assert_eq!(config.verbose(), false);
 183         config.set().verbose(true);
 184         assert_eq!(config.verbose(), true);
 185     }
 186
 187     #[test]
 188     fn test_config_used_to_toml() {
 189         let config = Config::default();
 190
 191         let merge_derives = config.merge_derives();
 192         let skip_children = config.skip_children();
 193
 194         let used_options = config.used_options();
 195         let toml = used_options.to_toml().unwrap();
 196         assert_eq!(
 197             toml,
 198             format!(
 199                 "merge_derives = {}\nskip_children = {}\n",
 200                 merge_derives, skip_children,
 201             )
 202         );
 203     }
 204
 205     #[test]
 206     fn test_was_set() {
 207         let config = Config::from_toml("hard_tabs = true").unwrap();
 208
 209         assert_eq!(config.was_set().hard_tabs(), true);
 210         assert_eq!(config.was_set().verbose(), false);
 211     }
 212
 213     // FIXME(#2183) these tests cannot be run in parallel because they use env vars
 214     // #[test]
 215     // fn test_as_not_nightly_channel() {
 216     //     let mut config = Config::default();
 217     //     assert_eq!(config.was_set().unstable_features(), false);
 218     //     config.set().unstable_features(true);
 219     //     assert_eq!(config.was_set().unstable_features(), false);
 220     // }
 221
 222     // #[test]
 223     // fn test_as_nightly_channel() {
 224     //     let v = ::std::env::var("CFG_RELEASE_CHANNEL").unwrap_or(String::from(""));
 225     //     ::std::env::set_var("CFG_RELEASE_CHANNEL", "nightly");
 226     //     let mut config = Config::default();
 227     //     config.set().unstable_features(true);
 228     //     assert_eq!(config.was_set().unstable_features(), false);
 229     //     config.set().unstable_features(true);
 230     //     assert_eq!(config.unstable_features(), true);
 231     //     ::std::env::set_var("CFG_RELEASE_CHANNEL", v);
 232     // }
 233
 234     // #[test]
 235     // fn test_unstable_from_toml() {
 236     //     let mut config = Config::from_toml("unstable_features = true").unwrap();
 237     //     assert_eq!(config.was_set().unstable_features(), false);
 238     //     let v = ::std::env::var("CFG_RELEASE_CHANNEL").unwrap_or(String::from(""));
 239     //     ::std::env::set_var("CFG_RELEASE_CHANNEL", "nightly");
 240     //     config = Config::from_toml("unstable_features = true").unwrap();
 241     //     assert_eq!(config.was_set().unstable_features(), true);
 242     //     assert_eq!(config.unstable_features(), true);
 243     //     ::std::env::set_var("CFG_RELEASE_CHANNEL", v);
 244     // }
 245 }