feat: add the natspec-smells command

README.md

@@ -22,7 +22,8 @@
   <dd>Example tests showcasing mocking, assertions and configuration for mainnet forking. As well it includes everything needed in order to check code coverage.</dd>
 
   <dt>Linter</dt>
-  <dd>Simple and fast solidity linting thanks to forge fmt</a>.</dd>
+  <dd>Simple and fast solidity linting thanks to forge fmt.</dd>
+  <dd>Find missing natspec automatically.</dd>
 
   <dt>Github workflows CI</dt>
   <dd>Run all tests and see the coverage as you push your changes.</dd>

package.json

@@ -17,6 +17,7 @@
     "deploy:sepolia": "bash -c 'source .env && forge script DeploySepolia --rpc-url $SEPOLIA_RPC --broadcast --private-key $SEPOLIA_DEPLOYER_PK --verify --etherscan-api-key $ETHERSCAN_API_KEY'",
     "lint:check": "yarn lint:sol-tests && yarn lint:sol-logic && forge fmt --check",
     "lint:fix": "sort-package-json && forge fmt && yarn lint:sol-tests --fix && yarn lint:sol-logic --fix",
+    "lint:natspec": "npx @defi-wonderland/natspec-smells --config natspec-smells.config.js",
     "lint:sol-logic": "solhint -c .solhint.json 'src/contracts/**/*.sol' 'src/interfaces/**/*.sol'",
     "lint:sol-tests": "solhint 'test/**/*.sol'",
     "prepare": "husky install",