Pretty printed ABI from Forge Inspect

[maurelian]

Component

Forge

Describe the feature you would like

Issue

forge inspect <ContractName> abi only prints a json formatted abi.

That wouldn't be an issue, if it were possible to easily pipe the output to jq however the warnings printed at the beginning of the output prevent that work working.

Suggested Feature

A --pretty formatting (similar to what's available for storageLayout) of the output would be great to have.

Additional context

Current output looks like this (I see now that the warnings are pretty easy to resolve):

$ forge inspect --pretty L1CrossDomainMessenger abi
warning: Unknown section [ci] found in foundry.toml. This notation for profiles has been deprecated and may result in the profile not being registered in future versions. Please use [profile.default] instead or run `forge config --fix`.
warning: Unknown section [default] found in foundry.toml. This notation for profiles has been deprecated and may result in the profile not being registered in future versions. Please use [profile.default] instead or run `forge config --fix`.
warning: Unknown section [default] found in node_modules/excessively-safe-call/foundry.toml. This notation for profiles has been deprecated and may result in the profile not being registered in future versions. Please use [profile.default] instead or run `forge config --fix`.
[
  {
    "inputs": [
      {
        "internalType": "contract OptimismPortal",
        "name": "_portal",
        "type": "address"
      }
    ],
    ...

[onbjerg]

Not following entirely: do you want --pretty to print a table? If so, any thoughts on events vs functions in this output? 😄

[sambacha]

He wants something along the lines of:

forge $cmd | tail -n +2 | tee $outputFile

[onbjerg]

No, removing the warnings seems secondary - the only reason the warnings are wanted to be gone is because the output is not pipeable into jq, so it is not possible to construct a prettified output yourself. I'm fairly confident it is about wanting a table?

[mds1]

One idea is to have --pretty print the interfaces the same way that cast interface does, e.g. as a Solidity interface. Though cast interface doesn't handle structs well and just prints tuples with generic variable names of a, b, etc.

[maurelian]

A table would be fine.
So would something like cast interface.
Ideally it has all of the info available in an abi entry, just easier to read.

[ghost]

@maurelian is this still open and in need of work? If yes, can I pick it up?

[maurelian]

@maurelian is this still open and in need of work? If yes, can I pick it up?

@timofeli I'm just a user. @gakonst wdyt?

[gakonst]

Yes! Go for it @timofeli

[drortirosh]

I think that in general, warnings should be sent to stderr, not stdout

[zerosnacks]

Marking this as resolved, forge inspect Counter abi now outputs in pretty print format

[pstephenwille]

this is pretty helpful
forge inspect ./src/TicTacToe.sol:TicTacToe abi > ttt.abi.json