feat: add foundry_common::shell to unify log behavior
#9109
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
…ss, for some reason cfg!(test) path is not handled when running with tokio tests
|
if possible, we can do this in smaller chunks because this pr is a conflict magnet |
zerosnacks
changed the title
foundry_common::shell to unify log behavior
Noted, I've tried to keep the changes to a minimum but due to the nature of the PR there are a lot of small changes across many files. I've not replaced any |
…error message content in red - both not bold
|
Applied fixes from review cc @DaniPopes, would you mind checking one more time? To avoid visual regression, applied a change to style warning message content in yellow and error message content in red. |
|
Applied a minor fix for conditional rendering of failed tests when |
DaniPopes
requested changes
Oct 17, 2024
…yle formatting - no longer style the message
Reverted the style change as result of internal poll, now renders as follows again:
|
36 tasks
DaniPopes
approved these changes
Oct 23, 2024
leovct
pushed a commit
to leovct/foundry
that referenced
this pull request
Oct 23, 2024
) * replace existing shell::println, add macros * finish replacing shell::println * remove p_println * remove redundant quiet or silent variables * install global shells in binaries * CastArgs -> Cast, Cast -> CastInstance * fix tests, always initialize Mutex::new(Shell::new()) on initial access, for some reason cfg!(test) path is not handled when running with tokio tests * revert .quiet(true) * add back quiet * undo CastInstance -> Cast, Cast -> CastArgs * add global --json format * use global --json flag * revert sequence / multisequence save silent mode * fix failing tests * fix tests * fix tests * replace cli_warn with sh_warn * use shell json directly instead of passing in * clean up, document print modes in respect to --quiet flag * group shell options under display options * revert global --json flag * remove redundant import * fix: quiet * remove faulty argument conflict test as there is no way to currently assert a conflict between global and local args without custom reject at runtime * add back conflicts_with quiet flag, global args w/ conflicts_with works fine * remove yellow() * Apply suggestions from code review - update dependencies - use default Co-authored-by: DaniPopes <57450786+DaniPopes@users.noreply.github.com> * fix deprecated terminal_size method * revert quiet flag, fix os:fd import for windows * add replacing tests, add back quiet conflicting flag * make output windows compatible * to avoid visual regression, style warning message content in yellow, error message content in red - both not bold * fix docs links * fix junit throwing mixed content on warnings, avoid modifying global verbosity * remove set_verbosity shell helper, redundant * revert default .expect on printing, prefer passing. revert message style formatting - no longer style the message * fix doc test, fix formatting * fix merge issues --------- Co-authored-by: DaniPopes <57450786+DaniPopes@users.noreply.github.com>
This was referenced Oct 23, 2024
rplusq
pushed a commit
to rplusq/foundry
that referenced
this pull request
Nov 29, 2024
) * replace existing shell::println, add macros * finish replacing shell::println * remove p_println * remove redundant quiet or silent variables * install global shells in binaries * CastArgs -> Cast, Cast -> CastInstance * fix tests, always initialize Mutex::new(Shell::new()) on initial access, for some reason cfg!(test) path is not handled when running with tokio tests * revert .quiet(true) * add back quiet * undo CastInstance -> Cast, Cast -> CastArgs * add global --json format * use global --json flag * revert sequence / multisequence save silent mode * fix failing tests * fix tests * fix tests * replace cli_warn with sh_warn * use shell json directly instead of passing in * clean up, document print modes in respect to --quiet flag * group shell options under display options * revert global --json flag * remove redundant import * fix: quiet * remove faulty argument conflict test as there is no way to currently assert a conflict between global and local args without custom reject at runtime * add back conflicts_with quiet flag, global args w/ conflicts_with works fine * remove yellow() * Apply suggestions from code review - update dependencies - use default Co-authored-by: DaniPopes <57450786+DaniPopes@users.noreply.github.com> * fix deprecated terminal_size method * revert quiet flag, fix os:fd import for windows * add replacing tests, add back quiet conflicting flag * make output windows compatible * to avoid visual regression, style warning message content in yellow, error message content in red - both not bold * fix docs links * fix junit throwing mixed content on warnings, avoid modifying global verbosity * remove set_verbosity shell helper, redundant * revert default .expect on printing, prefer passing. revert message style formatting - no longer style the message * fix doc test, fix formatting * fix merge issues --------- Co-authored-by: DaniPopes <57450786+DaniPopes@users.noreply.github.com>
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
To unify the shell implementation for improved consistency.
Solution
stdouton logs (sh_println!) andstderron warnings and errors (sh_eprintln!,sh_warn!,sh_err!). If an error occurs upon rendering it is fowarded.--quiet/-qflag, easily checked against withshell::is_quiet()for conditional logicp_println,cli_warn,shell::printlnetc..Changes from initial common shell implementation:
sh_println!/sh_eprintln!/sh_warn!now all listen to the--quietflagsh_println!as opposed tosh_eprintln!stderroutputVisual changes:
Old:
New:
This first PR is the set of minimal changes, a follow up will be done to add it everywhere and to also solve the issues explicitly in #8794