Document the new formatter

foundry-rs / book

A book on all things Foundry, available at https://book.getfoundry.sh.

https://book.getfoundry.sh

Apache License 2.0

779 stars 618 forks source link

Document the new formatter #38

Open onbjerg opened 2 years ago

onbjerg commented 2 years ago

See https://github.com/gakonst/foundry/pull/201

It is a pretty barebones opinionated formatter with write and diff capabilities, but it is not configurable. Regardless, we should document it (and also add it to the GHA example)

onbjerg commented 2 years ago

Actually, this is in the icebox, apparently it is not 100% ready yet. Will update this issue with more context when I have it

onbjerg commented 2 years ago

Also relevant: https://github.com/foundry-rs/foundry/pull/2533

gakonst commented 2 years ago

Formatter is complete now and has a few configuration options under [fmt] for foundry toml

onbjerg commented 2 years ago

Those are documented except 1 :) Just need an intro guide + the command reference

gakonst commented 2 years ago

Also the disabling stuff

// forgefmt: disable-next-item
// forgefmt: disable-next-line
// forgefmt: disable-start
// forgefmt: disable-end