Merge pull request #3751 from mulkieran/make-unsupported-cmds-invisib…

…le-in-help Show only officially supported commands in help text
stratis-storage · Jan 31, 2025 · 2fdcc07 · 2fdcc07
2 parents fe19def + fecba7d
commit 2fdcc07
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 2 deletions.
diff --git a/src/bin/stratisd-tools.rs b/src/bin/stratisd-tools.rs
@@ -50,9 +50,22 @@ fn main() {
                 Arg::new("executable")
                     .required(true)
                     .value_name("EXECUTABLE")
-                    .value_parser(cmds().iter().map(|x| x.name()).collect::<Vec<_>>()),
+                    .value_parser(cmds().iter().map(|x| x.name()).collect::<Vec<_>>())
+                    .hide_possible_values(true),
             )
-            .arg_required_else_help(true);
+            .arg_required_else_help(true)
+            .after_help(format!(
+                "Executables:\n{}",
+                cmds()
+                    .iter()
+                    .filter_map(|x| if x.show_in_after_help() {
+                        Some(format!("* {}", x.name()))
+                    } else {
+                        None
+                    })
+                    .collect::<Vec<_>>()
+                    .join("\n")
+            ));
 
         let truncated_args = if args.len() > 1 {
             vec![argv1, &args[1]]

diff --git a/src/bin/tools/cmds.rs b/src/bin/tools/cmds.rs
@@ -13,6 +13,7 @@ use stratisd::stratis::VERSION;
 pub trait ToolCommand<'a> {
     fn name(&self) -> &'a str;
     fn run(&self, command_line_args: Vec<String>) -> Result<(), String>;
+    fn show_in_after_help(&self) -> bool;
 }
 
 struct StratisDumpMetadata;
@@ -68,6 +69,10 @@ impl<'a> ToolCommand<'a> for StratisDumpMetadata {
                 .unwrap_or(false),
         )
     }
+
+    fn show_in_after_help(&self) -> bool {
+        true
+    }
 }
 
 struct StratisCheckMetadata;
@@ -100,6 +105,10 @@ impl<'a> ToolCommand<'a> for StratisCheckMetadata {
 
         check_metadata::run(infile, false)
     }
+
+    fn show_in_after_help(&self) -> bool {
+        false
+    }
 }
 
 struct StratisPrintMetadata;
@@ -132,6 +141,10 @@ impl<'a> ToolCommand<'a> for StratisPrintMetadata {
 
         check_metadata::run(infile, true)
     }
+
+    fn show_in_after_help(&self) -> bool {
+        false
+    }
 }
 
 pub fn cmds<'a>() -> Vec<Box<dyn ToolCommand<'a>>> {