The PR has no duplicates (please search among thePull 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?

It makes the compile output completely silent if the--quiet flag is specified and the compile has no errors.
It removes the recap table if the build is successful and no--verbose or--quiet flags have been provided.
Adds the-q shortcut to the--quiet flag

Command line	A successful build shows	A build with errors shows
`arduino-cli compile`	Sketch size	Sketch size, used libraries
`arduino-cli compile -v`	Build commands, sketch size, used libraries	Build commands, sketch size, used libraries
`arduino-cli compile -q`	nothing	Errors only

What is the current behavior?

$ arduino-cli compile -b arduino:samd:nano_33_iotSketch uses 11544 bytes (4%) of program storage space. Maximum is 262144 bytes.Global variables use 3560 bytes (10%) of dynamic memory, leaving 29208 bytes for local variables. Maximum is 32768 bytes.Used platform Version Patharduino:samd  1.8.14  /home/cmaglie/.arduino15/packages/arduino/hardware/samd/1.8.14$ arduino-cli compile -b arduino:samd:nano_33_iot --quietSketch uses 11544 bytes (4%) of program storage space. Maximum is 262144 bytes.Global variables use 3560 bytes (10%) of dynamic memory, leaving 29208 bytes for local variables. Maximum is 32768 bytes.Used platform Version Patharduino:samd  1.8.14  /home/cmaglie/.arduino15/packages/arduino/hardware/samd/1.8.14$

What is the new behavior?

$ arduino-cli compile -b arduino:samd:nano_33_iotSketch uses 11544 bytes (4%) of program storage space. Maximum is 262144 bytes.Global variables use 3560 bytes (10%) of dynamic memory, leaving 29208 bytes for local variables. Maximum is 32768 bytes.$ arduino-cli compile -b arduino:samd:nano_33_iot -q$

Does this PR introduce a breaking change, and istitled accordingly?

Other information

Fix#2796
Fix#2510

cmaglie self-assigned this

Jan 21, 2025

cmaglie force-pushed thesuppress_compile_stats branch fromd6ded91 to0c2d093Compare

January 21, 2025 12:01

cmaglie added type: enhancement

Proposed improvement

topic: codeRelated to content of the project itself labels

Jan 21, 2025

Copy link

codecovbot commentedJan 21, 2025•
edited
Loading

Codecov Report

Attention: Patch coverage is86.41975% with11 lines in your changes missing coverage. Please review.

Project coverage is 67.72%. Comparing base(e9092cc) to head(17ced8f).
Report is 3 commits behind head on master.

Files with missing lines	Patch %	Lines
...nal/arduino/builder/internal/preprocessor/ctags.go	57.14%	3 Missing⚠️
...rnal/arduino/builder/internal/detector/detector.go	75.00%	1 Missing and 1 partial⚠️
internal/arduino/builder/sketch.go	0.00%	0 Missing and 2 partials⚠️
internal/arduino/builder/archive_compiled_files.go	50.00%	0 Missing and 1 partial⚠️
internal/arduino/builder/linker.go	0.00%	0 Missing and 1 partial⚠️
internal/arduino/builder/recipe.go	0.00%	0 Missing and 1 partial⚠️
internal/arduino/builder/sizer.go	94.11%	1 Missing⚠️

Additional details and impacted files

@@            Coverage Diff             @@##           master    #2820      +/-   ##==========================================+ Coverage   67.69%   67.72%   +0.02%==========================================  Files         238      238                Lines       22388    22406      +18     ==========================================+ Hits        15156    15174      +18  Misses       6036     6036                Partials     1196     1196

Flag	Coverage Δ
unit	`67.72% <86.41%> (+0.02%)`	⬆️

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

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

cmaglie mentioned this pull request

Jan 21, 2025

Option to disable "Used Library" and "Used Platform" output when compiling#2796

Closed

3 tasks

cmaglie requested review fromMatteoPologruto,alessio-perugini,dido18 andlucarin91

January 22, 2025 11:02

alessio-perugini reviewed

Jan 22, 2025

View reviewed changes

Copy link

Contributor

alessio-perugini left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Do we have a dedicated integration test that assert this new behaviour?
If not I'm afraid that we should add one, especially in the case-q and-v is provided.

commands/service_compile.goShow resolvedHide resolved

internal/cli/compile/compile.goShow resolvedHide resolved

cmaglie added8 commits

January 23, 2025 11:55

Made builder logger verbosity an explicit type

1214f57

Compile with --quiet flag set will not output final stats

95080cf

Suppress size output if --quiet is specified

d9cfdf7

Added -q shortcut to --quiet flag in compile command

2e4d48f

Compile recap is hidden also on a successful compile with default ver…

48a6ad3

…bosity

Made --quiet and --verbose mutually exclusive

f967107

Output 'ctags' command line to stdout instead of stderr

a596028

Do not output empty lines if the message is empty

6268f39

cmaglie force-pushed thesuppress_compile_stats branch from29a623a to924bbb8Compare

January 23, 2025 12:52

Added integration tests

c9122eb

cmaglie force-pushed thesuppress_compile_stats branch from924bbb8 toc9122ebCompare

January 23, 2025 12:54

Use internal function to check for arguments exclusivity

17ced8f

Because it has a better error message than the cobra-provided one:  Can't use the following flags together: --quiet, --verboseInstead of:  Error: if any flags in the group [quiet verbose] are set none of the others can be; [quiet verbose] were all set

Copy link

MemberAuthor

cmaglie commentedJan 23, 2025

Do we have a dedicated integration test that assert this new behaviour?
If not I'm afraid that we should add one, especially in the case -q and -v is provided.

I've added the tests and they helped me to finally spot where the infamous\n in stderr was coming from!
I've also spotted another stderr contamination in the ctags launcher. Overall, it's good that we have those tests in place now.

cmaglie requested a review fromalessio-perugini

January 23, 2025 13:02

alessio-perugini approved these changes

Jan 23, 2025

View reviewed changes

internal/arduino/builder/logger/logger.goShow resolvedHide resolved

Copy link

Contributor

alessio-perugini commentedJan 23, 2025

Also tested on my machine (linux) works 🥳

cmaglie merged commit92fae9c intoarduino:master

Jan 24, 2025

98 checks passed

cmaglie deleted the suppress_compile_stats branch

January 24, 2025 14:52

Copy link

seife commentedJun 11, 2025

Is there an option to get the old behaviour (quiet compilation, but library list at the end) back?
Without giving "-q", I don't get anything and with "-v" I get too much.

The only difference between "no argument" and "-q" is that "-q" also suppresses the

Sketch uses 1709602 bytes (86%) of program storage space. Maximum is 1966080 bytes.Global variables use 67980 bytes (20%) of dynamic memory, leaving 259700 bytes for local variables. Maximum is 327680 bytes.

message