Allow config to set level (#46)

Author: spenserblack

src/cli.rs

@@ -24,6 +24,12 @@ pub struct Cli {
     #[arg(short = 'L', long)]
     pub level: Option<usize>,
 
+    /// Force this tool to have no upper limit for level.
+    ///
+    /// Useful for overriding a level set by the configuration file.
+    #[arg(long, alias = "unset-level", conflicts_with = "level")]
+    pub max_level: bool,
+
     /// Edit the main configuration file and exit.
     #[arg(long, num_args = 0..=1, default_missing_value = "config")]
     pub edit_config: Option<EditConfig>,
@@ -105,6 +111,8 @@ impl Cli {
 
         if let Some(level) = self.level {
             builder = builder.max_level(level);
+        } else if self.max_level {
+            builder = builder.unset_level();
         }
 
         let tree = builder.build();

src/config/main/config.lua

@@ -13,4 +13,8 @@ return {
   ---@type Sorting|nil
   -- When this is nil, the default sorting algorithm will be used.
   sorting = nil,
+  ---@type integer|nil
+  -- When this is not nil, it will set how many levels deep this tool should search in
+  -- the directory tree.
+  level = nil,
 }

src/config/main/mod.rs

@@ -24,6 +24,8 @@ pub struct Main {
     skip: Option<mlua::Function>,
     /// Determines how to sort files in a directory.
     sorting: Sorting,
+    /// How many levels deep to search before stopping.
+    level: Option<usize>,
 }
 
 impl Main {
@@ -81,6 +83,11 @@ impl Main {
             1.. => Ordering::Greater,
         }
     }
+
+    /// How many levels deep to search before stopping.
+    pub fn level(&self) -> Option<usize> {
+        self.level
+    }
 }
 
 impl Default for Main {
@@ -89,6 +96,7 @@ impl Default for Main {
             color: Default::default(),
             skip: None,
             sorting: Self::default_sorting(),
+            level: None,
         }
     }
 }
@@ -116,10 +124,12 @@ impl FromLua for Main {
         let sorting = table
             .get::<Option<Sorting>>("sorting")?
             .unwrap_or_else(Self::default_sorting);
+        let level = table.get("level")?;
         let main = Main {
             color,
             skip,
             sorting,
+            level,
         };
         Ok(main)
     }

src/tree/builder.rs

@@ -14,6 +14,8 @@ pub struct Builder<'git, 'charset, P: AsRef<Path>> {
     color_choice: Option<ColorChoice>,
     charset: Option<Charset<'charset>>,
     max_level: Option<usize>,
+    /// Override the level limit that may be set by the configuration.
+    unset_level: bool,
     config: Option<config::Main>,
     icons: Option<config::Icons>,
     colors: Option<config::Colors>,
@@ -30,6 +32,7 @@ where
             root,
             git: None,
             max_level: None,
+            unset_level: false,
             charset: None,
             color_choice: None,
             config: None,
@@ -58,6 +61,19 @@ where
         }
     }
 
+    /// Unsets the maximum depth level for the [`Tree`], returning to the default
+    /// behavior of searching infinitely deep.
+    ///
+    /// This helps override a maximum level that may have been set by the configuration.
+    #[inline]
+    #[must_use]
+    pub fn unset_level(self) -> Self {
+        Self {
+            unset_level: true,
+            ..self
+        }
+    }
+
     /// Sets the [`Charset`] for the [`Tree`].
     #[inline]
     #[must_use]
@@ -110,11 +126,25 @@ where
     }
 
     /// Creates the [`Tree`].
+    ///
+    /// # Panics
+    ///
+    /// - Panics if `max_level` and `unset_level` were both called.
     pub fn build(self) -> Tree<'git, 'charset, P> {
+        assert!(
+            !(self.unset_level && self.max_level.is_some()),
+            "max_level cannot be set when unset_level is true"
+        );
+        let max_level = if self.unset_level {
+            None
+        } else {
+            self.max_level
+                .or(self.config.as_ref().and_then(|config| config.level()))
+        };
         Tree {
             root: self.root,
             git: self.git,
-            max_level: self.max_level,
+            max_level,
             charset: self.charset.unwrap_or_default(),
             color_choice: self.color_choice,
             config: self.config.unwrap_or_default(),
@@ -123,3 +153,14 @@ where
         }
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    #[should_panic]
+    fn test_cannot_build_unset_level_with_max_level() {
+        Builder::new(".").max_level(1).unset_level().build();
+    }
+}