feat(forge): inspect - default to pretty output

[yash-atreya]

Motivation

Closes #5165

Solution

• Removes the --pretty flag and makes that behavior the default.
• Generate table layout for abi, method-identifiers, errors, and events by default, json can be obtained using the --json.
• For artifacts fields that are not table-friendly, generate json by default.

[grandizzy]

per comment #5165 (comment) I think we want to totally remove the --pretty flag (and rely only on shell::is_json()) and have table applied for abi too, that is instead an output like below to be printed a table

forge inspect src/Counter.sol:Counter abi
interface Counter {
    error MyError();

    event MyEvent();

    function increment() external;
    function number() external view returns (uint256);
    function setNumber(uint256 newNumber) external;
}

hope I got this right, @zerosnacks pls correct me if I am wrong

[zerosnacks]

per comment #5165 (comment) I think we want to totally remove the --pretty flag (and rely only on shell::is_json()) and have table applied for abi too, that is instead an output like below to be printed a table

forge inspect src/Counter.sol:Counter abi
interface Counter {
    error MyError();

    event MyEvent();

    function increment() external;
    function number() external view returns (uint256);
    function setNumber(uint256 newNumber) external;
}

hope I got this right, @zerosnacks pls correct me if I am wrong

Agreed, we want to optimize the default output for human readability and if users want to use the output in a script they should rely on the --json flag

[DaniPopes]

we should keep this with a warning or document as a breaking change

[grandizzy]

yeah, will be marked in release notes as breaking change given the breaking label

[zerosnacks]

for reference: cast interface <CONTRACT> also works on local artifacts for users that do look for a way to generate an interface

[yash-atreya]

@grandizzy @zerosnacks ptal

[zerosnacks]

generally lgtm, note on additional tests + minor style nit

in the release note we can mention the cast interface <CONTRACT> equivalent

[grandizzy]

lgtm, pending @zerosnacks review

[zerosnacks]

lgtm!