chore: add natspec-smells and config

allo-protocol · Aug 26, 2024 · d1ff82a · d1ff82a
1 parent 5bae660
commit d1ff82a
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/natspec-smells.config.js b/natspec-smells.config.js
@@ -0,0 +1,10 @@
+/**
+ * List of supported options: https://github.com/defi-wonderland/natspec-smells?tab=readme-ov-file#options
+ */
+
+/** @type {import('@defi-wonderland/natspec-smells').Config} */
+module.exports = {
+  include: 'contracts/(extensions|core|strategies)/**/*.sol',
+  exclude: 'contracts/strategies/_poc/**/*.sol',
+  enforceInheritdoc: false,
+};
diff --git a/package.json b/package.json
@@ -33,6 +33,7 @@
     "smock": "smock-foundry --contracts contracts/core"
   },
   "devDependencies": {
+    "@defi-wonderland/natspec-smells": "^1.1.5",
     "@matterlabs/hardhat-zksync-deploy": "^1.2.1",
     "@matterlabs/hardhat-zksync-solc": "^1.1.4",
     "@matterlabs/hardhat-zksync-upgradable": "^1.3.1",