[breaking] Clean up and refactor --format json and, in general, how Arduino CLI output is handled

[cmaglie]

Please check if the PR fulfills these requirements

See how to contribute

• 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?

• The feedback golang API has changed, this should fix all the issues where the JSON output is mixed with text.
• A static source code analyzer has been added in the unit-tests, it should detect when the feedback package is bypassed:

=== RUN   TestNoDirectOutputToStdOut
burnbootloader/burnbootloader.go:85:5: object `os.Stdout` should not be used in this package (use `feedback.*` instead)
burnbootloader/burnbootloader.go:85:16: object `os.Stderr` should not be used in this package (use `feedback.*` instead)
compile/compile.go:235:84: object `os.Stdout` should not be used in this package (use `feedback.*` instead)
compile/compile.go:235:95: object `os.Stderr` should not be used in this package (use `feedback.*` instead)
compile/compile.go:274:72: object `os.Stdout` should not be used in this package (use `feedback.*` instead)
compile/compile.go:274:83: object `os.Stderr` should not be used in this package (use `feedback.*` instead)
compile/compile.go:296:4: function `fmt.Println` should not be used in this package (use `feedback.*` instead)
compile/compile.go:297:4: function `fmt.Println` should not be used in this package (use `feedback.*` instead)
compile/compile.go:298:4: function `fmt.Println` should not be used in this package (use `feedback.*` instead)
compile/compile.go:305:3: function `fmt.Println` should not be used in this package (use `feedback.*` instead)
compile/compile.go:306:3: function `fmt.Println` should not be used in this package (use `feedback.*` instead)
compile/compile.go:307:3: function `fmt.Println` should not be used in this package (use `feedback.*` instead)
compile/compile.go:308:3: function `fmt.Println` should not be used in this package (use `feedback.*` instead)
compile/compile.go:309:3: function `fmt.Println` should not be used in this package (use `feedback.*` instead)
compile/compile.go:311:3: function `fmt.Println` should not be used in this package (use `feedback.*` instead)
compile/compile.go:313:4: function `fmt.Println` should not be used in this package (use `feedback.*` instead)
compile/compile.go:319:4: function `fmt.Println` should not be used in this package (use `feedback.*` instead)
compile/compile.go:321:5: function `fmt.Println` should not be used in this package (use `feedback.*` instead)
compile/compile.go:325:4: function `fmt.Println` should not be used in this package (use `feedback.*` instead)
compile/compile.go:326:4: function `fmt.Print` should not be used in this package (use `feedback.*` instead)
completion/completion.go:58:34: object `os.Stdout` should not be used in this package (use `feedback.*` instead)
completion/completion.go:61:38: object `os.Stdout` should not be used in this package (use `feedback.*` instead)
completion/completion.go:63:32: object `os.Stdout` should not be used in this package (use `feedback.*` instead)
completion/completion.go:66:32: object `os.Stdout` should not be used in this package (use `feedback.*` instead)
completion/completion.go:68:38: object `os.Stdout` should not be used in this package (use `feedback.*` instead)
daemon/interceptors.go:29:19: object `os.Stdout` should not be used in this package (use `feedback.*` instead)
debug/debug.go:106:82: object `os.Stdout` should not be used in this package (use `feedback.*` instead)
monitor/term.go:38:9: object `os.Stdout` should not be used in this package (use `feedback.*` instead)
output/rpc_progress.go:115:4: function `fmt.Print` should not be used in this package (use `feedback.*` instead)
output/rpc_progress.go:117:5: function `fmt.Println` should not be used in this package (use `feedback.*` instead)
output/rpc_progress.go:119:5: function `fmt.Println` should not be used in this package (use `feedback.*` instead)
upload/upload.go:163:5: object `os.Stdout` should not be used in this package (use `feedback.*` instead)
upload/upload.go:163:16: object `os.Stderr` should not be used in this package (use `feedback.*` instead)
cli.go:215:4: function `fmt.Println` should not be used in this package (use `feedback.*` instead)
--- FAIL: TestNoDirectOutputToStdOut (0.01s)
FAIL
exit status 1
FAIL	github.com/arduino/arduino-cli/cli	0.019s

• As a nice side effect, the new feedback API helped to clean up some commands behavior when --format json is specified.

What is the current / new behavior?

If the interactive terminal is required, JSON format will produce an error

CURRENT:

$ arduino-cli monitor -p /dev/ttyACM0 --format json
"Connected to /dev/ttyACM0! Press CTRL-C to exit."
^C
$

NEW:

$ arduino-cli monitor -p /dev/ttyACM0 --format json
{
  "error": "interactive terminal not supported for the 'json' output format"
}

JSON output produces an error if not compatible with the given command/args combination. Fatal errors are encoded in JSON

CURRENT:

$ arduino-cli daemon --format json --debug
{
  "IP": "127.0.0.1",
  "Port": "50051"
}
^C
$

NEW:

$ arduino-cli daemon --format json --debug
{
  "error": "Debug log is only available in text format"
}
$ arduino-cli daemon --format json --debug --debug-file log.txt
{
  "IP": "127.0.0.1",
  "Port": "50051"
}
^C

Warnings are printed in text mode, or accumulated in the json result in JSON mode

CURRENT:

$ arduino-cli compile -b arduino:samd:arduino_zero_native --format json 
Sketches with .pde extension are deprecated, please rename the following files to .ino:
/home/megabug/Arduino/Blink/A.pde
{
  "compiler_out": "Sketch uses 40192 bytes (15%) of program storage space. Maximum is 262144 bytes.\nGlobal variables use 4012 bytes (12%) of dynamic memory, leaving 28756 bytes for local variables. Maximum is 32768 bytes.\n",
  "compiler_err": "",
  "builder_result": { .... },
  "success": true
}

NEW:

$ arduino-cli compile -b arduino:samd:arduino_zero_native --format json 
{
  "compiler_err": "",
  "compiler_out": "Sketch uses 40192 bytes (15%) of program storage space. Maximum is 262144 bytes.\nGlobal variables use 4012 bytes (12%) of dynamic memory, leaving 28756 bytes for local variables. Maximum is 32768 bytes.\n",
  "builder_result": { ... },
  "success": true,
  "warnings": [
    "Sketches with .pde extension are deprecated, please rename the following files to .ino:\n - /home/megabug/Arduino/Blink/A.pde"
  ]
}

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

Yes.

[per1234]

UPDATE: resolved

0c2dc76 caused the error to be printed twice (once to stdout, and once to stderr):

$ arduino-cli version
arduino-cli.exe  Version: git-snapshot Commit: 0c2dc76b Date: 2023-01-13T15:38:07Z

$ mkdir /tmp/FooSketch

$ printf "#error\nvoid setup() {}\nvoid loop() {}" > /tmp/FooSketch/FooSketch.ino

$ arduino-cli compile --fqbn arduino:avr:uno /tmp/FooSketch
C:\Users\per\AppData\Local\Temp\FooSketch\FooSketch.ino:1:2: error: #error 
 #error
  ^~~~~


Used platform Version Path
arduino:avr   1.8.6   C:\Users\per\AppData\Local\Arduino15\packages\arduino\hardware\avr\1.8.6

Error during build: exit status 1
Error during build: exit status 1

(note there are two "Error during build: exit status 1" in the output)