cmds: update GARDEN_CMD_VERBOSE and GARDEN_CMD_QUIET in sub-commands

"garden my-command -v" should behave the same as "garden -v my-command".
Repeat the variable initialization after the sub-commands have been
parsed to make the behavior match.

Author: davvid

doc/src/changelog.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## Upcoming
+
+**Features**:
+
+- `GARDEN_CMD_VERBOSE` and `GARDEN_CMD_QUIET` are now updated when using
+`garden <command> -v ...` and `garden cmd <command> -v ...`.
+Previously, these variables were only set when `-v` was used against the `garden`
+command directly, before any sub-commands; e.g. `garden -v ...`.
+
+
 ## v1.9.0
 
 *Released 2024-10-11*

src/cmds/cmd.rs

@@ -140,6 +140,9 @@ pub fn main_cmd(app_context: &model::ApplicationContext, options: &mut CmdOption
     app_context
         .get_root_config_mut()
         .apply_defines(&options.define);
+    app_context
+        .get_root_config_mut()
+        .update_quiet_and_verbose_variables(options.quiet, options.verbose);
     if app_context.options.debug_level(constants::DEBUG_LEVEL_CMD) > 0 {
         debug!("jobs: {:?}", options.num_jobs);
         debug!("query: {}", options.query);
@@ -275,6 +278,9 @@ pub fn main_custom(app_context: &model::ApplicationContext, arguments: &Vec<Stri
     app_context
         .get_root_config_mut()
         .apply_defines(&options.define);
+    app_context
+        .get_root_config_mut()
+        .update_quiet_and_verbose_variables(options.quiet, options.verbose);
     if !app_context.get_root_config().shell_exit_on_error {
         options.exit_on_error = false;
     }

src/config/reader.rs

@@ -139,21 +139,10 @@ fn parse_recursive(
     }
 
     // Provide GARDEN_CMD_QUIET and GARDEN_CMD_VERBOSE.
-    let quiet_string = if config.quiet { "--quiet" } else { "" }.to_string();
-    let verbose_string = if config.verbose > 0 {
-        // -v can be specified multiple times, e.g. "-vv".
-        format!("-{}", "v".repeat(config.verbose.into()))
-    } else {
-        string!("")
-    };
-    config.variables.insert(
-        string!(constants::GARDEN_CMD_QUIET),
-        model::Variable::new(quiet_string.clone(), Some(quiet_string)),
-    );
-    config.variables.insert(
-        string!(constants::GARDEN_CMD_VERBOSE),
-        model::Variable::new(verbose_string.clone(), Some(verbose_string)),
-    );
+    // When commands call update_quiet_and_verbose_variables() they are adding
+    // additional "-v" options beyond what has been parsed at this point.
+    // We use 0 here so that the config's verbosity level is maintained.
+    config.update_quiet_and_verbose_variables(config.quiet, 0);
 
     // Variables are read early to make them available to config.eval_config_pathbuf_from_include().
     // Variables are reloaded after "includes" to give the current garden file the highest priority.

src/model.rs

@@ -800,6 +800,26 @@ impl Configuration {
         }
     }
 
+    /// Apply the quiet and verbose options to resolve GARDEN_CMD_VERBOSE and GARDEN_CMD_QUIET.
+    pub(crate) fn update_quiet_and_verbose_variables(&mut self, quiet: bool, verbose: u8) {
+        // Provide GARDEN_CMD_QUIET and GARDEN_CMD_VERBOSE.
+        let quiet_string = if self.quiet || quiet { "--quiet" } else { "" }.to_string();
+        self.variables.insert(
+            string!(constants::GARDEN_CMD_QUIET),
+            Variable::new(quiet_string.clone(), Some(quiet_string)),
+        );
+        let verbose = self.verbose + verbose;
+        let verbose_string = if verbose > 0 {
+            format!("-{}", "v".repeat(verbose.into()))
+        } else {
+            string!("")
+        };
+        self.variables.insert(
+            string!(constants::GARDEN_CMD_VERBOSE),
+            Variable::new(verbose_string.clone(), Some(verbose_string)),
+        );
+    }
+
     pub(crate) fn reset(&mut self) {
         // Reset variables to allow for tree-scope evaluation
         self.reset_variables();

tests/data/garden.yaml

@@ -89,6 +89,9 @@ trees:
         do
             echo $arg
         done
+      echo-quiet-verbose: |
+        printf 'verbose=%s\n' "${GARDEN_CMD_VERBOSE}"
+        printf 'quiet=%s\n' "${GARDEN_CMD_QUIET}"
 
   example/shallow:
     path: example/tree/shallow

tests/integration_test.rs

@@ -760,6 +760,31 @@ fn eval_builtin_command_variables() {
     assert_eq!(output, expect);
 }
 
+/// `garden custom-command` handles ${GARDEN_CMD_QUIET} and ${GARDEN_CMD_VERBOSE}.
+#[test]
+fn eval_builtin_command_variables_in_subcommand() {
+    // garden echo-quiet-verbose -v
+    let output = garden_capture(&[
+        "--config",
+        "tests/data/garden.yaml",
+        "echo-quiet-verbose",
+        "-v",
+    ]);
+    let expect = "verbose=-v\nquiet=";
+    assert_eq!(output, expect);
+    // garden -v echo-quiet-verbose -v --quiet
+    let output = garden_capture(&[
+        "--verbose",
+        "--config",
+        "tests/data/garden.yaml",
+        "echo-quiet-verbose",
+        "--verbose",
+        "--quiet",
+    ]);
+    let expect = "verbose=-vv\nquiet=--quiet";
+    assert_eq!(output, expect);
+}
+
 /// `garden eval` evaluates overridden variables.
 #[test]
 fn eval_override_variables() {