meta(output): tracking issue for issues related to output modes (--json, stdout, stderr)

[zerosnacks]

Issues

Shell

• Re-add additional macros like note and status and implement
• Enable Clippy lint, global search and replace.
• feat: add global Rayon thread pool (--jobs) to GlobalOpts #8408
• feat(anvil): enforce verbosity flags (-vvv) to control log verbosity and scope #3704
• Unify verbosity logic of should_include between cast, test, coverage, script, etc.. #8339

Flags

• Many flags are incompatible with each other but not marked as such resulting in a hard crash or unexpected output

-vvv

• Verbosity scale is now not uniformly applied, investigate how to apply , e.g. forge test -vvv should not trigger forge build -v, related Add a way to distinguish whether the user explicitly ran forge build or it is part of a process like forge test #9340

--json

• bug: forge test --gas-report --json yields unexpected data and misses data #8789
• bug(forge test): JSON output should consistently adhere to verbosity flags #8735
• bug: traces field is missing when display option --json is set #6922
• feat(forge test) add an optional --json-file argument to write both to stdout and to a JSON file #2210
• feat(cast): add an unformatted output mode #6600
• feat(cast): add event-decode command to parsing and formatting log data #6511
• JSON export for flamegraph #8926
• feat(coverage): add --json compatibility to forge coverage --report summary #4071
• feat(cast): add --json flag in cast wallet new-mnemonic #9138
• forge create --verify is incompatible with --json, gives mixed output #1976.
• forge build --sizes is not compatible
• forge build --names is not compatible
• forge build --format-json always prints (even if empty) when combined with other flags
• forge script --json is not clean
• forge script --quiet is not quiet (indicatif progress bars to do not respect output redirecting #3981)
• forge test --summary --detailed --json does not print summary
• Introduce a global --json flag, similar to the global --quiet flag: feat: add global --json flag #9244
• With shell::Format::Json enabled set the verbosity to quiet, disabling all output except for errors.
• Introduce a sh_json! macro that renders JSON to the console if shell::Format::Json is active, either pretty or not. This could be automatically a no-op in anything except when the --json flag is passed.
• Make sure all commands and modes are --json compatible, related: meta(output): tracking issue for issues related to output modes (--json, stdout, stderr) #8794. With the current proposed change Anvil for example now has a --json flag but is not yet compatible. What --json means in context dependent to the command / tool. Goal is that it becomes much easier to chain Foundry into other tools.

stdout, stderr

• bug(cast): failed printing to stdout: Broken pipe (os error 32) #8568
• bug: forge script crash when piping to command that doesn't take stdin: "failed printing to stdout: Broken pipe (os error 32)" #7055
• forge create --verify is incompatible with --json, gives mixed output #1976
• indicatif progress bars to do not respect output redirecting #3981
• feat: route all prints through common::shell #6569 (resolves above)
• Allow avoiding passing large arguments through program args #5069

To check / fix post #9109:

• Evaluate Pretty printed ABI from Forge Inspect #2433.
• Evaluate bug: forge script crash when piping to command that doesn't take stdin: "failed printing to stdout: Broken pipe (os error 32)" #7055.
• Evaluate bug(cast): failed printing to stdout: Broken pipe (os error 32) #8568

[sakulstra]

I think is not yet referenced here yet, but another command where --json output would be important is build --sizes.

In our CIs we're currently jumping trough hoops to track changes in contract size and gas consumption.