From 36e0b505915adf14fd9c431a279453937aa8647f Mon Sep 17 00:00:00 2001
From: Gas One Cent <86567384+gas1cent@users.noreply.github.com>
Date: Fri, 2 Feb 2024 15:37:37 +0400
Subject: [PATCH] feat: add the `natspec-smells` command
---
README.md | 3 ++-
package.json | 1 +
2 files changed, 3 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 064ef1a1..6c0f8467 100644
--- a/README.md
+++ b/README.md
@@ -22,7 +22,8 @@
Example tests showcasing mocking, assertions and configuration for mainnet forking. As well it includes everything needed in order to check code coverage.
Linter
- Simple and fast solidity linting thanks to forge fmt.
+ Simple and fast solidity linting thanks to forge fmt.
+ Find missing natspec automatically.
Github workflows CI
Run all tests and see the coverage as you push your changes.
diff --git a/package.json b/package.json
index af05812c..5eec9bcb 100644
--- a/package.json
+++ b/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",