feat(`forge build`): prettify compiled contract JSON artifacts

[gnapoli23]

Component

Forge

Describe the feature you would like

It would be easier to read JSON artifacts by having them compiled in a pretty way, maybe using a setting in the foundry.toml file allowing you to specify tabs and spaces for the output.
Using an external tool to do so it's only a temporary workaround, 'cause the contract would be always compiled in a non-pretty form if you make some changes and have the need of rebuilding it.

Additional context

No response

[zerosnacks]

Hi @gnapoli23 thanks for your suggestion

I think this is relevant to the foundry/compilers repo, moving it there

compilers/crates/compilers/src/artifact_output/mod.rs

Line 129 in afa7569

utils::write_json_file(&self.artifact, &self.file, 64 * 1024)

A downside would be that pretty formatted artifacts have a larger filesize and it could be a breaking change if users are currently parsing by line as we expect in some other cases of JSON output

[gnapoli23]

Would be worth considering it as an optional feature which can be enabled on demand?
Eg in foundry.toml:

...
[output.fmt]
pretty = true
tabs = 2

[DaniPopes]

This is not desirable as it slows significantly every serialization and deserialization. If you want to inspect an artifact you can use 'forge inspect' or prettify it yourself by using your code editor's formatter, jq in the CLI etc.

[gnapoli23]

This is not desirable as it slows significantly every serialization and deserialization. If you want to inspect an artifact you can use 'forge inspect' or prettify it yourself by using your code editor's formatter, jq in the CLI etc.

If made as an opt-in, the feature would not slow down serde if the user does not uses it. One can prettify the code manually, but then you should not commit/push those changes to the remote versioned files, and then restore them. This scenario, with large codebases, would be even more annoying.