diff --git a/clap_complete/src/generator/mod.rs b/clap_complete/src/generator/mod.rs index 2d00c281df6..b33ce481beb 100644 --- a/clap_complete/src/generator/mod.rs +++ b/clap_complete/src/generator/mod.rs @@ -236,7 +236,7 @@ where G: Generator, S: Into, { - cmd._build_all(); + cmd.build(); gen.generate(cmd, buf) } diff --git a/clap_complete/src/generator/utils.rs b/clap_complete/src/generator/utils.rs index b8aaa4bd578..054ee2b8b0d 100644 --- a/clap_complete/src/generator/utils.rs +++ b/clap_complete/src/generator/utils.rs @@ -151,14 +151,14 @@ mod tests { fn built() -> Command<'static> { let mut cmd = common_app(); - cmd._build_all(); + cmd.build(); cmd } fn built_with_version() -> Command<'static> { let mut cmd = common_app().version("3.0"); - cmd._build_all(); + cmd.build(); cmd } diff --git a/clap_mangen/src/lib.rs b/clap_mangen/src/lib.rs index 44f55840490..bf11b60bd87 100644 --- a/clap_mangen/src/lib.rs +++ b/clap_mangen/src/lib.rs @@ -26,7 +26,7 @@ pub struct Man<'a> { impl<'a> Man<'a> { /// Create a new manual page. pub fn new(mut cmd: clap::Command<'a>) -> Self { - cmd._build_all(); + cmd.build(); let title = cmd.get_name().to_owned(); let section = "1".to_owned(); let date = "".to_owned(); diff --git a/src/build/command.rs b/src/build/command.rs index 39e1b4358e0..86da30414b7 100644 --- a/src/build/command.rs +++ b/src/build/command.rs @@ -3984,9 +3984,17 @@ impl<'help> App<'help> { Ok(matcher.into_inner()) } - // used in clap_complete (https://github.com/clap-rs/clap_complete) #[doc(hidden)] + #[deprecated(since = "3.1.10", note = "Replaced with `Command::build`")] pub fn _build_all(&mut self) { + self.build(); + } + + /// Prepare for introspecting on all included [`Command`]s + /// + /// Call this on the top-level [`Command`] when done building and before reading state for + /// cases like completions, custom help output, etc. + pub fn build(&mut self) { self._build(); for subcmd in self.get_subcommands_mut() { subcmd._build(); @@ -4047,9 +4055,13 @@ impl<'help> App<'help> { Some(sc) } - // used in clap_complete (https://github.com/clap-rs/clap_complete) #[doc(hidden)] + #[deprecated(since = "3.1.10", note = "Replaced with `Command::build`")] pub fn _build(&mut self) { + self._build_self() + } + + pub(crate) fn _build_self(&mut self) { debug!("App::_build"); if !self.settings.is_set(AppSettings::Built) { // Make sure all the globally set flags apply to us as well diff --git a/src/build/tests.rs b/src/build/tests.rs index 0cea009571c..76c8b878550 100644 --- a/src/build/tests.rs +++ b/src/build/tests.rs @@ -39,7 +39,7 @@ fn issue_2090() { let mut cmd = Command::new("cmd") .disable_version_flag(true) .subcommand(Command::new("sub")); - cmd._build(); + cmd._build_self(); assert!(cmd .get_subcommands() diff --git a/src/parse/features/suggestions.rs b/src/parse/features/suggestions.rs index 76d16ac829a..77ba8c7a250 100644 --- a/src/parse/features/suggestions.rs +++ b/src/parse/features/suggestions.rs @@ -51,7 +51,7 @@ where None => subcommands .into_iter() .filter_map(|subcommand| { - subcommand._build(); + subcommand._build_self(); let longs = subcommand.get_keymap().keys().filter_map(|a| { if let KeyType::Long(v) = a { diff --git a/src/parse/parser.rs b/src/parse/parser.rs index d778b84514c..95f027e79fc 100644 --- a/src/parse/parser.rs +++ b/src/parse/parser.rs @@ -636,7 +636,7 @@ impl<'help, 'cmd> Parser<'help, 'cmd> { } .clone(); - sc._build(); + sc._build_self(); bin_name.push(' '); bin_name.push_str(sc.get_name()); } diff --git a/tests/builder/app_settings.rs b/tests/builder/app_settings.rs index c48c9590944..6c6453e469c 100644 --- a/tests/builder/app_settings.rs +++ b/tests/builder/app_settings.rs @@ -1176,7 +1176,7 @@ fn color_is_global() { let mut cmd = Command::new("myprog") .color(clap::ColorChoice::Never) .subcommand(Command::new("foo")); - cmd._build_all(); + cmd.build(); assert_eq!(cmd.get_color(), clap::ColorChoice::Never); let sub = cmd.get_subcommands().collect::>()[0]; diff --git a/tests/builder/help.rs b/tests/builder/help.rs index 211f7e0d483..48eb1cf2533 100644 --- a/tests/builder/help.rs +++ b/tests/builder/help.rs @@ -2872,7 +2872,7 @@ fn disable_help_flag_affects_help_subcommand() { let mut cmd = Command::new("test_app") .disable_help_flag(true) .subcommand(Command::new("test").about("Subcommand")); - cmd._build_all(); + cmd.build(); let args = cmd .find_subcommand("help") @@ -2918,7 +2918,7 @@ fn help_without_short() { .arg(arg!(-h --hex )) .arg(arg!(--help)); - cmd._build_all(); + cmd.build(); let help = cmd.get_arguments().find(|a| a.get_id() == "help").unwrap(); assert_eq!(help.get_short(), None);