feat(common::shell): add global verbosity level (-vvv) flag replacing --verbose
#9273
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zerosnacks
changed the title
common::shell): add global verbosity level to common::shell (-vvv)common::shell): add global verbosity level (-vvv) flag
…ten ShellOpts in args
zerosnacks
changed the title
common::shell): add global verbosity level (-vvv) flagcommon::shell): add global verbosity level (-vvv) flag replacing --verbose
zerosnacks
commented
Nov 7, 2024
Comment on lines
+217
to
+218
| #[clap(flatten)] | ||
| pub shell: ShellOpts, |
There was a problem hiding this comment.
Renaming ShellOpts to GlobalOpts + consistent enforcement will be handled in #8408
It will be possible to access the global shell options either directly by e.g. shell::is_quiet, etc.. as well as by args.global.shell().is_quiet()
zerosnacks
commented
Nov 7, 2024
| #[arg(long, short)] | ||
| #[arg(long)] |
zerosnacks
commented
Nov 7, 2024
| #[arg(long, short)] | ||
| #[arg(long)] |
zerosnacks
commented
Nov 7, 2024
Comment on lines
-51
to
-53
| /// Prints the full address of the contract. | ||
| #[arg(long, short)] | ||
| verbose: bool, |
There was a problem hiding this comment.
Note: breaking change, equivalent
zerosnacks
commented
Nov 7, 2024
Comment on lines
-186
to
-188
| /// Verbose mode, print the address and private key. | ||
| #[arg(short = 'v', long)] | ||
| verbose: bool, |
There was a problem hiding this comment.
Note: breaking change, equivalent
zerosnacks
commented
Nov 7, 2024
Comment on lines
-104
to
-115
| /// Verbosity of the EVM. | ||
| /// | ||
| /// Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). | ||
| /// | ||
| /// Verbosity levels: | ||
| /// - 2: Print logs for all tests | ||
| /// - 3: Print execution traces for failing tests | ||
| /// - 4: Print execution traces for all tests, and setup traces for failing tests | ||
| /// - 5: Print execution and setup traces for all tests | ||
| #[arg(long, short, verbatim_doc_comment, action = ArgAction::Count)] | ||
| #[serde(skip)] | ||
| pub verbosity: u8, |
There was a problem hiding this comment.
Note: global verbosity setting is exact equivalent except the description, not sure what a practical way is to modify the verbosity flag description to be more context dependent
zerosnacks
requested review from
DaniPopes,
klkvr,
mattsse,
grandizzy and
yash-atreya
as code owners
rplusq
pushed a commit
to rplusq/foundry
that referenced
this pull request
Nov 29, 2024
…cing `--verbose` (foundry-rs#9273) * remove --verbose, prefer output mode, introduce verbosity level (-vvv) * remove leftover * fix arg * add ability to set verbosity level * fix tests * remove evm args specific verbosity arg in favor of global arg due to Clap limitation * revert test modifications from foundry-rs#9244 for TestArgs, simply pass + flatten ShellOpts in args * in lieu of a context specific help document the verbosity levels of the EVM as an example * format comment, update tests * fix clippy
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
In line with the familiar (
-v,-vv,-vvv, etc..) I think it makes sense replace the current global--verboseoption in favor of one specified by a verbosity level.Related: #8794
Related: #3704
Solution
verbosemodeOutputModew/NormalandQuiet, same behavior--jsonfield-valready being in use in favor of the global flag: this is a breaking changeOutput: