lint: "invalid natspec" doesn't consider `ignore` config

[frontier159]

Component

Forge

Have you ensured that all of these are up to date?

• Foundry
• Foundryup

What version of Foundry are you on?

1.4.4-stable

What version of Foundryup are you on?

1.3.0

What command(s) is the bug in?

forge build

Operating System

None

Describe the bug

forge build (or lint) throws a hard error when the natspec parsing fails, even if the file is within the ignore list in foundry.toml

AFAIK there isn't a exclude_lints rule to exclude natspec linting - but could be a skill issue in finding.

The issue is that these could come from upstream libraries which can't easily be updated, so need to be excluded.

Example contract:

pragma solidity ^0.8.19;
// SPDX-License-Identifier: AGPL-3.0-or-later

/// Some editors highlight `@note` or `@todo`
/// @note foo bar

/// @title Foo
contract Foo {
    /**
    some example code in a comment:
    import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol";
    ...
    */
}

output:

Error: Lint failed

Context:
- solar run failed:

error: invalid natspec tag '@note', custom tags must use format '@custom:name'
 --> contracts/external/cowprotocol/GPv2Order.sol:6:1
  |
6 | /// @note Forked from https://github.com/cowprotocol/contracts/blob/main/src/contracts/libraries/GPv2Order.sol
  | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

error: invalid natspec tag '@note`', custom tags must use format '@custom:name'
 --> contracts/investments/sky/Foo.sol:4:1
  |
4 | /// Some editors highlight `@note` or `@todo`
  | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

[0xrusowsky]

there are 2 different issues here:

1. solar has a natspec parsing bug where it flags @ which not correspond to actual natspec tags: [Bug] parse_natspec() bad tag parsing logic paradigmxyz/solar#595
2. invalid natspec tags

afaik both solc and solar treat natspec as actual code, and as such their parsers perform
validation on the tags. /// @note is invalid and will throw an error preventing compilation:

when testing this contract with solc i get an error:

pragma solidity ^0.8.19;
// SPDX-License-Identifier: AGPL-3.0-or-later

/// @note this is an invalid natspec tag
contract Foo {}

     Error: Documentation tag @note not valid for contracts.
      --> test_contract.sol:4:1:
       |
     4 | /// @note this is an invalid natspec tag
       | ^ (Relevant source part starts here and spans across multiple lines).

because of the above, this is not a lint, its an actual compiler error. Which means that we don't have control over it at the linter level.

with that being said, i'm not sure about how u were able to compile this contract before we added natspec support in solar