clap_complete how to run dynamic.rs example

[enricoschaaf]

Hi 👋🏽

I am very interested in the dynamic completions, I tried out the example but I did not get it to work. Would it be possible to provide more context?

Thanks for working on this 🙏🏽

[epage]

Running the examples is a bit awkward because they will registry for completing their binary name and then you need that name within your path.

You can also give this a try with a nightly cargo at https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#native-completions

[epage]

Run COMPLETE=zsh clap_complete_example. You'll see a zsh function that calls into your command. You can mirror the arguments and environment variables that it uses.

See also

clap/clap_complete/src/env/shells.rs

Lines 352 to 366 in c54ffa1

	function _clap_dynamic_completer_NAME() {
	local _CLAP_COMPLETE_INDEX=$(expr $CURRENT - 1)
	local _CLAP_IFS=$'\n'
	local completions=("${(@f)$( \
	_CLAP_IFS="$_CLAP_IFS" \
	_CLAP_COMPLETE_INDEX="$_CLAP_COMPLETE_INDEX" \
	VAR="zsh" \
	COMPLETER -- ${words} 2>/dev/null \
	)}")
	if [[ -n $completions ]]; then
	_describe 'values' completions
	fi
	}

So you likely want to run something like

$ _CLAP_COMPLETE_INDEX=1 COMPLETE=zsh clap_complete_example -- clap_complete_example --he

[enricoschaaf]

If I run this I get

RUST_BACKTRACE=full _CLAP_COMPLETE_INDEX=1 COMPLETE=zsh clap_complete_example -- clap_complete_example --he                   
thread 'main' panicked at /Users/enrico/.cargo/registry/src/index.crates.io-6f17d22bba15001f/clap_complete-4.5.37/src/env/mod.rs:186:9:
CompleteEnv::complete should not be called in a non-completion context, ArgsOs { inner: ["clap_complete_example", "--", "clap_complete_example", "--he"] }, Some("/Users/enrico/projects/clap_complete_example")
stack backtrace:
   0:        0x1022fd564 - <std::sys::backtrace::BacktraceLock::print::DisplayBacktrace as core::fmt::Display>::fmt::he87629dfda86e56f
   1:        0x102310bcc - core::fmt::write::he594510aa17a3f46
   2:        0x1022fb888 - std::io::Write::write_fmt::h20900a84a3021516
   3:        0x1022fd418 - std::sys::backtrace::BacktraceLock::print::h34ddaa1c143b2a23
   4:        0x1022fe2ec - std::panicking::default_hook::{{closure}}::h3f4974050bc93ec3
   5:        0x1022fe130 - std::panicking::default_hook::hde69dffbba41ddff
   6:        0x1022feac4 - std::panicking::rust_panic_with_hook::hb4afb27105f6f657
   7:        0x1022fe754 - std::panicking::begin_panic_handler::{{closure}}::hb0f9b3f848f83302
   8:        0x1022fda28 - std::sys::backtrace::__rust_end_short_backtrace::h4d5b3cbaa747bcc0
   9:        0x1022fe40c - _rust_begin_unwind
  10:        0x102315c50 - core::panicking::panic_fmt::heaede87640cc352a
  11:        0x1022e1414 - clap_complete_example::main::h06db1a2867a35142
  12:        0x1022e152c - std::sys::backtrace::__rust_begin_short_backtrace::hd890a5c18f15a17e
  13:        0x1022e12a4 - std::rt::lang_start::{{closure}}::hf4b2665b3a4d56b9
  14:        0x1022fa224 - std::rt::lang_start_internal::h569531aecc870974
  15:        0x1022e1514 - _main

does it work on your side? If yes I can maybe check what's different about my machine here.

[enricoschaaf]

Actually this works on my non example version 🤔 Then I just have to figure out why there the command works but OS does not call it correctly

[enricoschaaf]

I solved the issue 🥳 Command::get_bin_name takes the name of the crate in my case and not the name of the binary written in Cargo.toml so the autocomplete script is wrong and never actually calls the binary. Looking at your code snippet made me figure it out 🙏🏽