[breaking] uniform cli commands and flag #1542

umbynos · 2021-11-09T16:41:01Z

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?

refactor CLI commands and flags to be consistent with each other.

What is the current behavior?

close #1508

What is the new behavior?

This PR includes various improvements:

sketchpath calculation have been factored out
fqbn and programmer flags now have the same principle of operation as port flag
factored out a function that reports errors when conflicting flags are used
move vars on top and remove structs for uniformity
part of the init section in update-index commands have been factored out
other minor improvements
I also added logrus.Info() in every run function of every command
remove board details <fqbn> in favour of board details -b <fqbn>
replace board attach <port|fqbn> <sketch-path> with board attach -b <fqbn> | -p <port> <sketh-path>
change --timeout flag to --discovery-timeout in board list command for consistency
Does this PR introduce a breaking change, and is
titled accordingly?

yep, documented in UPGRADING.md

Other information:

See how to contribute

per1234

Since this is a big PR that contains multiple atomic commits, I recommend it be granted an exemption from the repo's usual squash merge policy.

This would be done by temporarily adjusting the configuration of the repo's merge button, following this procedure:

Click the "⚙️ Settings" tab of the repository that contains the PR
Under the "Merge button" section of the Settings page, check the box next to "🔲 Allow merge commits"
Merge the PR, selecting the "Merge pull request" option from the merge button
Return to the repository's Settings page
Uncheck the box next to "🔲 Allow merge commits"

Since the commits will not be automatically squashed, any fixup commits should be manually squashed via an interactive rebase before the merge.

cli/arguments/port.go

cli/arguments/sketch.go

cli/debug/debug.go

cli/arguments/sketch.go

cli/arguments/port.go

cli/arguments/sketch.go

cli/board/details.go

cli/instance/instance.go

docs/UPGRADING.md

cli/board/attach.go

docs/UPGRADING.md

per1234

Great stuff Umberto. Thanks!

cli/arguments/fqbn.go

cli/arguments/programmer.go

cli/arguments/sketch.go

cli/instance/instance.go

docs/UPGRADING.md

silvanocerza

See comments.

move `DetectSkipPostInstallValue` in arguments package create `PostInstallFlags` struct in arguments package remove `listFlags` struct

…-b <fqbn>`

…rd attach -b <fqbn> | -p <port> <sketh-path>`

…stency

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

umbynos self-assigned this Nov 9, 2021

umbynos requested a review from a team November 9, 2021 16:41

umbynos force-pushed the umbynos/flags_refactoring branch from ba5385f to 66dbc61 Compare November 10, 2021 14:04

per1234 requested changes Nov 10, 2021

View reviewed changes

umbynos force-pushed the umbynos/flags_refactoring branch 4 times, most recently from 2edafc0 to 80be710 Compare November 11, 2021 15:00

umbynos changed the title ~~uniform cli commands and flag~~ [breaking] uniform cli commands and flag Nov 11, 2021

umbynos requested review from per1234 and silvanocerza November 11, 2021 15:32

umbynos force-pushed the umbynos/flags_refactoring branch from 4d2df31 to 8713d91 Compare November 11, 2021 15:41

per1234 requested changes Nov 11, 2021

View reviewed changes

per1234 approved these changes Nov 11, 2021

View reviewed changes