[breaking] cli: format json always start with a json object #2407

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)
configuration.schema.json updated if new parameters are added.

What kind of change does this PR introduce?

We're wrapping in json object all the results that previously were emitting directly an array

What is the current behavior?

Currently, some commands when printing with json, are starting with an array instead of an object

What is the new behavior?

We uniformed every command to always output a json Object.

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

Other information

@alessio-perugini alessio-perugini linked an issue

Nov 7, 2023

that may be closed by this pull request

Ensure that cli JSON output always return a JsonObject #2406

Closed

3 tasks

@alessio-perugini alessio-perugini self-assigned this

Nov 7, 2023

@alessio-perugini alessio-perugini added the topic: code label

Nov 7, 2023

@alessio-perugini alessio-perugini modified the milestones: Arduino CLI v0.36.0, Arduino CLI v1.0.0

Nov 7, 2023

@alessio-perugini alessio-perugini force-pushed the 2406-ensure-that-cli-json-output-always-return-a-jsonobject branch 3 times, most recently from f4aeca4 to 88f7058 Compare

November 7, 2023 13:24

@codecov Codecov

Copy link

codecov bot commented Nov 7, 2023 •

edited

Loading

Codecov Report

Attention: 10 lines in your changes are missing coverage. Please review.

Comparison is base (ae24226) 67.23% compared to head (72a06b4) 67.16%.

Additional details and impacted files

@@ Coverage Diff @@
## master #2407 +/- ##
==========================================
- Coverage 67.23% 67.16% -0.07% 
==========================================
 Files 210 210 
 Lines 20519 20523 +4 
==========================================
- Hits 13796 13785 -11 
- Misses 5589 5600 +11 
- Partials 1134 1138 +4

Flag	Coverage Δ
unit	`67.16% <77.27%> (-0.07%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
internal/cli/board/listall.go	`57.44% <100.00%> (ø)`
internal/cli/config/add.go	`93.61% <100.00%> (ø)`
internal/cli/config/set.go	`85.36% <100.00%> (ø)`
internal/cli/core/list.go	`90.62% <100.00%> (ø)`
internal/cli/lib/check_deps.go	`76.81% <100.00%> (ø)`
internal/cli/lib/examples.go	`55.88% <100.00%> (ø)`
internal/cli/lib/list.go	`94.44% <100.00%> (ø)`
internal/cli/config/dump.go	`71.42% <50.00%> (ø)`
internal/cli/core/search.go	`74.75% <80.00%> (ø)`
internal/cli/board/list.go	`34.43% <60.00%> (ø)`
... and 2 more

... and 2 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@alessio-perugini alessio-perugini changed the title ~~(削除) Cli: format json always start with a json object (削除ここまで)~~ (追記) [breaking] cli: format json always start with a json object (追記ここまで)

Nov 7, 2023

@alessio-perugini alessio-perugini marked this pull request as ready for review

November 7, 2023 14:02

@alessio-perugini alessio-perugini requested review from cmaglie, MatteoPologruto and umbynos

November 7, 2023 14:03

@alessio-perugini alessio-perugini force-pushed the 2406-ensure-that-cli-json-output-always-return-a-jsonobject branch 3 times, most recently from d55f197 to 2261009 Compare

November 10, 2023 08:18

umbynos

umbynos approved these changes

Nov 10, 2023

View reviewed changes

alessio-perugini added 11 commits

November 10, 2023 14:50

@alessio-perugini