Lintspec, the NatSpec linter

[beeb]

You might know natspec-smells, a tool to check your NatSpec comments to make sure you documented all your functions and their parameters, and more.

I've used this tool since it came out last year and was never really happy using it. It's extremely slow, especially on big repos, requires to install node and npm, and throws an error if some imported dependency cannot be found (even it it's installed properly, just because it doesn't resolve remappings correctly).

Presenting lintspec: https://github.com/beeb/lintspec

Often more than 200x faster than natspec-smells it's also more customizable and has a few additional features.

I invite you to try it out and give feedback! Either here or via the GitHub issues. :)
Note that it can also run in CI via GitHub Actions.

Note: the nix package just got merged so it's not yet available on nixpkgs-unstable, should be up in a few days.

[zerosnacks]

Amazing!

@0xKitsune is currently working on forge lint which uses Solar, that may be of interest to you

Would love to see these NatSpec lint rules implemented there

Any feedback on the forge lint PR is also greatly appreciated

#9590

[beeb]

Really cool! I'll be sure to check it out. Lintspec can be used as a library so it should be fairly easy to include in forge, but it uses slang_solidity for parsing. I'm sure there would be a way to decouple the parsing from the validation though (I would love to support multiple parsing backends but it would require a lot more work). And the NatSpec comment parser is bespoke and implemented with winnow so definitely pluggable into anything.