Option to ignore warnings from dependencies in foundry.toml

[pmdaly]

Component

Forge

Describe the feature you would like

Some of my projects have dependencies I can't change. Due to implementations of some of the abstract contracts, there are unused imports that cause warnings. These warnings spam my stdout and aren't relevant to my projects. I'd like the ability to silence warnings from dependencies.

Additional context

No response

[Alef-gabriel]

I can take this?

[mattsse]

sure!
I think this would require parsing the error message and check where they originated from

lmk if you need some pointers, happy to take a look where we can get that info

[Alef-gabriel]

@mattsse of course, thanks

[Alef-gabriel]

Hello guys I tried to replicate your issue but I couldn't. Could you share exactly what I do?

[guidanoli]

@Alef-gabriel To replicate this problem, try this project. It should raise several warnings:

Warning (2519): This declaration shadows an existing declaration.
  --> ../node_modules/@ensdomains/ens-contracts/contracts/registry/ENSRegistry.sol:20:9:
   |
20 |         address owner = records[node].owner;
   |         ^^^^^^^^^^^^^
Note: The shadowed declaration is here:
   --> ../node_modules/@ensdomains/ens-contracts/contracts/registry/ENSRegistry.sol:143:5:
    |
143 |     function owner(
    |     ^ (Relevant source part starts here and spans across multiple lines).

[...]

[wottpal]

@guidanoli Did you find any solution to this?

[mattsse]

@loocapro perhaps you want to take this?

I believe this can be solved with:

• an option in the foundry config to enable this:

  foundry/crates/config/src/lib.rs

  Line 636 in 00cec1d

  .ignore_error_codes(self.ignored_error_codes.iter().copied().map(Into::into))

• some helpers in the ProjectCompileOutput type so we can ignore warnings that originate from certain files: https://github.com/foundry-rs/compilers/blob/9d91a56dadfe0f86d21c875f306e7150098ebac2/src/compile/output/mod.rs#L465-L467 which is invoked here:

  foundry/crates/common/src/compile.rs

  Lines 207 to 208 in 00cec1d

  	// print the compiler output / warnings
  	println!("{output}");

  
  we can leverage the ProjectPaths type which has access to all library paths for example

The current workflow wrt to ignored errors is:
configure ignored error types in foundry.toml, which is then configured in the foundry_compilers::Project:

foundry/crates/config/src/lib.rs

Line 636 in 00cec1d

.ignore_error_codes(self.ignored_error_codes.iter().copied().map(Into::into))

I think we want to enhance that setting to also make it possible to ignore paths

[mattsse]

but for this specific error @wottpal you can silence this via:

ignored_error_codes = ["shadowing"], though this apply to all files atm

[wottpal]

but for this specific error @wottpal you can silence this via:

ignored_error_codes = ["shadowing"], though this apply to all files atm

Great, that already removes a lot of warnings when having ens contracts as a dependency in node_modules. Thanks!

But some are still persisting:

Compiler run successful with warnings:
Warning (1878): SPDX license identifier not provided in source file. Before publishing, consider adding a comment containing "SPDX-License-Identifier: <SPDX-License>" to each source file. Use "SPDX-License-Identifier: UNLICENSED" for non-open-source code. Please see https://spdx.org for more information.
--> node_modules/@ensdomains/ens-contracts/contracts/ethregistrar/IBaseRegistrar.sol

Warning (1878): SPDX license identifier not provided in source file. Before publishing, consider adding a comment containing "SPDX-License-Identifier: <SPDX-License>" to each source file. Use "SPDX-License-Identifier: UNLICENSED" for non-open-source code. Please see https://spdx.org for more information.
--> node_modules/@ensdomains/ens-contracts/contracts/ethregistrar/StringUtils.sol

Warning (1878): SPDX license identifier not provided in source file. Before publishing, consider adding a comment containing "SPDX-License-Identifier: <SPDX-License>" to each source file. Use "SPDX-License-Identifier: UNLICENSED" for non-open-source code. Please see https://spdx.org for more information.
--> node_modules/@ensdomains/ens-contracts/contracts/registry/ENS.sol

Warning (1878): SPDX license identifier not provided in source file. Before publishing, consider adding a comment containing "SPDX-License-Identifier: <SPDX-License>" to each source file. Use "SPDX-License-Identifier: UNLICENSED" for non-open-source code. Please see https://spdx.org for more information.
--> node_modules/@ensdomains/ens-contracts/contracts/registry/ENSRegistry.sol

Warning (1878): SPDX license identifier not provided in source file. Before publishing, consider adding a comment containing "SPDX-License-Identifier: <SPDX-License>" to each source file. Use "SPDX-License-Identifier: UNLICENSED" for non-open-source code. Please see https://spdx.org for more information.
--> node_modules/@ensdomains/ens-contracts/contracts/reverseRegistrar/IReverseRegistrar.sol

Warning (1878): SPDX license identifier not provided in source file. Before publishing, consider adding a comment containing "SPDX-License-Identifier: <SPDX-License>" to each source file. Use "SPDX-License-Identifier: UNLICENSED" for non-open-source code. Please see https://spdx.org for more information.
--> node_modules/@ensdomains/ens-contracts/contracts/root/Controllable.sol

Warning (3420): Source file does not specify required compiler version! Consider adding "pragma solidity ^0.8.22;"
--> node_modules/@ensdomains/ens-contracts/contracts/ethregistrar/IBaseRegistrar.sol

Warning (2462): Visibility for constructor is ignored. If you want the contract to be non-deployable, making it "abstract" is sufficient.
  --> node_modules/@ensdomains/ens-contracts/contracts/registry/ENSRegistry.sol:28:5:
   |
28 |     constructor() public {
   |     ^ (Relevant source part starts here and spans across multiple lines).

And ofc I could just ignore the specific error code, but actually I would like to get those for all files under src/, just not node_modules/ :)

[mattsse]

here's a list of supported aliases:

foundry/crates/config/src/error.rs

Lines 202 to 214 in 00cec1d

	"unreachable" => SolidityErrorCode::Unreachable,
	"unused-return" => SolidityErrorCode::UnnamedReturnVariable,
	"unused-param" => SolidityErrorCode::UnusedFunctionParameter,
	"unused-var" => SolidityErrorCode::UnusedLocalVariable,
	"code-size" => SolidityErrorCode::ContractExceeds24576Bytes,
	"init-code-size" => SolidityErrorCode::ContractInitCodeSizeExceeds49152Bytes,
	"shadowing" => SolidityErrorCode::ShadowsExistingDeclaration,
	"func-mutability" => SolidityErrorCode::FunctionStateMutabilityCanBeRestricted,
	"license" => SolidityErrorCode::SpdxLicenseNotProvided,
	"pragma-solidity" => SolidityErrorCode::PragmaSolidity,
	"virtual-interfaces" => SolidityErrorCode::InterfacesExplicitlyVirtual,
	"missing-receive-ether" => SolidityErrorCode::PayableNoReceiveEther,
	"same-varname" => SolidityErrorCode::DeclarationSameNameAsAnother,

but the error code works as well

[loocapro]

@loocapro perhaps you want to take this?

Sure, I can take it!

[mattsse]

this is now supported via new config setting ignored_warnings_from = [path],

will add to book