Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(derive): Allow skipping the implicit ArgGroup #4301

Merged
merged 3 commits into from Sep 30, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 3 additions & 4 deletions clap_derive/src/attr.rs
Expand Up @@ -35,10 +35,7 @@ impl ClapAttr {
} else if attr.path.is_ident("command") {
Some(Sp::new(AttrKind::Command, attr.path.span()))
} else if attr.path.is_ident("group") {
abort!(
attr.path.span(),
"`#[group()]` attributes are not supported yet"
)
Some(Sp::new(AttrKind::Group, attr.path.span()))
} else if attr.path.is_ident("arg") {
Some(Sp::new(AttrKind::Arg, attr.path.span()))
} else if attr.path.is_ident("value") {
Expand Down Expand Up @@ -202,6 +199,7 @@ pub enum AttrKind {
Clap,
StructOpt,
Command,
Group,
Arg,
Value,
}
Expand All @@ -212,6 +210,7 @@ impl AttrKind {
Self::Clap => "clap",
Self::StructOpt => "structopt",
Self::Command => "command",
Self::Group => "group",
Self::Arg => "arg",
Self::Value => "value",
}
Expand Down
10 changes: 9 additions & 1 deletion clap_derive/src/derives/args.rs
Expand Up @@ -315,11 +315,19 @@ pub fn gen_augment(
let initial_app_methods = parent_item.initial_top_level_methods();
let group_id = parent_item.ident().unraw().to_string();
let final_app_methods = parent_item.final_top_level_methods();
let group_app_methods = if parent_item.skip_group() {
quote!()
} else {
quote!(
.group(clap::ArgGroup::new(#group_id).multiple(true))
)
};
quote! {{
#deprecations
let #app_var = #app_var
#initial_app_methods
.group(clap::ArgGroup::new(#group_id).multiple(true));
#group_app_methods
;
#( #args )*
#app_var #final_app_methods
}}
Expand Down
23 changes: 20 additions & 3 deletions clap_derive/src/item.rs
Expand Up @@ -50,6 +50,7 @@ pub struct Item {
next_help_heading: Option<Method>,
is_enum: bool,
is_positional: bool,
skip_group: bool,
kind: Sp<Kind>,
}

Expand Down Expand Up @@ -272,6 +273,7 @@ impl Item {
next_help_heading: None,
is_enum: false,
is_positional: true,
skip_group: false,
kind,
}
}
Expand All @@ -291,7 +293,7 @@ impl Item {
),
});
}
AttrKind::Arg | AttrKind::Clap | AttrKind::StructOpt => {}
AttrKind::Group | AttrKind::Arg | AttrKind::Clap | AttrKind::StructOpt => {}
}
self.name = Name::Assigned(quote!(#arg));
} else if name == "name" {
Expand All @@ -309,7 +311,11 @@ impl Item {
),
});
}
AttrKind::Command | AttrKind::Value | AttrKind::Clap | AttrKind::StructOpt => {}
AttrKind::Group
| AttrKind::Command
| AttrKind::Value
| AttrKind::Clap
| AttrKind::StructOpt => {}
}
self.name = Name::Assigned(quote!(#arg));
} else if name == "value_parser" {
Expand All @@ -330,6 +336,7 @@ impl Item {
continue;
}

let actual_attr_kind = *attr.kind.get();
let kind = match &attr.magic {
Some(MagicAttrName::FromGlobal) => {
if attr.value.is_some() {
Expand Down Expand Up @@ -373,7 +380,7 @@ impl Item {
let kind = Sp::new(Kind::Flatten, attr.name.clone().span());
Some(kind)
}
Some(MagicAttrName::Skip) => {
Some(MagicAttrName::Skip) if actual_attr_kind != AttrKind::Group => {
let expr = attr.value.clone();
let kind = Sp::new(
Kind::Skip(expr, self.kind.attr_kind()),
Expand Down Expand Up @@ -404,6 +411,8 @@ impl Item {
));
}

(AttrKind::Group, AttrKind::Command) => {}

_ if attr.kind != expected_attr_kind => {
abort!(
attr.kind.span(),
Expand Down Expand Up @@ -799,6 +808,10 @@ impl Item {
self.env_casing = CasingStyle::from_lit(lit);
}

Some(MagicAttrName::Skip) if actual_attr_kind == AttrKind::Group => {
self.skip_group = true;
}

None
// Magic only for the default, otherwise just forward to the builder
| Some(MagicAttrName::Short)
Expand Down Expand Up @@ -1025,6 +1038,10 @@ impl Item {
.iter()
.any(|m| m.name != "help" && m.name != "long_help")
}

pub fn skip_group(&self) -> bool {
self.skip_group
}
}

#[derive(Clone)]
Expand Down
10 changes: 10 additions & 0 deletions src/_derive/mod.rs
Expand Up @@ -4,6 +4,7 @@
//! 2. [Attributes](#attributes)
//! 1. [Terminology](#terminology)
//! 2. [Command Attributes](#command-attributes)
//! 2. [ArgGroup Attributes](#arggroup-attributes)
//! 3. [Arg Attributes](#arg-attributes)
//! 4. [ValueEnum Attributes](#valueenum-attributes)
//! 5. [Possible Value Attributes](#possible-value-attributes)
Expand All @@ -28,6 +29,7 @@
//! /// Doc comment
//! #[derive(Parser)]
//! #[command(CMD ATTRIBUTE)]
//! #[group(GROUP ATTRIBUTE)]
//! struct Cli {
//! /// Doc comment
//! #[arg(ARG ATTRIBUTE)]
Expand All @@ -46,6 +48,7 @@
//! /// Doc comment
//! #[derive(Args)]
//! #[command(PARENT CMD ATTRIBUTE)]
//! #[group(GROUP ATTRIBUTE)]
//! struct Struct {
//! /// Doc comment
//! #[command(ARG ATTRIBUTE)]
Expand Down Expand Up @@ -173,6 +176,13 @@
//! - `external_subcommand`: [`Command::allow_external_subcommand(true)`][crate::Command::allow_external_subcommands]
//! - Variant must be either `Variant(Vec<String>)` or `Variant(Vec<OsString>)`
//!
//! ### ArgGroup Attributes
//!
//! These correspond to the [`ArgGroup`][crate::ArgGroup] which is implicitly created for each
//! `Args` derive.
//!
//! At the moment, only `#[group(skip)]` is supported
//!
//! ### Arg Attributes
//!
//! These correspond to a [`Arg`][crate::Arg].
Expand Down
27 changes: 27 additions & 0 deletions tests/derive/groups.rs
Expand Up @@ -21,3 +21,30 @@ fn test_safely_nest_parser() {
Opt::try_parse_from(&["test", "--foo"]).unwrap()
);
}

#[test]
fn skip_group_avoids_duplicate_ids() {
#[derive(Parser, Debug)]
struct Opt {
#[command(flatten)]
first: Compose<Empty, Empty>,
#[command(flatten)]
second: Compose<Empty, Empty>,
}

#[derive(clap::Args, Debug)]
#[group(skip)]
pub struct Compose<L: clap::Args, R: clap::Args> {
#[clap(flatten)]
pub left: L,
#[clap(flatten)]
pub right: R,
}

#[derive(clap::Args, Clone, Copy, Debug)]
#[group(skip)]
pub struct Empty;

use clap::CommandFactory;
Opt::command().debug_assert();
}