add dynamic completion #1509

umbynos · 2021-10-13T15:57:29Z

Please check if the PR fulfills these requirements

The PR has no duplicates (please search among the Pull Requests
before creating one)
The PR follows
our contributing guidelines
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)
UPGRADING.md has been updated with a migration guide (for breaking changes)

What kind of change does this PR introduce?

command line completion enhancement
close #1452 close #649

What is the current behavior?

Command line completion works in a static way for now. Except for #1431

What is the new behavior?

Dynamic command line completion has been added to a lot of commands and flags, this should enhance a lot the experience in using the CLI. Further details in #1452

Does this PR introduce a breaking change, and is
titled accordingly?

no

Other information:

See how to contribute

umbynos · 2021-10-14T10:09:08Z

Here's a little demo.

umbynos · 2021-10-14T14:57:49Z

In the following table there is the full list of completion added:
The 🚧 means that have been added in this PR
The 🔵 means that test for that functionality have been added
The ❎ means that this functionality won't be added

Command	Subcommand	flagname	completion	comments	implemented
board	attach		port \|\| fqbn
	details	-b	fqbn		🚧 ✔️ 🔵
	search		fqbn or other	is it usefull??	❎
burn-bootloader		-b	fqbn		🚧 ✔️
		-l	protocol		🚧:heavy_check_mark: :large_blue_circle:
		-P	programmer		🚧:heavy_check_mark: :large_blue_circle:
		-p	port	doesn’t return the network ports	🚧 ✔️
compile		-b	fqbn		✔️ 🔵
		-l	protocol		🚧✔️ 🔵
		-P	programmer		🚧✔️ 🔵
		-p	port	doesn’t return the network ports	🚧✔️
completion			type	static	✔️
config	add		property		🚧 ✔️ 🔵
	remove		property		🚧✔️🔵
	delete		property	maybe return also the key before the dot	🚧✔️🔵
	set		property		🚧✔️🔵
core	download		packager:arch	does not complete the version	🚧✔️🔵
	install		packager:arch	does not complete the version	🚧✔️🔵
	uninstall		packager:arch		🚧✔️ 🔵
debug		-b	fqbn		🚧✔️ 🔵
		-l	protocol		🚧✔️ 🔵
		-P	programmer		🚧✔️ 🔵
		-p	port	doesn’t return the network ports	🚧 ✔️
		--interpreter	console-type		❎
lib	deps		LibraryName		🚧✔️ 🔵
	download		LibraryName		🚧 ✔️ 🔵
	examples		LibraryName		🚧 ✔️ 🔵
	examples	-b	fqbn		🚧 ✔️ 🔵
	install		LibraryName		🚧 ✔️ 🔵
	uninstall		LibraryName		🚧 ✔️ 🔵
monitor		-b	fqbn		🚧 ✔️ 🔵
		-l	protocol		🚧 ✔️ 🔵
		-p	port		🚧 ✔️
		-c	config of the port	Difficult to implement due to the format of the args	❎
upload		-b	fqbn		🚧 ✔️ 🔵
		-l	protocol		🚧✔️ 🔵
		-P	programmer		🚧✔️ 🔵
		-p	port	doesn’t return the network ports	🚧 ✔️

In the following table there are static flags

flagname	completion	Comment	Implemented
--format	{text\|json}	static	🚧✔️ 🔵
–log-format	{text\|json}	static	🚧✔️ 🔵
--log-level	trace-debug….	static	🚧✔️ 🔵

cli/arguments/completion.go

cli/cli.go

silvanocerza

That are some changes to make, but all in all I like it. Good job son. 💯

But does only work for connected boards and do not list every protocol installed

…o the pc RPC was not exposing that functionality

maybe could be done better (filter and remove the manually installed ones)

… `config set`

as of now this parameter is useless because if a string is typed in the terminal it cannot be swapped with a different one. For example if I write `arduino-cli compile -b avr<TAB><TAB>` the completion function returns all elements starting with `arduino:avr...`. So the completions are not showed because they cannot be swapped with a string that starts differently. The only shell which seems to support this seems to be zsh

umbynos added type: enhancement Proposed improvement topic: code Related to content of the project itself topic: CLI Related to the command line interface labels Oct 13, 2021

umbynos requested a review from a team October 13, 2021 15:57

umbynos self-assigned this Oct 13, 2021

umbynos force-pushed the umbynos/completion branch from 81e9cb9 to 042eb2f Compare October 14, 2021 08:19

umbynos force-pushed the umbynos/completion branch from 694560d to 72463d5 Compare October 14, 2021 13:18