feat(markdown docs): add aliases to options

Move `cargo md-gen` to an ignored test. This allows moving clap-markdown to dev-dependency allowing the use of a fork and removing an unneeded dependency since the markdown generation is pre-release.

Author: willemneal

.cargo-husky/hooks/pre-commit

@@ -5,5 +5,5 @@ set -e
 echo '+cargo fmt --check'
 cargo fmt --check || (cargo fmt && exit 1)
 
-echo '+cargo run --bin doc-gen --features clap-markdown'
-cargo run --bin doc-gen --features clap-markdown
+echo '+cargo md-gen'
+cargo md-gen

.cargo-husky/hooks/pre-push

@@ -16,5 +16,5 @@ echo '+cargo test --all'
 cargo build
 cargo test --all || (echo "might need to rebuild make build-snapshot" && exit 1)
 
-echo '+cargo run --bin doc-gen --features clap-markdown'
-cargo run --bin doc-gen --features clap-markdown
+echo '+cargo md-gen'
+cargo md-gen

.cargo/config.toml

@@ -2,7 +2,7 @@
 
 [alias] # command aliases
 f = "fmt"
-md-gen = "run --bin doc-gen --features clap-markdown"
+md-gen = "test --package soroban-cli --lib -- test::md_gen --exact --ignored"
 s = "run --quiet --"
 # b = "build"
 # c = "check"

Cargo.lock

@@ -24,11 +24,6 @@ path = "src/bin/soroban.rs"
 pkg-url = "{ repo }/releases/download/v{ version }/{ name }-{ version }-{ target }{ archive-suffix }"
 bin-dir = "{ bin }{ binary-ext }"
 
-[[bin]]
-name = "doc-gen"
-path = "src/bin/doc-gen.rs"
-required-features = ["clap-markdown"]
-
 [lib]
 name = "soroban_cli"
 path = "src/lib.rs"
@@ -91,7 +86,6 @@ itertools = "0.10.5"
 shlex = "1.1.0"
 sep5 = { workspace = true }
 ethnum = { workspace = true }
-clap-markdown = { version = "0.1.4", optional = true }
 which = { workspace = true, features = ["regex"] }
 strsim = "0.11.1"
 heck = "0.5.0"
@@ -137,3 +131,4 @@ assert_fs = "1.0.7"
 predicates = { workspace = true }
 walkdir = "2.5.0"
 mockito = "1.5.0"
+clap-markdown = { version = "0.1.4", git = "https://github.com/ahalabs/clap-markdown", branch = "feat/add_visible_aliases" }

FULL_HELP_DOCS.md

@@ -63,3 +63,36 @@ where
 pub trait Pwd {
     fn set_pwd(&mut self, pwd: &Path);
 }
+
+#[cfg(test)]
+mod test {
+    use std::path::{Path, PathBuf};
+
+    #[test]
+    #[ignore]
+    fn md_gen() {
+        doc_gen().unwrap();
+    }
+
+    fn doc_gen() -> std::io::Result<()> {
+        let out_dir = project_root();
+        let options = clap_markdown::MarkdownOptions::new()
+            .show_footer(false)
+            .show_table_of_contents(false)
+            .title("Stellar CLI Manual".to_string());
+
+        let content = clap_markdown::help_markdown_custom::<super::Root>(&options);
+
+        std::fs::write(out_dir.join("FULL_HELP_DOCS.md"), content)?;
+
+        Ok(())
+    }
+
+    fn project_root() -> PathBuf {
+        Path::new(&env!("CARGO_MANIFEST_DIR"))
+            .ancestors()
+            .nth(2)
+            .unwrap()
+            .to_path_buf()
+    }
+}