foundry-rs / foundry

Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.
https://getfoundry.sh
Apache License 2.0
8.18k stars 1.7k forks source link

feat(forge): new config option for filtering the contract artifacts which get generated #4979

Open PaulRBerg opened 1 year ago

PaulRBerg commented 1 year ago

Component

Forge

Describe the feature you would like

The idea is to introduce a new config option called filter (or sift) that accepts a list of whitelisted contracts:

[profile.artifacts]
filter = [
  "Foo",
  "Bar",
]

When it sees this config, Forge generates artifacts only for the members listed under filter, regardless of whatever other members may be present in the repository. Note that by "members" in this context, I mean any of the following:

The primary use case is shipping a Node.js package that should include only the production contracts' artifacts - though there may be more use cases than just that. Anything related to artifact generation may benefit from such a feature.

Additional context

In our project, we wrote a Bash script because we couldn't find a way to filter contracts with Foundry itself.

PaulRBerg commented 1 year ago

Sharing the Bash scripts we have used to prepare the Sablier V2 artifacts:

We would love to be able to delete the scripts 😁