8000 add dynamic completion by umbynos · Pull Request #1509 · arduino/arduino-cli · GitHub
[go: up one dir, main page]
Skip to content

add dynamic completion #1509

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.

Sign up for GitHub

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

Merged
merged 22 commits into from
Oct 18, 2021
Merged

add dynamic completion #1509

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
9d61a6e
add completion for `-b` or `--fqbn` for every command
umbynos Oct 18, 2021
b7263bf
add completion for `-l` or `--protocol`
umbynos Oct 18, 2021
b6ed62f
the previous implementation was working only with a board connected t…
umbynos Oct 5, 2021
3e57b18
add static completion for `--log-level, `--log-format` and `--format`
umbynos Oct 6, 2021
0c0823f
add completion for `-P` or `--programmer` & fix typo
umbynos Oct 6, 2021
fe4ab51
add completion for `core uninstall`
umbynos Oct 6, 2021
fc82c12
add completion for `core install` and `core download`
umbynos Oct 6, 2021
e79ae01
add completion for `lib uninstall`
umbynos Oct 6, 2021
6d560b2
add completion for `lib install`, `lib download`
umbynos Oct 7, 2021
3486d94
add completion for `lib examples`
umbynos Oct 7, 2021
28dfdc1
add completion for `config add`, `config remove`, `config delete` and…
umbynos Oct 7, 2021
27d300c
add completion for `lib deps`
umbynos Oct 7, 2021
d7be814
add tests
umbynos Oct 12, 2021
4559c25
enhance the completion for `config add` and `config remove`
umbynos Oct 13, 2021
6b1a01c
add description completion suggestion for core, lib, fqbn, programmer
umbynos Oct 13, 2021
5462031
add completion also for `-p` or `--port` flag
umbynos Oct 13, 2021
fe2cf6 8000 5
remove the `toComplete` parameter from all the completion functions
umbynos Oct 13, 2021
2a953a9
fixes after rebase
umbynos Oct 13, 2021
7235896
update docs
umbynos Oct 13, 2021
d6c4732
add `-b` or `--fqbn` completion for the monitor command and tests
umbynos Oct 14, 2021
c5ee4d0
apply suggestions from code review
umbynos Oct 15, 2021
d6d4502
fixes after rebase
umbynos Oct 18, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
add completion also for -p or --port flag
  • Loading branch information
@umbynos
umbynos committed Oct 18, 2021
commit 5462031a30c5afba252cad7e61a18a46dd121242
17 changes: 17 additions & 0 deletions cli/arguments/completion.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,3 +160,20 @@ func GetInstallableLibs(toComplete string) []string {
}
return res
}

// GetConnectedBoards is an helper function useful to autocomplete.
// It returns a list of boards which are currently connected
// Obviously it does not suggests network ports because of the timeout
func GetConnectedBoards(toComplete string) []string {
inst := instance.CreateAndInit() // TODO optimize this: it does not make sense to create an instance everytime

list, _ := board.List(&rpc.BoardListRequest{
Instance: inst,
})
var res []string
// transform the data structure for the completion
for _, i := range list {
res = append(res, i.Port.Address)
}
return res
}
3 changes: 3 additions & 0 deletions cli/arguments/port.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ type Port struct {
// AddToCommand adds the flags used to set port and protocol to the specified Command
func (p *Port) AddToCommand(cmd *cobra.Command) {
cmd.Flags().StringVarP(&p.address, "port", "p", "", tr("Upload port address, e.g.: COM3 or /dev/ttyACM2"))
cmd.RegisterFlagCompletionFunc("port", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
return GetConnectedBoards(toComplete), cobra.ShellCompDirectiveDefault
})
cmd.Flags().StringVarP(&p.protocol, "protocol", "l", "", tr("Upload port protocol, e.g: serial"))
cmd.RegisterFlagCompletionFunc("protocol", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
return GetInstalledProtocols(toComplete), cobra.ShellCompDirectiveDefault
Expand Down
6 changes: 3 additions & 3 deletions i18n/data/en.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1418,7 +1418,7 @@ msgstr "Low memory available, stability problems may occur."
msgid "Maintainer: %s"
msgstr "Maintainer: %s"

#: cli/arguments/port.go:49
#: cli/arguments/port.go:52
msgid "Max time to wait for port discovery, e.g.: 30s, 1m"
msgstr "Max time to wait for port discovery, e.g.: 30s, 1m"

Expand Down Expand Up @@ -2201,7 +2201,7 @@ msgstr "Upload port address, e.g.: COM3 or /dev/ttyACM2"
msgid "Upload port found on %s"
msgstr "Upload port found on %s"

#: cli/arguments/port.go:45
#: cli/arguments/port.go:48
msgid "Upload port protocol, e.g: serial"
msgstr "Upload port protocol, e.g: serial"

Expand Down Expand Up @@ -3031,7 +3031,7 @@ msgstr "pluggable discovery already added: %s"
msgid "port"
msgstr "port"

#: cli/arguments/port.go:125
#: cli/arguments/port.go:128
msgid "port not found: %[1]s %[2]s"
msgstr "port not found: %[1]s %[2]s"

Expand Down
0