src/tools/clippy/clippy_lints/src/utils/conf.rs

   1 //! Read configurations files.
   2
   3 #![allow(clippy::module_name_repetitions)]
   4
   5 use serde::de::{Deserializer, IgnoredAny, IntoDeserializer, MapAccess, Visitor};
   6 use serde::Deserialize;
   7 use std::error::Error;
   8 use std::path::{Path, PathBuf};
   9 use std::str::FromStr;
  10 use std::{cmp, env, fmt, fs, io, iter};
  11
  12 #[rustfmt::skip]
  13 const DEFAULT_DOC_VALID_IDENTS: &[&str] = &[
  14     "KiB", "MiB", "GiB", "TiB", "PiB", "EiB",
  15     "DirectX",
  16     "ECMAScript",
  17     "GPLv2", "GPLv3",
  18     "GitHub", "GitLab",
  19     "IPv4", "IPv6",
  20     "ClojureScript", "CoffeeScript", "JavaScript", "PureScript", "TypeScript",
  21     "NaN", "NaNs",
  22     "OAuth", "GraphQL",
  23     "OCaml",
  24     "OpenGL", "OpenMP", "OpenSSH", "OpenSSL", "OpenStreetMap", "OpenDNS",
  25     "WebGL",
  26     "TensorFlow",
  27     "TrueType",
  28     "iOS", "macOS", "FreeBSD",
  29     "TeX", "LaTeX", "BibTeX", "BibLaTeX",
  30     "MinGW",
  31     "CamelCase",
  32 ];
  33 const DEFAULT_BLACKLISTED_NAMES: &[&str] = &["foo", "baz", "quux"];
  34
  35 /// Holds information used by `MISSING_ENFORCED_IMPORT_RENAMES` lint.
  36 #[derive(Clone, Debug, Deserialize)]
  37 pub struct Rename {
  38     pub path: String,
  39     pub rename: String,
  40 }
  41
  42 /// A single disallowed method, used by the `DISALLOWED_METHODS` lint.
  43 #[derive(Clone, Debug, Deserialize)]
  44 #[serde(untagged)]
  45 pub enum DisallowedMethod {
  46     Simple(String),
  47     WithReason { path: String, reason: Option<String> },
  48 }
  49
  50 impl DisallowedMethod {
  51     pub fn path(&self) -> &str {
  52         let (Self::Simple(path) | Self::WithReason { path, .. }) = self;
  53
  54         path
  55     }
  56 }
  57
  58 /// A single disallowed type, used by the `DISALLOWED_TYPES` lint.
  59 #[derive(Clone, Debug, Deserialize)]
  60 #[serde(untagged)]
  61 pub enum DisallowedType {
  62     Simple(String),
  63     WithReason { path: String, reason: Option<String> },
  64 }
  65
  66 /// Conf with parse errors
  67 #[derive(Default)]
  68 pub struct TryConf {
  69     pub conf: Conf,
  70     pub errors: Vec<Box<dyn Error>>,
  71 }
  72
  73 impl TryConf {
  74     fn from_error(error: impl Error + 'static) -> Self {
  75         Self {
  76             conf: Conf::default(),
  77             errors: vec![Box::new(error)],
  78         }
  79     }
  80 }
  81
  82 #[derive(Debug)]
  83 struct ConfError(String);
  84
  85 impl fmt::Display for ConfError {
  86     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
  87         <String as fmt::Display>::fmt(&self.0, f)
  88     }
  89 }
  90
  91 impl Error for ConfError {}
  92
  93 fn conf_error(s: String) -> Box<dyn Error> {
  94     Box::new(ConfError(s))
  95 }
  96
  97 macro_rules! define_Conf {
  98     ($(
  99         $(#[doc = $doc:literal])+
 100         $(#[conf_deprecated($dep:literal)])?
 101         ($name:ident: $ty:ty = $default:expr),
 102     )*) => {
 103         /// Clippy lint configuration
 104         pub struct Conf {
 105             $($(#[doc = $doc])+ pub $name: $ty,)*
 106         }
 107
 108         mod defaults {
 109             $(pub fn $name() -> $ty { $default })*
 110         }
 111
 112         impl Default for Conf {
 113             fn default() -> Self {
 114                 Self { $($name: defaults::$name(),)* }
 115             }
 116         }
 117
 118         impl<'de> Deserialize<'de> for TryConf {
 119             fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: Deserializer<'de> {
 120                 deserializer.deserialize_map(ConfVisitor)
 121             }
 122         }
 123
 124         #[derive(Deserialize)]
 125         #[serde(field_identifier, rename_all = "kebab-case")]
 126         #[allow(non_camel_case_types)]
 127         enum Field { $($name,)* third_party, }
 128
 129         struct ConfVisitor;
 130
 131         impl<'de> Visitor<'de> for ConfVisitor {
 132             type Value = TryConf;
 133
 134             fn expecting(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
 135                 formatter.write_str("Conf")
 136             }
 137
 138             fn visit_map<V>(self, mut map: V) -> Result<Self::Value, V::Error> where V: MapAccess<'de> {
 139                 let mut errors = Vec::new();
 140                 $(let mut $name = None;)*
 141                 // could get `Field` here directly, but get `str` first for diagnostics
 142                 while let Some(name) = map.next_key::<&str>()? {
 143                     match Field::deserialize(name.into_deserializer())? {
 144                         $(Field::$name => {
 145                             $(errors.push(conf_error(format!("deprecated field `{}`. {}", name, $dep)));)?
 146                             match map.next_value() {
 147                                 Err(e) => errors.push(conf_error(e.to_string())),
 148                                 Ok(value) => match $name {
 149                                     Some(_) => errors.push(conf_error(format!("duplicate field `{}`", name))),
 150                                     None => $name = Some(value),
 151                                 }
 152                             }
 153                         })*
 154                         // white-listed; ignore
 155                         Field::third_party => drop(map.next_value::<IgnoredAny>())
 156                     }
 157                 }
 158                 let conf = Conf { $($name: $name.unwrap_or_else(defaults::$name),)* };
 159                 Ok(TryConf { conf, errors })
 160             }
 161         }
 162
 163         #[cfg(feature = "internal")]
 164         pub mod metadata {
 165             use crate::utils::internal_lints::metadata_collector::ClippyConfiguration;
 166
 167             macro_rules! wrap_option {
 168                 () => (None);
 169                 ($x:literal) => (Some($x));
 170             }
 171
 172             pub(crate) fn get_configuration_metadata() -> Vec<ClippyConfiguration> {
 173                 vec![
 174                     $(
 175                         {
 176                             let deprecation_reason = wrap_option!($($dep)?);
 177
 178                             ClippyConfiguration::new(
 179                                 stringify!($name),
 180                                 stringify!($ty),
 181                                 format!("{:?}", super::defaults::$name()),
 182                                 concat!($($doc, '\n',)*),
 183                                 deprecation_reason,
 184                             )
 185                         },
 186                     )+
 187                 ]
 188             }
 189         }
 190     };
 191 }
 192
 193 define_Conf! {
 194     /// Lint: ENUM_VARIANT_NAMES, LARGE_TYPES_PASSED_BY_VALUE, TRIVIALLY_COPY_PASS_BY_REF, UNNECESSARY_WRAPS, UPPER_CASE_ACRONYMS, WRONG_SELF_CONVENTION, BOX_COLLECTION, REDUNDANT_ALLOCATION, RC_BUFFER, VEC_BOX, OPTION_OPTION, LINKEDLIST, RC_MUTEX.
 195     ///
 196     /// Suppress lints whenever the suggested change would cause breakage for other crates.
 197     (avoid_breaking_exported_api: bool = true),
 198     /// Lint: MANUAL_SPLIT_ONCE, MANUAL_STR_REPEAT, CLONED_INSTEAD_OF_COPIED, REDUNDANT_FIELD_NAMES, REDUNDANT_STATIC_LIFETIMES, FILTER_MAP_NEXT, CHECKED_CONVERSIONS, MANUAL_RANGE_CONTAINS, USE_SELF, MEM_REPLACE_WITH_DEFAULT, MANUAL_NON_EXHAUSTIVE, OPTION_AS_REF_DEREF, MAP_UNWRAP_OR, MATCH_LIKE_MATCHES_MACRO, MANUAL_STRIP, MISSING_CONST_FOR_FN, UNNESTED_OR_PATTERNS, FROM_OVER_INTO, PTR_AS_PTR, IF_THEN_SOME_ELSE_NONE, APPROX_CONSTANT, DEPRECATED_CFG_ATTR, INDEX_REFUTABLE_SLICE, MAP_CLONE, BORROW_AS_PTR, MANUAL_BITS, ERR_EXPECT, CAST_ABS_TO_UNSIGNED.
 199     ///
 200     /// The minimum rust version that the project supports
 201     (msrv: Option<String> = None),
 202     /// Lint: BLACKLISTED_NAME.
 203     ///
 204     /// The list of blacklisted names to lint about. NB: `bar` is not here since it has legitimate uses. The value
 205     /// `".."` can be used as part of the list to indicate, that the configured values should be appended to the
 206     /// default configuration of Clippy. By default any configuraction will replace the default value.
 207     (blacklisted_names: Vec<String> = super::DEFAULT_BLACKLISTED_NAMES.iter().map(ToString::to_string).collect()),
 208     /// Lint: COGNITIVE_COMPLEXITY.
 209     ///
 210     /// The maximum cognitive complexity a function can have
 211     (cognitive_complexity_threshold: u64 = 25),
 212     /// DEPRECATED LINT: CYCLOMATIC_COMPLEXITY.
 213     ///
 214     /// Use the Cognitive Complexity lint instead.
 215     #[conf_deprecated("Please use `cognitive-complexity-threshold` instead")]
 216     (cyclomatic_complexity_threshold: Option<u64> = None),
 217     /// Lint: DOC_MARKDOWN.
 218     ///
 219     /// The list of words this lint should not consider as identifiers needing ticks. The value
 220     /// `".."` can be used as part of the list to indicate, that the configured values should be appended to the
 221     /// default configuration of Clippy. By default any configuraction will replace the default value. For example:
 222     /// * `doc-valid-idents = ["ClipPy"]` would replace the default list with `["ClipPy"]`.
 223     /// * `doc-valid-idents = ["ClipPy", ".."]` would append `ClipPy` to the default list.
 224     ///
 225     /// Default list:
 226     (doc_valid_idents: Vec<String> = super::DEFAULT_DOC_VALID_IDENTS.iter().map(ToString::to_string).collect()),
 227     /// Lint: TOO_MANY_ARGUMENTS.
 228     ///
 229     /// The maximum number of argument a function or method can have
 230     (too_many_arguments_threshold: u64 = 7),
 231     /// Lint: TYPE_COMPLEXITY.
 232     ///
 233     /// The maximum complexity a type can have
 234     (type_complexity_threshold: u64 = 250),
 235     /// Lint: MANY_SINGLE_CHAR_NAMES.
 236     ///
 237     /// The maximum number of single char bindings a scope may have
 238     (single_char_binding_names_threshold: u64 = 4),
 239     /// Lint: BOXED_LOCAL, USELESS_VEC.
 240     ///
 241     /// The maximum size of objects (in bytes) that will be linted. Larger objects are ok on the heap
 242     (too_large_for_stack: u64 = 200),
 243     /// Lint: ENUM_VARIANT_NAMES.
 244     ///
 245     /// The minimum number of enum variants for the lints about variant names to trigger
 246     (enum_variant_name_threshold: u64 = 3),
 247     /// Lint: LARGE_ENUM_VARIANT.
 248     ///
 249     /// The maximum size of an enum's variant to avoid box suggestion
 250     (enum_variant_size_threshold: u64 = 200),
 251     /// Lint: VERBOSE_BIT_MASK.
 252     ///
 253     /// The maximum allowed size of a bit mask before suggesting to use 'trailing_zeros'
 254     (verbose_bit_mask_threshold: u64 = 1),
 255     /// Lint: DECIMAL_LITERAL_REPRESENTATION.
 256     ///
 257     /// The lower bound for linting decimal literals
 258     (literal_representation_threshold: u64 = 16384),
 259     /// Lint: TRIVIALLY_COPY_PASS_BY_REF.
 260     ///
 261     /// The maximum size (in bytes) to consider a `Copy` type for passing by value instead of by reference.
 262     (trivial_copy_size_limit: Option<u64> = None),
 263     /// Lint: LARGE_TYPE_PASS_BY_MOVE.
 264     ///
 265     /// The minimum size (in bytes) to consider a type for passing by reference instead of by value.
 266     (pass_by_value_size_limit: u64 = 256),
 267     /// Lint: TOO_MANY_LINES.
 268     ///
 269     /// The maximum number of lines a function or method can have
 270     (too_many_lines_threshold: u64 = 100),
 271     /// Lint: LARGE_STACK_ARRAYS, LARGE_CONST_ARRAYS.
 272     ///
 273     /// The maximum allowed size for arrays on the stack
 274     (array_size_threshold: u64 = 512_000),
 275     /// Lint: VEC_BOX.
 276     ///
 277     /// The size of the boxed type in bytes, where boxing in a `Vec` is allowed
 278     (vec_box_size_threshold: u64 = 4096),
 279     /// Lint: TYPE_REPETITION_IN_BOUNDS.
 280     ///
 281     /// The maximum number of bounds a trait can have to be linted
 282     (max_trait_bounds: u64 = 3),
 283     /// Lint: STRUCT_EXCESSIVE_BOOLS.
 284     ///
 285     /// The maximum number of bool fields a struct can have
 286     (max_struct_bools: u64 = 3),
 287     /// Lint: FN_PARAMS_EXCESSIVE_BOOLS.
 288     ///
 289     /// The maximum number of bool parameters a function can have
 290     (max_fn_params_bools: u64 = 3),
 291     /// Lint: WILDCARD_IMPORTS.
 292     ///
 293     /// Whether to allow certain wildcard imports (prelude, super in tests).
 294     (warn_on_all_wildcard_imports: bool = false),
 295     /// Lint: DISALLOWED_METHODS.
 296     ///
 297     /// The list of disallowed methods, written as fully qualified paths.
 298     (disallowed_methods: Vec<crate::utils::conf::DisallowedMethod> = Vec::new()),
 299     /// Lint: DISALLOWED_TYPES.
 300     ///
 301     /// The list of disallowed types, written as fully qualified paths.
 302     (disallowed_types: Vec<crate::utils::conf::DisallowedType> = Vec::new()),
 303     /// Lint: UNREADABLE_LITERAL.
 304     ///
 305     /// Should the fraction of a decimal be linted to include separators.
 306     (unreadable_literal_lint_fractions: bool = true),
 307     /// Lint: UPPER_CASE_ACRONYMS.
 308     ///
 309     /// Enables verbose mode. Triggers if there is more than one uppercase char next to each other
 310     (upper_case_acronyms_aggressive: bool = false),
 311     /// Lint: _CARGO_COMMON_METADATA.
 312     ///
 313     /// For internal testing only, ignores the current `publish` settings in the Cargo manifest.
 314     (cargo_ignore_publish: bool = false),
 315     /// Lint: NONSTANDARD_MACRO_BRACES.
 316     ///
 317     /// Enforce the named macros always use the braces specified.
 318     ///
 319     /// A `MacroMatcher` can be added like so `{ name = "macro_name", brace = "(" }`. If the macro
 320     /// is could be used with a full path two `MacroMatcher`s have to be added one with the full path
 321     /// `crate_name::macro_name` and one with just the macro name.
 322     (standard_macro_braces: Vec<crate::nonstandard_macro_braces::MacroMatcher> = Vec::new()),
 323     /// Lint: MISSING_ENFORCED_IMPORT_RENAMES.
 324     ///
 325     /// The list of imports to always rename, a fully qualified path followed by the rename.
 326     (enforced_import_renames: Vec<crate::utils::conf::Rename> = Vec::new()),
 327     /// Lint: DISALLOWED_SCRIPT_IDENTS.
 328     ///
 329     /// The list of unicode scripts allowed to be used in the scope.
 330     (allowed_scripts: Vec<String> = ["Latin"].iter().map(ToString::to_string).collect()),
 331     /// Lint: NON_SEND_FIELDS_IN_SEND_TY.
 332     ///
 333     /// Whether to apply the raw pointer heuristic to determine if a type is `Send`.
 334     (enable_raw_pointer_heuristic_for_send: bool = true),
 335     /// Lint: INDEX_REFUTABLE_SLICE.
 336     ///
 337     /// When Clippy suggests using a slice pattern, this is the maximum number of elements allowed in
 338     /// the slice pattern that is suggested. If more elements would be necessary, the lint is suppressed.
 339     /// For example, `[_, _, _, e, ..]` is a slice pattern with 4 elements.
 340     (max_suggested_slice_pattern_length: u64 = 3),
 341     /// Lint: AWAIT_HOLDING_INVALID_TYPE
 342     (await_holding_invalid_types: Vec<crate::utils::conf::DisallowedType> = Vec::new()),
 343     /// Lint: LARGE_INCLUDE_FILE.
 344     ///
 345     /// The maximum size of a file included via `include_bytes!()` or `include_str!()`, in bytes
 346     (max_include_file_size: u64 = 1_000_000),
 347     /// Lint: EXPECT_USED.
 348     ///
 349     /// Whether `expect` should be allowed in test functions
 350     (allow_expect_in_tests: bool = false),
 351     /// Lint: UNWRAP_USED.
 352     ///
 353     /// Whether `unwrap` should be allowed in test functions
 354     (allow_unwrap_in_tests: bool = false),
 355     /// Lint: DBG_MACRO.
 356     ///
 357     /// Whether `dbg!` should be allowed in test functions
 358     (allow_dbg_in_tests: bool = false),
 359 }
 360
 361 /// Search for the configuration file.
 362 pub fn lookup_conf_file() -> io::Result<Option<PathBuf>> {
 363     /// Possible filename to search for.
 364     const CONFIG_FILE_NAMES: [&str; 2] = [".clippy.toml", "clippy.toml"];
 365
 366     // Start looking for a config file in CLIPPY_CONF_DIR, or failing that, CARGO_MANIFEST_DIR.
 367     // If neither of those exist, use ".".
 368     let mut current = env::var_os("CLIPPY_CONF_DIR")
 369         .or_else(|| env::var_os("CARGO_MANIFEST_DIR"))
 370         .map_or_else(|| PathBuf::from("."), PathBuf::from);
 371
 372     let mut found_config: Option<PathBuf> = None;
 373
 374     loop {
 375         for config_file_name in &CONFIG_FILE_NAMES {
 376             if let Ok(config_file) = current.join(config_file_name).canonicalize() {
 377                 match fs::metadata(&config_file) {
 378                     Err(e) if e.kind() == io::ErrorKind::NotFound => {},
 379                     Err(e) => return Err(e),
 380                     Ok(md) if md.is_dir() => {},
 381                     Ok(_) => {
 382                         // warn if we happen to find two config files #8323
 383                         if let Some(ref found_config_) = found_config {
 384                             eprintln!(
 385                                 "Using config file `{}`\nWarning: `{}` will be ignored.",
 386                                 found_config_.display(),
 387                                 config_file.display(),
 388                             );
 389                         } else {
 390                             found_config = Some(config_file);
 391                         }
 392                     },
 393                 }
 394             }
 395         }
 396
 397         if found_config.is_some() {
 398             return Ok(found_config);
 399         }
 400
 401         // If the current directory has no parent, we're done searching.
 402         if !current.pop() {
 403             return Ok(None);
 404         }
 405     }
 406 }
 407
 408 /// Read the `toml` configuration file.
 409 ///
 410 /// In case of error, the function tries to continue as much as possible.
 411 pub fn read(path: &Path) -> TryConf {
 412     let content = match fs::read_to_string(path) {
 413         Err(e) => return TryConf::from_error(e),
 414         Ok(content) => content,
 415     };
 416     match toml::from_str::<TryConf>(&content) {
 417         Ok(mut conf) => {
 418             extend_vec_if_indicator_present(&mut conf.conf.doc_valid_idents, DEFAULT_DOC_VALID_IDENTS);
 419             extend_vec_if_indicator_present(&mut conf.conf.blacklisted_names, DEFAULT_BLACKLISTED_NAMES);
 420
 421             conf
 422         },
 423         Err(e) => TryConf::from_error(e),
 424     }
 425 }
 426
 427 fn extend_vec_if_indicator_present(vec: &mut Vec<String>, default: &[&str]) {
 428     if vec.contains(&"..".to_string()) {
 429         vec.extend(default.iter().map(ToString::to_string));
 430     }
 431 }
 432
 433 const SEPARATOR_WIDTH: usize = 4;
 434
 435 // Check whether the error is "unknown field" and, if so, list the available fields sorted and at
 436 // least one per line, more if `CLIPPY_TERMINAL_WIDTH` is set and allows it.
 437 pub fn format_error(error: Box<dyn Error>) -> String {
 438     let s = error.to_string();
 439
 440     if_chain! {
 441         if error.downcast::<toml::de::Error>().is_ok();
 442         if let Some((prefix, mut fields, suffix)) = parse_unknown_field_message(&s);
 443         then {
 444             use fmt::Write;
 445
 446             fields.sort_unstable();
 447
 448             let (rows, column_widths) = calculate_dimensions(&fields);
 449
 450             let mut msg = String::from(prefix);
 451             for row in 0..rows {
 452                 write!(msg, "\n").unwrap();
 453                 for (column, column_width) in column_widths.iter().copied().enumerate() {
 454                     let index = column * rows + row;
 455                     let field = fields.get(index).copied().unwrap_or_default();
 456                     write!(
 457                         msg,
 458                         "{:separator_width$}{:field_width$}",
 459                         " ",
 460                         field,
 461                         separator_width = SEPARATOR_WIDTH,
 462                         field_width = column_width
 463                     )
 464                     .unwrap();
 465                 }
 466             }
 467             write!(msg, "\n{}", suffix).unwrap();
 468             msg
 469         } else {
 470             s
 471         }
 472     }
 473 }
 474
 475 // `parse_unknown_field_message` will become unnecessary if
 476 // https://github.com/alexcrichton/toml-rs/pull/364 is merged.
 477 fn parse_unknown_field_message(s: &str) -> Option<(&str, Vec<&str>, &str)> {
 478     // An "unknown field" message has the following form:
 479     //   unknown field `UNKNOWN`, expected one of `FIELD0`, `FIELD1`, ..., `FIELDN` at line X column Y
 480     //                                           ^^      ^^^^                     ^^
 481     if_chain! {
 482         if s.starts_with("unknown field");
 483         let slices = s.split("`, `").collect::<Vec<_>>();
 484         let n = slices.len();
 485         if n >= 2;
 486         if let Some((prefix, first_field)) = slices[0].rsplit_once(" `");
 487         if let Some((last_field, suffix)) = slices[n - 1].split_once("` ");
 488         then {
 489             let fields = iter::once(first_field)
 490                 .chain(slices[1..n - 1].iter().copied())
 491                 .chain(iter::once(last_field))
 492                 .collect::<Vec<_>>();
 493             Some((prefix, fields, suffix))
 494         } else {
 495             None
 496         }
 497     }
 498 }
 499
 500 fn calculate_dimensions(fields: &[&str]) -> (usize, Vec<usize>) {
 501     let columns = env::var("CLIPPY_TERMINAL_WIDTH")
 502         .ok()
 503         .and_then(|s| <usize as FromStr>::from_str(&s).ok())
 504         .map_or(1, |terminal_width| {
 505             let max_field_width = fields.iter().map(|field| field.len()).max().unwrap();
 506             cmp::max(1, terminal_width / (SEPARATOR_WIDTH + max_field_width))
 507         });
 508
 509     let rows = (fields.len() + (columns - 1)) / columns;
 510
 511     let column_widths = (0..columns)
 512         .map(|column| {
 513             if column < columns - 1 {
 514                 (0..rows)
 515                     .map(|row| {
 516                         let index = column * rows + row;
 517                         let field = fields.get(index).copied().unwrap_or_default();
 518                         field.len()
 519                     })
 520                     .max()
 521                     .unwrap()
 522             } else {
 523                 // Avoid adding extra space to the last column.
 524                 0
 525             }
 526         })
 527         .collect::<Vec<_>>();
 528
 529     (rows, column_widths)
 530 }