clippy_lints/src/utils/conf.rs

   1 //! Read configurations files.
   2
   3 #![deny(clippy::missing_docs_in_private_items)]
   4
   5 use rustc_ast::ast::{LitKind, MetaItemKind, NestedMetaItem};
   6 use rustc_span::source_map;
   7 use source_map::Span;
   8 use std::lazy::SyncLazy;
   9 use std::path::{Path, PathBuf};
  10 use std::sync::Mutex;
  11 use std::{env, fmt, fs, io};
  12
  13 /// Gets the configuration file from arguments.
  14 pub fn file_from_args(args: &[NestedMetaItem]) -> Result<Option<PathBuf>, (&'static str, Span)> {
  15     for arg in args.iter().filter_map(NestedMetaItem::meta_item) {
  16         if arg.has_name(sym!(conf_file)) {
  17             return match arg.kind {
  18                 MetaItemKind::Word | MetaItemKind::List(_) => Err(("`conf_file` must be a named value", arg.span)),
  19                 MetaItemKind::NameValue(ref value) => {
  20                     if let LitKind::Str(ref file, _) = value.kind {
  21                         Ok(Some(file.to_string().into()))
  22                     } else {
  23                         Err(("`conf_file` value must be a string", value.span))
  24                     }
  25                 },
  26             };
  27         }
  28     }
  29
  30     Ok(None)
  31 }
  32
  33 /// Error from reading a configuration file.
  34 #[derive(Debug)]
  35 pub enum Error {
  36     /// An I/O error.
  37     Io(io::Error),
  38     /// Not valid toml or doesn't fit the expected config format
  39     Toml(String),
  40 }
  41
  42 impl fmt::Display for Error {
  43     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
  44         match self {
  45             Self::Io(err) => err.fmt(f),
  46             Self::Toml(err) => err.fmt(f),
  47         }
  48     }
  49 }
  50
  51 impl From<io::Error> for Error {
  52     fn from(e: io::Error) -> Self {
  53         Self::Io(e)
  54     }
  55 }
  56
  57 /// Vec of errors that might be collected during config toml parsing
  58 static ERRORS: SyncLazy<Mutex<Vec<Error>>> = SyncLazy::new(|| Mutex::new(Vec::new()));
  59
  60 macro_rules! define_Conf {
  61     ($(#[$doc:meta] ($config:ident, $config_str:literal: $Ty:ty, $default:expr),)+) => {
  62         mod helpers {
  63             use serde::Deserialize;
  64             /// Type used to store lint configuration.
  65             #[derive(Deserialize)]
  66             #[serde(rename_all = "kebab-case", deny_unknown_fields)]
  67             pub struct Conf {
  68                 $(
  69                     #[$doc]
  70                     #[serde(default = $config_str)]
  71                     #[serde(with = $config_str)]
  72                     pub $config: $Ty,
  73                 )+
  74                 #[allow(dead_code)]
  75                 #[serde(default)]
  76                 third_party: Option<::toml::Value>,
  77             }
  78
  79             $(
  80                 mod $config {
  81                     use serde::Deserialize;
  82                     pub fn deserialize<'de, D: serde::Deserializer<'de>>(deserializer: D) -> Result<$Ty, D::Error> {
  83                         use super::super::{ERRORS, Error};
  84
  85                         Ok(
  86                             <$Ty>::deserialize(deserializer).unwrap_or_else(|e| {
  87                                 ERRORS
  88                                     .lock()
  89                                     .expect("no threading here")
  90                                     .push(Error::Toml(e.to_string()));
  91                                 super::$config()
  92                             })
  93                         )
  94                     }
  95                 }
  96
  97                 #[must_use]
  98                 fn $config() -> $Ty {
  99                     let x = $default;
 100                     x
 101                 }
 102             )+
 103         }
 104     };
 105 }
 106
 107 pub use self::helpers::Conf;
 108 define_Conf! {
 109     /// Lint: MANUAL_NON_EXHAUSTIVE, MANUAL_STRIP, OPTION_AS_REF_DEREF, MATCH_LIKE_MATCHES_MACRO. The minimum rust version that the project supports
 110     (msrv, "msrv": Option<String>, None),
 111     /// Lint: BLACKLISTED_NAME. The list of blacklisted names to lint about. NB: `bar` is not here since it has legitimate uses
 112     (blacklisted_names, "blacklisted_names": Vec<String>, ["foo", "baz", "quux"].iter().map(ToString::to_string).collect()),
 113     /// Lint: COGNITIVE_COMPLEXITY. The maximum cognitive complexity a function can have
 114     (cognitive_complexity_threshold, "cognitive_complexity_threshold": u64, 25),
 115     /// DEPRECATED LINT: CYCLOMATIC_COMPLEXITY. Use the Cognitive Complexity lint instead.
 116     (cyclomatic_complexity_threshold, "cyclomatic_complexity_threshold": Option<u64>, None),
 117     /// Lint: DOC_MARKDOWN. The list of words this lint should not consider as identifiers needing ticks
 118     (doc_valid_idents, "doc_valid_idents": Vec<String>, [
 119         "KiB", "MiB", "GiB", "TiB", "PiB", "EiB",
 120         "DirectX",
 121         "ECMAScript",
 122         "GPLv2", "GPLv3",
 123         "GitHub", "GitLab",
 124         "IPv4", "IPv6",
 125         "ClojureScript", "CoffeeScript", "JavaScript", "PureScript", "TypeScript",
 126         "NaN", "NaNs",
 127         "OAuth", "GraphQL",
 128         "OCaml",
 129         "OpenGL", "OpenMP", "OpenSSH", "OpenSSL", "OpenStreetMap",
 130         "TensorFlow",
 131         "TrueType",
 132         "iOS", "macOS",
 133         "TeX", "LaTeX", "BibTeX", "BibLaTeX",
 134         "MinGW",
 135         "CamelCase",
 136     ].iter().map(ToString::to_string).collect()),
 137     /// Lint: TOO_MANY_ARGUMENTS. The maximum number of argument a function or method can have
 138     (too_many_arguments_threshold, "too_many_arguments_threshold": u64, 7),
 139     /// Lint: TYPE_COMPLEXITY. The maximum complexity a type can have
 140     (type_complexity_threshold, "type_complexity_threshold": u64, 250),
 141     /// Lint: MANY_SINGLE_CHAR_NAMES. The maximum number of single char bindings a scope may have
 142     (single_char_binding_names_threshold, "single_char_binding_names_threshold": u64, 4),
 143     /// Lint: BOXED_LOCAL, USELESS_VEC. The maximum size of objects (in bytes) that will be linted. Larger objects are ok on the heap
 144     (too_large_for_stack, "too_large_for_stack": u64, 200),
 145     /// Lint: ENUM_VARIANT_NAMES. The minimum number of enum variants for the lints about variant names to trigger
 146     (enum_variant_name_threshold, "enum_variant_name_threshold": u64, 3),
 147     /// Lint: LARGE_ENUM_VARIANT. The maximum size of a enum's variant to avoid box suggestion
 148     (enum_variant_size_threshold, "enum_variant_size_threshold": u64, 200),
 149     /// Lint: VERBOSE_BIT_MASK. The maximum allowed size of a bit mask before suggesting to use 'trailing_zeros'
 150     (verbose_bit_mask_threshold, "verbose_bit_mask_threshold": u64, 1),
 151     /// Lint: DECIMAL_LITERAL_REPRESENTATION. The lower bound for linting decimal literals
 152     (literal_representation_threshold, "literal_representation_threshold": u64, 16384),
 153     /// Lint: TRIVIALLY_COPY_PASS_BY_REF. The maximum size (in bytes) to consider a `Copy` type for passing by value instead of by reference.
 154     (trivial_copy_size_limit, "trivial_copy_size_limit": Option<u64>, None),
 155     /// Lint: LARGE_TYPE_PASS_BY_MOVE. The minimum size (in bytes) to consider a type for passing by reference instead of by value.
 156     (pass_by_value_size_limit, "pass_by_value_size_limit": u64, 256),
 157     /// Lint: TOO_MANY_LINES. The maximum number of lines a function or method can have
 158     (too_many_lines_threshold, "too_many_lines_threshold": u64, 100),
 159     /// Lint: LARGE_STACK_ARRAYS, LARGE_CONST_ARRAYS. The maximum allowed size for arrays on the stack
 160     (array_size_threshold, "array_size_threshold": u64, 512_000),
 161     /// Lint: VEC_BOX. The size of the boxed type in bytes, where boxing in a `Vec` is allowed
 162     (vec_box_size_threshold, "vec_box_size_threshold": u64, 4096),
 163     /// Lint: TYPE_REPETITION_IN_BOUNDS. The maximum number of bounds a trait can have to be linted
 164     (max_trait_bounds, "max_trait_bounds": u64, 3),
 165     /// Lint: STRUCT_EXCESSIVE_BOOLS. The maximum number of bools a struct can have
 166     (max_struct_bools, "max_struct_bools": u64, 3),
 167     /// Lint: FN_PARAMS_EXCESSIVE_BOOLS. The maximum number of bools function parameters can have
 168     (max_fn_params_bools, "max_fn_params_bools": u64, 3),
 169     /// Lint: WILDCARD_IMPORTS. Whether to allow certain wildcard imports (prelude, super in tests).
 170     (warn_on_all_wildcard_imports, "warn_on_all_wildcard_imports": bool, false),
 171     /// Lint: DISALLOWED_METHOD. The list of blacklisted methods to lint about. NB: `bar` is not here since it has legitimate uses
 172     (disallowed_methods, "disallowed_methods": Vec<String>, Vec::<String>::new()),
 173     /// Lint: UNREADABLE_LITERAL. Should the fraction of a decimal be linted to include separators.
 174     (unreadable_literal_lint_fractions, "unreadable_literal_lint_fractions": bool, true),
 175 }
 176
 177 impl Default for Conf {
 178     #[must_use]
 179     fn default() -> Self {
 180         toml::from_str("").expect("we never error on empty config files")
 181     }
 182 }
 183
 184 /// Search for the configuration file.
 185 pub fn lookup_conf_file() -> io::Result<Option<PathBuf>> {
 186     /// Possible filename to search for.
 187     const CONFIG_FILE_NAMES: [&str; 2] = [".clippy.toml", "clippy.toml"];
 188
 189     // Start looking for a config file in CLIPPY_CONF_DIR, or failing that, CARGO_MANIFEST_DIR.
 190     // If neither of those exist, use ".".
 191     let mut current = env::var_os("CLIPPY_CONF_DIR")
 192         .or_else(|| env::var_os("CARGO_MANIFEST_DIR"))
 193         .map_or_else(|| PathBuf::from("."), PathBuf::from);
 194     loop {
 195         for config_file_name in &CONFIG_FILE_NAMES {
 196             let config_file = current.join(config_file_name);
 197             match fs::metadata(&config_file) {
 198                 // Only return if it's a file to handle the unlikely situation of a directory named
 199                 // `clippy.toml`.
 200                 Ok(ref md) if !md.is_dir() => return Ok(Some(config_file)),
 201                 // Return the error if it's something other than `NotFound`; otherwise we didn't
 202                 // find the project file yet, and continue searching.
 203                 Err(e) if e.kind() != io::ErrorKind::NotFound => return Err(e),
 204                 _ => {},
 205             }
 206         }
 207
 208         // If the current directory has no parent, we're done searching.
 209         if !current.pop() {
 210             return Ok(None);
 211         }
 212     }
 213 }
 214
 215 /// Produces a `Conf` filled with the default values and forwards the errors
 216 ///
 217 /// Used internally for convenience
 218 fn default(errors: Vec<Error>) -> (Conf, Vec<Error>) {
 219     (Conf::default(), errors)
 220 }
 221
 222 /// Read the `toml` configuration file.
 223 ///
 224 /// In case of error, the function tries to continue as much as possible.
 225 pub fn read(path: &Path) -> (Conf, Vec<Error>) {
 226     let content = match fs::read_to_string(path) {
 227         Ok(content) => content,
 228         Err(err) => return default(vec![err.into()]),
 229     };
 230
 231     assert!(ERRORS.lock().expect("no threading -> mutex always safe").is_empty());
 232     match toml::from_str(&content) {
 233         Ok(toml) => {
 234             let mut errors = ERRORS.lock().expect("no threading -> mutex always safe").split_off(0);
 235
 236             let toml_ref: &Conf = &toml;
 237
 238             let cyc_field: Option<u64> = toml_ref.cyclomatic_complexity_threshold;
 239
 240             if cyc_field.is_some() {
 241                 let cyc_err = "found deprecated field `cyclomatic-complexity-threshold`. Please use `cognitive-complexity-threshold` instead.".to_string();
 242                 errors.push(Error::Toml(cyc_err));
 243             }
 244
 245             (toml, errors)
 246         },
 247         Err(e) => {
 248             let mut errors = ERRORS.lock().expect("no threading -> mutex always safe").split_off(0);
 249             errors.push(Error::Toml(e.to_string()));
 250
 251             default(errors)
 252         },
 253     }
 254 }