Open PaulRBerg opened 9 months ago
I'd suggest requiring the config to just live in foundry.toml
to avoid needing new config files for each tool. See https://github.com/foundry-rs/foundry/issues/5866 for my suggestion on how this would look
Tbh, I have conflicting feelings over this one. I totally agree with having a config file. However, if the only advantage of having the config inside foundry.toml
is having one less file in the project, I'd rather use a separate bulloak.toml
. I know people have hated having way-too-many config files historically, but I don't really mind it.
The rationale for a separate bulloak.toml
is:
foundry.toml
.external
(or whatever is chosen) and the config will be surrounded by unrelated configs.Foundry
. This is not a strong argument, bulloak
is already coupled to Foundry, however, that might change in the future.foundry.toml
.That being said, I'm not strongly opinionated.
I know people have hated having way-too-many config files historically, but I don't really mind it.
Me neither!
bulloak
is already coupled to Foundry, however, that might change in the future.
TBH I can see Bulloak used for other blockchain programming languages + paradigms other than crypto.
The rationale for a separate bulloak.toml
Agree with all points
Things that I would like to configure (and which Bulloak would apply to all Solidity code generated via
scaffold
):Indenting (4 spaces instead of 2): https://github.com/alexfertel/bulloak/issues/40
SPDX license
compiler pragma as a string (e.g.,
>=0.8.19
)GPT processing: https://github.com/alexfertel/bulloak/issues/39
Whether I want a bespoke name for the final leaf (ref https://github.com/alexfertel/bulloak/issues/37)
Whether I want one-test-per-it-branch or bundled-its (ref https://github.com/alexfertel/bulloak/discussions/7#discussioncomment-6965212) https://github.com/alexfertel/bulloak/discussions/7#discussioncomment-7131740) Potentially helpful for other users:
Case sensitivity (ref https://github.com/alexfertel/bulloak/issues/20)
It would be nice if these settings could be kept in
foundry.toml
somehow, but I don't think Foundry allows custom configs.I'm sure @mds1 and future users will find other use cases with this config file.