feat(forge build -vvvvv): If verbosity level is 5 or higher show files to compile

[mgiagante]

Closes #7888

This PR is to address Issue 7888 by leveraging the new global verbosity level flag implemented by #9273

Motivation

This aims to provide users with a way to see which files have changes relative to what's cached, and thus are effectively picked up by the compiler when running forge build.

Solution

If forge build -v is run, this will set the verbosity level to 1. A level of 1 or higher (with additional v's) will display the list of files being compiled.

[grandizzy]

thank you! I think this could also close #9304 so when passing -v flag avoids confusion re files that are compiled, @zerosnacks wdyt?

[zerosnacks]

thank you! I think this could also close #9304 so when passing -v flag avoids confusion re files that are compiled, @zerosnacks wdyt?

Supportive, I think a warning here would still be beneficial as well as this -v flag would indicate the files being compiled but that doesn't offer an explanation as to why they are. I think raising a warning on the fallback trigger (if a path is specified) would still be the right way but this PR is in the right direction

[mgiagante]

@zerosnacks @grandizzy is there currently a way to write tests for this? I've tried the tests in crates/forge/tests/cli/build.rs but the output that needs to be asserted on here doesn't seem to be included.

[grandizzy]

build.rs

@mgiagante I think that's fine without a test, sorry for back and forth, could you remove the newly added variant SpinnerMsg::VerboseMsg (which is not really required) and use same SpinnerMsg::VerboseMsg / send_msg for sending verbose message, then this should be good to send. thank you

[grandizzy]

thank you! pending one more review before merging

[zerosnacks]

Made some minor modifications to the rendered output

Now renders as (path trimmed, sorted, prefixed):

[⠊] Compiling...
[⠒] Files to compile:
- lib/forge-std/src/Base.sol
- lib/forge-std/src/Script.sol
- lib/forge-std/src/StdAssertions.sol
- lib/forge-std/src/StdChains.sol
- lib/forge-std/src/StdCheats.sol
- lib/forge-std/src/StdError.sol
- lib/forge-std/src/StdInvariant.sol
- lib/forge-std/src/StdJson.sol
- lib/forge-std/src/StdMath.sol
- lib/forge-std/src/StdStorage.sol
- lib/forge-std/src/StdStyle.sol
- lib/forge-std/src/StdToml.sol
- lib/forge-std/src/StdUtils.sol
- lib/forge-std/src/Test.sol
- lib/forge-std/src/Vm.sol
- lib/forge-std/src/console.sol
- lib/forge-std/src/console2.sol
- lib/forge-std/src/interfaces/IERC165.sol
- lib/forge-std/src/interfaces/IERC20.sol
- lib/forge-std/src/interfaces/IERC721.sol
- lib/forge-std/src/interfaces/IMulticall3.sol
- lib/forge-std/src/mocks/MockERC20.sol
- lib/forge-std/src/mocks/MockERC721.sol
- lib/forge-std/src/safeconsole.sol
- script/Counter.s.sol
- src/Counter.sol
- src/Counter2.sol
- src/Counter3.sol
- src/Counter4.sol
- test/Counter.t.sol
[⠒] Compiling 30 files with Solc 0.8.28
[⠆] Solc 0.8.28 finished in 950.06ms
Compiler run successful!

As opposed to

[⠒] Compiling files
[⠊] Compiling...
[⠒] Compiling files
/home/zerosnacks/Projects/counter/lib/forge-std/src/StdChains.sol
/home/zerosnacks/Projects/counter/lib/forge-std/src/interfaces/IERC165.sol
/home/zerosnacks/Projects/counter/lib/forge-std/src/Test.sol
/home/zerosnacks/Projects/counter/lib/forge-std/src/interfaces/IERC20.sol
/home/zerosnacks/Projects/counter/src/Counter.sol
/home/zerosnacks/Projects/counter/src/Counter3.sol
/home/zerosnacks/Projects/counter/lib/forge-std/src/interfaces/IERC721.sol
/home/zerosnacks/Projects/counter/lib/forge-std/src/StdStyle.sol
/home/zerosnacks/Projects/counter/lib/forge-std/src/StdToml.sol
/home/zerosnacks/Projects/counter/lib/forge-std/src/mocks/MockERC721.sol
/home/zerosnacks/Projects/counter/test/Counter.t.sol
/home/zerosnacks/Projects/counter/src/Counter2.sol
/home/zerosnacks/Projects/counter/lib/forge-std/src/Base.sol
/home/zerosnacks/Projects/counter/lib/forge-std/src/mocks/MockERC20.sol
/home/zerosnacks/Projects/counter/lib/forge-std/src/StdError.sol
/home/zerosnacks/Projects/counter/lib/forge-std/src/StdMath.sol
/home/zerosnacks/Projects/counter/lib/forge-std/src/StdCheats.sol
/home/zerosnacks/Projects/counter/lib/forge-std/src/Vm.sol
/home/zerosnacks/Projects/counter/lib/forge-std/src/StdInvariant.sol
/home/zerosnacks/Projects/counter/lib/forge-std/src/Script.sol
/home/zerosnacks/Projects/counter/lib/forge-std/src/interfaces/IMulticall3.sol
/home/zerosnacks/Projects/counter/lib/forge-std/src/console2.sol
/home/zerosnacks/Projects/counter/lib/forge-std/src/console.sol
/home/zerosnacks/Projects/counter/lib/forge-std/src/StdStorage.sol
/home/zerosnacks/Projects/counter/lib/forge-std/src/StdAssertions.sol
/home/zerosnacks/Projects/counter/src/Counter4.sol
/home/zerosnacks/Projects/counter/lib/forge-std/src/safeconsole.sol
/home/zerosnacks/Projects/counter/lib/forge-std/src/StdJson.sol
/home/zerosnacks/Projects/counter/lib/forge-std/src/StdUtils.sol
/home/zerosnacks/Projects/counter/script/Counter.s.sol
[⠢] Compiling 30 files with Solc 0.8.28
[⠆] Solc 0.8.28 finished in 984.73ms
Compiler run successful

cc @grandizzy

[DaniPopes]

This is extremely verbose, and it is common for verbosity to be set to 2 or 3 when running test. Unfortunately coupling testing verbosity to everywhere else means that we need to set higher verbosity values for stuff like this.

I'd argue this should be like a trace level log, so 5 or above

[mgiagante]

This is extremely verbose, and it is common for verbosity to be set to 2 or 3 when running test. Unfortunately coupling testing verbosity to everywhere else means that we need to set higher verbosity values for stuff like this.

I'd argue this should be like a trace level log, so 5 or above

That makes a lot of sense. I'll go with 5 then.
Thanks!

[zerosnacks]

This is extremely verbose, and it is common for verbosity to be set to 2 or 3 when running test. Unfortunately coupling testing verbosity to everywhere else means that we need to set higher verbosity values for stuff like this.

I'd argue this should be like a trace level log, so 5 or above

Hmm.. yeah this is not great. For now let's do -vvvvv to avoid interference.

Ideally we would have a way to distinguish if the user intentionally runs forge build or it is part of a process like forge test and adapt based on that. I suggest post-V1 we consider how to apply a more uniform scale.

[mgiagante]

This is extremely verbose, and it is common for verbosity to be set to 2 or 3 when running test. Unfortunately coupling testing verbosity to everywhere else means that we need to set higher verbosity values for stuff like this.
I'd argue this should be like a trace level log, so 5 or above

Hmm.. yeah this is not great. For now let's do -vvvvv to avoid interference.

Ideally we would have a way to distinguish if the user intentionally runs forge build or it is part of a process like forge test and adapt based on that. I suggest post-V1 we consider how to apply a more uniform scale.

Just created #9340 to track this.

[zerosnacks]

Just created #9340 to track this.

All good, added it as a note in #8794