Optionally add paw support for structopt as a feature (#192)

gameldar · TeXitoi · commit 2b0506e8ebb2 · 2019-06-26T19:49:05.000+02:00
This adds a feature that can be turned on that will include the
ParseArgs impl when generating the struct and enums
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+# v0.2.18 (2019-06-26)
+
+* Add optional feature to support `paw` by [@gameldar](https://github.com/gameldar)
+  ([#187](https://github.com/TeXitoi/structopt/issues/187))
+
 # v0.2.16 (2019-05-29)
 
 * Support `Option<Option<T>>` type for fields by [@sphynx](https://github.com/sphynx)
diff --git a/Cargo.toml b/Cargo.toml
@@ -21,6 +21,7 @@ lints = ["clap/lints"]
 debug = ["clap/debug"]
 no_cargo = ["clap/no_cargo"]
 doc = ["clap/doc"]
+paw = ["structopt-derive/paw"]
 
 [badges]
 travis-ci = { repository = "TeXitoi/structopt" }
diff --git a/src/lib.rs b/src/lib.rs
@@ -21,6 +21,18 @@
 //! structopt = { version = "0.2", default-features = false }
 //! ```
 //!
+//!
+//! Support for [`paw`](https://github.com/rust-cli/paw) (the
+//! `Command line argument paw-rser abstraction for main`) is disabled
+//! by default, but can be enabled in the `structopt` dependency
+//! with the feature `paw`:
+//!
+//! ```toml
+//! [dependencies]
+//! structopt = { version = "0.2", features = [ "paw" ] }
+//! paw = "1.0"
+//! ```
+//!
 //! ## How to `derive(StructOpt)`
 //!
 //! First, let's look at an example:
diff --git a/structopt-derive/Cargo.toml b/structopt-derive/Cargo.toml
@@ -20,6 +20,7 @@ heck = "^0.3.0"
 
 [features]
 nightly = ["proc-macro2/nightly"]
+paw = []
 
 [lib]
 proc-macro = true
diff --git a/structopt-derive/src/lib.rs b/structopt-derive/src/lib.rs
@@ -421,6 +421,23 @@ fn gen_from_subcommand(
     }
 }
 
+#[cfg(feature = "paw")]
+fn gen_paw_impl(name: &Ident) -> TokenStream {
+    quote! {
+        impl paw::ParseArgs for #name {
+            type Error = std::io::Error;
+
+            fn parse_args() -> Result<Self, Self::Error> {
+                Ok(<#name as ::structopt::StructOpt>::from_args())
+            }
+        }
+    }
+}
+#[cfg(not(feature = "paw"))]
+fn gen_paw_impl(_: &Ident) -> TokenStream {
+    TokenStream::new()
+}
+
 fn impl_structopt_for_struct(
     name: &Ident,
     fields: &Punctuated<Field, Comma>,
@@ -429,6 +446,7 @@ fn impl_structopt_for_struct(
     let basic_clap_app_gen = gen_clap_struct(attrs);
     let augment_clap = gen_augment_clap(fields, &basic_clap_app_gen.attrs);
     let from_clap = gen_from_clap(name, fields, &basic_clap_app_gen.attrs);
+    let paw_impl = gen_paw_impl(name);
 
     let clap_tokens = basic_clap_app_gen.tokens;
     quote! {
@@ -444,6 +462,8 @@ fn impl_structopt_for_struct(
             #augment_clap
             pub fn is_subcommand() -> bool { false }
         }
+
+        #paw_impl
     }
 }
 
@@ -457,6 +477,7 @@ fn impl_structopt_for_enum(
     let augment_clap = gen_augment_clap_enum(variants, &basic_clap_app_gen.attrs);
     let from_clap = gen_from_clap_enum(name);
     let from_subcommand = gen_from_subcommand(name, variants, &basic_clap_app_gen.attrs);
+    let paw_impl = gen_paw_impl(name);
 
     let clap_tokens = basic_clap_app_gen.tokens;
     quote! {
@@ -472,6 +493,8 @@ fn impl_structopt_for_enum(
             #from_subcommand
             pub fn is_subcommand() -> bool { true }
         }
+
+        #paw_impl
     }
 }
 
