feat: add --skip <filter> to forge build

[mattsse]

Motivation

Closes #3366

add --skip <filter> to exclude matching contracts, with aliases for tests (--skip tests) and scripts (--skip scripts).

--skip tests scripts for excluding *.[s].sol contracts

cc @tynes

Solution

[mds1]

nit, but should we change to test and skip to match the default folder names? or was this intentional to not match those folder names?

Suggested change

	cmd.args(["build", "--skip", "tests", "--skip", "scripts"]);
	cmd.args(["build", "--skip", "test", "--skip", "script"]);

[mattsse]

that actually makes more sense, I guess we can just do test[s]? and script[s]?

[mds1]

seems reasonable to me!

[tynes]

Thank you!

[holic]

This is great! Thoughts on adding this to forge test and/or foundry config (for applying to both commands)?

Currently, if I run forge build --skip test script, I get just the files I need in out. Then if you run forge test, build files from tests end up appearing in out.

(I can work around this temporarily by specifying a separate --out for tests)

[mds1]

I'd prefer not adding --skip to forge test for two reasons:

• You can use the matchers like --no-match-test to exclude tests
• IMO vm.skip(bool) cheat is more flexible and better UX for skipping tests: Function Modifier or an Opcode to mark a test as skipped conditionally #1123 (edit: but on re-reading your comment @holic, I'm not sure that's actually what you're trying to do)

@holic Why do you want your test artifacts in a different directory than contract artifacts?

[holic]

It's not that I want to skip particular tests, but rather skip generating build files for tests.

I am checking into git the contract artifacts (the results of forge build created in out), specifically ABIs, but don't need to check in test/script artifacts (e.g. SomeTest.t.sol).

I use these ABIs to generate types (also checked in), and including tests and scripts means there's a bunch of unnecessary type generation happening. In the type generation step, I am currently ignoring these files manually: https://github.com/holic/web3-scaffold/blob/main/packages/contracts/package.json#L14

If I instead --skip these as part of forge build, I don't need to do any ignoring like above, but I still get tests artifacts being generated when running forge test (as in the forge output is no longer the same between build and test).

Lemme know if all that makes sense?

[holic]

Writing all that out, I am now thinking it might be better for me to have a specific build command for generating checked-in files (e.g. ABIs) to their own directory rather and trying to conditionally ignore certain build files in out (and gitignore the whole build/out dir).