Merge pull request #41 from yuma140902/add-command-help

feat(help): add help message for subcommands
yuma140902 · Oct 15, 2023 · 2a2612c · 2a2612c
2 parents 1c4e200 + fe65ea5
commit 2a2612c
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -13,7 +13,7 @@ keywords = ["ssg", "templating", "web", "markdown"]
 
 [dependencies]
 anyhow = "1.0.75"
-clap = { version = "4.4.6", features = ["derive"] }
+clap = { version = "4.4.6", features = ["derive", "help"] }
 handlebars = "4.4.0"
 matter = "0.1.0-alpha4"
 once_cell = "1.18.0"

diff --git a/src/cli.rs b/src/cli.rs
@@ -3,18 +3,27 @@ use std::path::PathBuf;
 use clap::{Parser, Subcommand};
 
 #[derive(Parser, Debug)]
-#[command(author, version, about, long_about = None)]
+#[command(author, version, about, long_about = None, help_template = "\
+{before-help}{name} {version} 
+{tab}by {author}
+{about-with-newline}
+{usage-heading} {usage}
+
+{all-args}{after-help}
+")]
 pub struct Cli {
     #[command(subcommand)]
     pub command: Commands,
 }
 
 #[derive(Subcommand, Debug)]
 pub enum Commands {
+    /// Initializes a Tempura project
     Init {
         #[arg(default_value = ".")]
         directory: PathBuf,
     },
+    /// Builds website
     Build {
         #[arg(default_value = ".")]
         directory: PathBuf,