chore: add passthrough of verbatim_doc_comment attribute to clap

near-cli-rs · Jan 6, 2025 · 912744d · 912744d
1 parent e02529d
commit 912744d
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 1 deletion.
diff --git a/examples/struct_with_subargs.rs b/examples/struct_with_subargs.rs
@@ -16,6 +16,7 @@ struct Account {
     /// than just the headline
     #[interactive_clap(long)]
     #[interactive_clap(skip_interactive_input)]
+    #[interactive_clap(verbatim_doc_comment)]
     social_db_folder: Option<String>,
     /// Sender account
     #[interactive_clap(subargs)]

diff --git a/interactive-clap-derive/src/derives/interactive_clap/mod.rs b/interactive-clap-derive/src/derives/interactive_clap/mod.rs
@@ -6,7 +6,7 @@ use proc_macro_error::abort_call_site;
 use quote::{quote, ToTokens};
 use syn;
 
-use crate::LONG_VEC_MUTLIPLE_OPT;
+use crate::{LONG_VEC_MUTLIPLE_OPT, VERBATIM_DOC_COMMENT};
 
 pub(crate) mod methods;
 
@@ -47,6 +47,7 @@ pub fn impl_interactive_clap(ast: &syn::DeriveInput) -> TokenStream {
                                             || group_string.contains("long")
                                             || (group_string == *"skip")
                                             || (group_string == *"flatten")
+                                            || (group_string == VERBATIM_DOC_COMMENT)
                                         {
                                             if group_string != LONG_VEC_MUTLIPLE_OPT {
                                                 clap_attr_vec.push(group.stream())

diff --git a/interactive-clap-derive/src/lib.rs b/interactive-clap-derive/src/lib.rs
@@ -19,6 +19,11 @@ mod tests;
 /// implies `#[interactive_clap(skip_interactive_input)]`, as it's not intended for interactive input
 pub(crate) const LONG_VEC_MUTLIPLE_OPT: &str = "long_vec_multiple_opt";
 
+/// `#[interactive_clap(...)]` attribute which translates 1-to-1 into
+/// `#[clap(verbatim_doc_comment)]`
+/// More info on https://docs.rs/clap/4.5.23/clap/_derive/index.html#command-attributes
+pub(crate) const VERBATIM_DOC_COMMENT: &str = "verbatim_doc_comment";
+
 #[proc_macro_derive(InteractiveClap, attributes(interactive_clap))]
 #[proc_macro_error]
 pub fn interactive_clap(input: TokenStream) -> TokenStream {

diff --git a/...snapshots/interactive_clap_derive__tests__test_simple_struct__doc_comments_propagate.snap b/...snapshots/interactive_clap_derive__tests__test_simple_struct__doc_comments_propagate.snap
@@ -14,6 +14,7 @@ pub struct CliArgs {
     ///
     /// a longer paragraph, describing the usage and stuff with second field's
     /// awareness of its possible applications
+    #[clap(verbatim_doc_comment)]
     pub second_field: Option<<String as interactive_clap::ToCli>::CliVariant>,
 }
 impl interactive_clap::ToCli for Args {