feat: add natspec-smells

defi-wonderland · Jan 18, 2024 · 7bba7a0 · 7bba7a0
1 parent ee25b3f
commit 7bba7a0
Show file tree

Hide file tree

Showing 3 changed files with 457 additions and 10 deletions.
diff --git a/natspec-smells.config.js b/natspec-smells.config.js
@@ -0,0 +1,9 @@
+/**
+ * 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: 'solidity',
+  exclude: ['solidity/(test|scripts)/**/*.sol'],
+};
diff --git a/package.json b/package.json
@@ -37,6 +37,7 @@
   "devDependencies": {
     "@commitlint/cli": "17.0.3",
     "@commitlint/config-conventional": "17.0.3",
+    "@defi-wonderland/natspec-smells": "^1.0.2",
     "ds-test": "github:dapphub/ds-test#e282159",
     "forge-std": "github:foundry-rs/forge-std#v1.7.3",
     "husky": ">=8",