mirror of
https://github.com/clap-rs/clap
synced 2024-12-12 13:52:34 +00:00
feat(derive): Don't abort when non-unit variant is skipped
This commit is contained in:
parent
ee3d12ec56
commit
fb4755d1c3
4 changed files with 42 additions and 14 deletions
|
@ -15,11 +15,11 @@ use crate::{
|
|||
};
|
||||
|
||||
use proc_macro2::{Span, TokenStream};
|
||||
use proc_macro_error::abort_call_site;
|
||||
use proc_macro_error::{abort, abort_call_site};
|
||||
use quote::quote;
|
||||
use syn::{
|
||||
punctuated::Punctuated, token::Comma, Attribute, Data, DataEnum, DeriveInput, Fields, Ident,
|
||||
Variant,
|
||||
punctuated::Punctuated, spanned::Spanned, token::Comma, Attribute, Data, DataEnum, DeriveInput,
|
||||
Fields, Ident, Variant,
|
||||
};
|
||||
|
||||
pub fn derive_arg_enum(input: &DeriveInput) -> TokenStream {
|
||||
|
@ -34,10 +34,6 @@ pub fn derive_arg_enum(input: &DeriveInput) -> TokenStream {
|
|||
}
|
||||
|
||||
pub fn gen_for_enum(name: &Ident, attrs: &[Attribute], e: &DataEnum) -> TokenStream {
|
||||
if !e.variants.iter().all(|v| matches!(v.fields, Fields::Unit)) {
|
||||
abort_call_site!("`#[derive(ArgEnum)]` only supports non-unit variants");
|
||||
};
|
||||
|
||||
let attrs = Attrs::from_struct(
|
||||
Span::call_site(),
|
||||
attrs,
|
||||
|
@ -86,6 +82,9 @@ fn lits(
|
|||
if let Kind::Skip(_) = &*attrs.kind() {
|
||||
None
|
||||
} else {
|
||||
if !matches!(variant.fields, Fields::Unit) {
|
||||
abort!(variant.span(), "`#[derive(ArgEnum)]` only supports non-unit variants, unless they are skipped");
|
||||
}
|
||||
let fields = attrs.field_methods(false);
|
||||
let name = attrs.cased_name();
|
||||
Some((
|
||||
|
|
|
@ -82,7 +82,7 @@ fn main() {
|
|||
- `Subcommand` defines available subcommands.
|
||||
- Subcommand arguments can be defined in a struct-variant or automatically flattened with a tuple-variant.
|
||||
- `ArgEnum` allows parsing a value directly into an `enum`, erroring on unsupported values.
|
||||
- The derive doesn't work on enums that contain non-unit variants
|
||||
- The derive doesn't work on enums that contain non-unit variants, unless they are skipped
|
||||
|
||||
See also the [tutorial](../tutorial_derive/README.md) and [examples](../README.md).
|
||||
|
||||
|
|
|
@ -321,6 +321,37 @@ fn skip_variant() {
|
|||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn skip_non_unit_variant() {
|
||||
#[derive(clap::ArgEnum, PartialEq, Debug, Clone)]
|
||||
#[allow(dead_code)] // silence warning about `Baz` being unused
|
||||
enum ArgChoice {
|
||||
Foo,
|
||||
Bar,
|
||||
#[clap(skip)]
|
||||
Baz(usize),
|
||||
}
|
||||
|
||||
assert_eq!(
|
||||
<ArgChoice as clap::ArgEnum>::value_variants()
|
||||
.iter()
|
||||
.map(clap::ArgEnum::to_possible_value)
|
||||
.map(Option::unwrap)
|
||||
.collect::<Vec<_>>(),
|
||||
vec![
|
||||
clap::PossibleValue::new("foo"),
|
||||
clap::PossibleValue::new("bar")
|
||||
]
|
||||
);
|
||||
|
||||
{
|
||||
use clap::ArgEnum;
|
||||
assert!(ArgChoice::from_str("foo", true).is_ok());
|
||||
assert!(ArgChoice::from_str("bar", true).is_ok());
|
||||
assert!(ArgChoice::from_str("baz", true).is_err());
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn from_str_invalid() {
|
||||
#[derive(clap::ArgEnum, PartialEq, Debug, Clone)]
|
||||
|
|
|
@ -1,7 +1,5 @@
|
|||
error: `#[derive(ArgEnum)]` only supports non-unit variants
|
||||
--> tests/derive_ui/arg_enum_non_unit.rs:3:10
|
||||
error: `#[derive(ArgEnum)]` only supports non-unit variants, unless they are skipped
|
||||
--> tests/derive_ui/arg_enum_non_unit.rs:5:5
|
||||
|
|
||||
3 | #[derive(ArgEnum, Clone, Debug)]
|
||||
| ^^^^^^^
|
||||
|
|
||||
= note: this error originates in the derive macro `ArgEnum` (in Nightly builds, run with -Z macro-backtrace for more info)
|
||||
5 | Foo(usize),
|
||||
| ^^^
|
||||
|
|
Loading…
Reference in a new issue