feat(config): add enforce-all flag (#44)

Author: beeb

.env.example

@@ -5,6 +5,7 @@ LINTSPEC_CONSTRUCTOR=false           # enforce that constructors have natspec
 LINTSPEC_STRUCT_PARAMS=false         # enforce that structs have `@param` for each member
 LINTSPEC_ENUM_PARAMS=false           # enforce that enums have `@param` for each variant
 LINTSPEC_ENFORCE=[variable,struct]   # enforce NatSpec on items even if they don't have params/returns/members
+LINTSPEC_ENFORCE_ALL=true            # same as passing all possible values to `enforce`. Remove if using LINTSPEC_ENFORCE.
 LINTSPEC_JSON=false                  # output diagnostics as JSON
 LINTSPEC_COMPACT=false               # compact output (minified JSON or compact text)
 LINTSPEC_SORT=false                  # sort results by file path

.lintspec.toml

@@ -7,6 +7,7 @@ struct_params = false # enforce that structs have `@param` for each member
 enum_params = false   # enforce that enums have `@param` for each variant
 # enforce NatSpec on items even if they don't have params/returns/members. Possible values: constructor, enum, error, event, function, modifier, struct, variable
 enforce = ["variable", "struct"]
+enforce_all = true               # same as passing all possible values to `enforce`. Remove if using `enforce`.
 json = false                     # output diagnostics as JSON
 compact = false                  # compact output (minified JSON or compact text)
 sort = false                     # sort results by file path

README.md

@@ -76,6 +76,7 @@ Options:
       --enum-params        Enforce that enums have `@param` for each variant
   -f, --enforce <TYPE>     Enforce NatSpec on items even if they don't have params/returns/members (can be used more than once)
                            [possible values: constructor, enum, error, event, function, modifier, struct, variable]
+      --enforce-all        Enforce NatSpec for all item types, even if they don't have params/returns/members
       --json               Output diagnostics in JSON format
       --compact            Compact output
       --sort               Sort the results by file path

src/config.rs

@@ -1,7 +1,7 @@
 use std::path::PathBuf;
 
 use anyhow::Result;
-use clap::Parser;
+use clap::{Parser, ValueEnum};
 use figment::{
     providers::{Env, Format as _, Serialized, Toml},
     Figment,
@@ -56,11 +56,20 @@ pub struct Args {
     #[arg(long, num_args = 0..=1, default_missing_value = "true")]
     pub enum_params: Option<bool>,
 
-    /// Enforce NatSpec (@dev, @notice) on items even if they don't have params/returns/members
+    /// Enforce NatSpec on items even if they don't have params/returns/members
     /// (can be used more than once)
+    ///
+    /// To enforce for all types, you can use `--enforce-all`.
     #[arg(short = 'f', long, name = "TYPE")]
     pub enforce: Vec<ItemType>,
 
+    /// Enforce NatSpec for all item types, even if they don't have params/returns/members
+    ///
+    /// Setting this option overrides any previously set `--enforce` arguments.
+    /// Can be set with `--enforce-all` (means true), `--enforce-all true` or `--enforce-all false`.
+    #[arg(long, num_args = 0..=1, default_missing_value = "true")]
+    pub enforce_all: Option<bool>,
+
     /// Output diagnostics in JSON format
     ///
     /// Can be set with `--json` (means true), `--json true` or `--json false`.
@@ -129,6 +138,7 @@ pub fn read_config() -> Result<Config> {
             struct_params: None,
             enum_params: None,
             enforce: args.enforce,
+            enforce_all: None,
             json: None,
             compact: None,
             sort: None,
@@ -151,6 +161,22 @@ pub fn read_config() -> Result<Config> {
     if let Some(enum_params) = args.enum_params {
         temp.enum_params = Some(enum_params);
     }
+    // first look if enforce_all was set in a config file or env variable
+    if let Some(enforce_all) = temp.enforce_all {
+        if enforce_all {
+            temp.enforce = ItemType::value_variants().into();
+        } else {
+            temp.enforce = vec![];
+        }
+    }
+    // then look if it was set in the CLI args
+    if let Some(enforce_all) = args.enforce_all {
+        if enforce_all {
+            temp.enforce = ItemType::value_variants().into();
+        } else {
+            temp.enforce = vec![];
+        }
+    }
     if let Some(json) = args.json {
         temp.json = Some(json);
     }