fix(CLI): Consistent ordering and color for help

stencila · Apr 5, 2021 · 71f4cd3 · 71f4cd3
1 parent c13824b
commit 71f4cd3
Show file tree

Hide file tree

Showing 5 changed files with 69 additions and 16 deletions.
diff --git a/rust/src/config.rs b/rust/src/config.rs
@@ -194,7 +194,8 @@ pub mod cli {
     #[derive(Debug, StructOpt)]
     #[structopt(
         about = "Manage configuration options",
-        setting = structopt::clap::AppSettings::ColoredHelp
+        setting = structopt::clap::AppSettings::ColoredHelp,
+        setting = structopt::clap::AppSettings::VersionlessSubcommands
     )]
     pub struct Args {
         #[structopt(subcommand)]
@@ -210,12 +211,18 @@ pub mod cli {
         Set(Set),
         Reset(Reset),
 
-        #[structopt(about = "Get the directories used for config, cache etc")]
+        #[structopt(
+            about = "Get the directories used for config, cache etc",
+            setting = structopt::clap::AppSettings::ColoredHelp
+        )]
         Dirs,
     }
 
     #[derive(Debug, StructOpt)]
-    #[structopt(about = "Get configuration properties")]
+    #[structopt(
+        about = "Get configuration properties",
+        setting = structopt::clap::AppSettings::ColoredHelp
+    )]
     pub struct Get {
         /// A pointer to a config property e.g. `upgrade.auto`
         pub pointer: Option<String>,
@@ -224,8 +231,7 @@ pub mod cli {
     #[derive(Debug, StructOpt)]
     #[structopt(
         about = "Set configuration properties",
-        setting = structopt::clap::AppSettings::TrailingVarArg,
-        setting = structopt::clap::AppSettings::AllowLeadingHyphen
+        setting = structopt::clap::AppSettings::ColoredHelp
     )]
     pub struct Set {
         /// A pointer to a config property e.g. `upgrade.auto`
@@ -236,7 +242,10 @@ pub mod cli {
     }
 
     #[derive(Debug, StructOpt)]
-    #[structopt(about = "Reset configuration properties to their defaults")]
+    #[structopt(
+        about = "Reset configuration properties to their defaults",
+        setting = structopt::clap::AppSettings::ColoredHelp
+    )]
     pub struct Reset {
         /// The config property to reset. Use 'all' to reset the entire config.
         pub property: String,

diff --git a/rust/src/convert.rs b/rust/src/convert.rs
@@ -47,19 +47,25 @@ pub mod cli {
     #[derive(Debug, StructOpt)]
     #[structopt(
         about = "Convert a document from one format to another",
+        setting = structopt::clap::AppSettings::DeriveDisplayOrder,
         setting = structopt::clap::AppSettings::ColoredHelp
     )]
     pub struct Args {
+        /// The input file or URL to convert from
         input: String,
 
+        /// The output file to convert to
         output: String,
 
+        /// The format of the input (defaults to being inferred from the file extension or content type)
         #[structopt(short, long)]
         from: Option<String>,
 
+        /// The format of the output (defaults to being inferred from the file extension)
         #[structopt(short, long)]
         to: Option<String>,
 
+        /// Watch for changes in the input and redo conversion automatically (if input is local file)
         #[structopt(short, long)]
         watch: bool,
     }

diff --git a/rust/src/plugins.rs b/rust/src/plugins.rs
@@ -762,7 +762,8 @@ pub mod cli {
     #[derive(Debug, StructOpt)]
     #[structopt(
         about = "Manage plugins",
-        setting = structopt::clap::AppSettings::ColoredHelp
+        setting = structopt::clap::AppSettings::ColoredHelp,
+        setting = structopt::clap::AppSettings::VersionlessSubcommands
     )]
     pub struct Args {
         #[structopt(subcommand)]
@@ -774,7 +775,10 @@ pub mod cli {
         setting = structopt::clap::AppSettings::DeriveDisplayOrder
     )]
     pub enum Action {
-        #[structopt(about = "List installed plugins")]
+        #[structopt(
+            about = "List installed plugins",
+            setting = structopt::clap::AppSettings::ColoredHelp
+        )]
         List,
         Show(Show),
         Install(Install),
@@ -787,7 +791,11 @@ pub mod cli {
     }
 
     #[derive(Debug, StructOpt)]
-    #[structopt(about = "Show the details of an installed plugin")]
+    #[structopt(
+        about = "Show the details of an installed plugin",
+        setting = structopt::clap::AppSettings::DeriveDisplayOrder,
+        setting = structopt::clap::AppSettings::ColoredHelp
+    )]
     pub struct Show {
         /// The name of the plugin to show
         #[structopt()]
@@ -799,7 +807,11 @@ pub mod cli {
     }
 
     #[derive(Debug, StructOpt)]
-    #[structopt(about = "Install one or more plugins")]
+    #[structopt(
+        about = "Install one or more plugins",
+        setting = structopt::clap::AppSettings::DeriveDisplayOrder,
+        setting = structopt::clap::AppSettings::ColoredHelp
+    )]
     pub struct Install {
         /// Attempt to add plugins as Docker image
         #[structopt(short, long)]
@@ -819,15 +831,23 @@ pub mod cli {
     }
 
     #[derive(Debug, StructOpt)]
-    #[structopt(about = "Link to a local plugins")]
+    #[structopt(
+        about = "Link to a local plugins",
+        setting = structopt::clap::AppSettings::DeriveDisplayOrder,
+        setting = structopt::clap::AppSettings::ColoredHelp
+    )]
     pub struct Link {
         /// The path of a plugin directory
         #[structopt()]
         pub path: String,
     }
 
     #[derive(Debug, StructOpt)]
-    #[structopt(about = "Upgrade one of more plugins")]
+    #[structopt(
+        about = "Upgrade one of more plugins",
+        setting = structopt::clap::AppSettings::DeriveDisplayOrder,
+        setting = structopt::clap::AppSettings::ColoredHelp
+    )]
     pub struct Upgrade {
         /// The names or aliases of plugins to upgrade
         /// (omit to upgrade all plugins)
@@ -836,23 +856,35 @@ pub mod cli {
     }
 
     #[derive(Debug, StructOpt)]
-    #[structopt(about = "Uninstall one or more plugins")]
+    #[structopt(
+        about = "Uninstall one or more plugins",
+        setting = structopt::clap::AppSettings::DeriveDisplayOrder,
+        setting = structopt::clap::AppSettings::ColoredHelp
+    )]
     pub struct Uninstall {
         /// The names or aliases of plugins to uninstall
         #[structopt(required = true, multiple = true)]
         pub plugins: Vec<String>,
     }
 
     #[derive(Debug, StructOpt)]
-    #[structopt(about = "Unlink a local plugins")]
+    #[structopt(
+        about = "Unlink a local plugins",
+        setting = structopt::clap::AppSettings::DeriveDisplayOrder,
+        setting = structopt::clap::AppSettings::ColoredHelp
+    )]
     pub struct Unlink {
         /// The name of the plugin to unlink
         #[structopt()]
         pub plugin: String,
     }
 
     #[derive(Debug, StructOpt)]
-    #[structopt(about = "List methods and the plugins that implement them")]
+    #[structopt(
+        about = "List methods and the plugins that implement them",
+        setting = structopt::clap::AppSettings::DeriveDisplayOrder,
+        setting = structopt::clap::AppSettings::ColoredHelp
+    )]
     pub struct Methods {
         /// The name of the method to display
         #[structopt()]
@@ -864,7 +896,11 @@ pub mod cli {
     }
 
     #[derive(Debug, StructOpt)]
-    #[structopt(about = "Delegate a method call to any, or a particular, plugin")]
+    #[structopt(
+        about = "Delegate a method call to any, or a particular, plugin",
+        setting = structopt::clap::AppSettings::DeriveDisplayOrder,
+        setting = structopt::clap::AppSettings::ColoredHelp
+    )]
     pub struct Delegate {
         /// The method to call
         #[structopt()]

diff --git a/rust/src/serve.rs b/rust/src/serve.rs
@@ -517,6 +517,7 @@ pub mod cli {
     #[derive(Debug, StructOpt)]
     #[structopt(
         about = "Serve on HTTP, WebSockets, or Standard I/O",
+        setting = structopt::clap::AppSettings::DeriveDisplayOrder,
         setting = structopt::clap::AppSettings::ColoredHelp
     )]
     pub struct Args {

diff --git a/rust/src/upgrade.rs b/rust/src/upgrade.rs
@@ -158,6 +158,7 @@ pub mod cli {
     #[derive(Debug, StructOpt)]
     #[structopt(
         about = "Upgrade to the latest (or other) version",
+        setting = structopt::clap::AppSettings::DeriveDisplayOrder,
         setting = structopt::clap::AppSettings::ColoredHelp
     )]
     pub struct Args {