ci: use lintspec instead of natspec-smells

Author: 0xteddybear

.github/workflows/tests.yml

@@ -123,6 +123,12 @@ jobs:
         with:
           version: stable
 
+      - name: Install lintspec via cargo
+        uses: baptiste0928/cargo-install@v3
+        with:
+          crate: lintspec
+          version: '0.3.0'
+
       - name: Use Node.js
         uses: actions/setup-node@v4
         with:
@@ -132,4 +138,8 @@ jobs:
       - name: Install dependencies
         run: yarn --frozen-lockfile --network-concurrency 1
 
+      - name: Run solhint and forge-fmt
       - run: yarn lint:check
+
+      - name: Run lintspec
+      - run: yarn lint:natspec

README.md

@@ -36,7 +36,8 @@
 
 1. Install Foundry by following the instructions from [their repository](https://github.com/foundry-rs/foundry#installation).
 2. Copy the `.env.example` file to `.env` and fill in the variables.
-3. Install the dependencies by running: `yarn install`. In case there is an error with the commands, run `foundryup` and try them again.
+3. Install rust dependencies: `cargo install lintspec`
+4. Install the dependencies by running: `yarn install`. In case there is an error with the commands, run `foundryup` and try them again.
 
 ## Build
 

natspec-smells.config.js

@@ -17,7 +17,7 @@
     "deploy:sepolia": "bash -c 'source .env && forge script Deploy --rpc-url $SEPOLIA_RPC --account $SEPOLIA_DEPLOYER_NAME --broadcast --verify --chain sepolia -vvvvv'",
     "lint:check": "yarn lint:sol && forge fmt --check",
     "lint:fix": "sort-package-json && forge fmt && yarn lint:sol --fix",
-    "lint:natspec": "npx @defi-wonderland/natspec-smells --config natspec-smells.config.js",
+    "lint:natspec": "lintspec src",
     "lint:sol": "solhint 'src/**/*.sol' 'script/**/*.sol' 'test/**/*.sol'",
     "prepare": "husky",
     "test": "forge test -vvv",
@@ -35,7 +35,6 @@
   "devDependencies": {
     "@commitlint/cli": "19.3.0",
     "@commitlint/config-conventional": "19.2.2",
-    "@defi-wonderland/natspec-smells": "1.1.6",
     "forge-std": "github:foundry-rs/forge-std#1.9.2",
     "halmos-cheatcodes": "github:a16z/halmos-cheatcodes#c0d8655",
     "husky": ">=9",