Merge branch 'main' into chore/bump-version-1.1.0

defi-wonderland · Feb 14, 2024 · 62df23d · 62df23d
2 parents 1636896 + 607a8ed
commit 62df23d
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 6 deletions.
diff --git a/.prettierrc b/.prettierrc
@@ -12,10 +12,11 @@
       }
     },
     {
-      "files": "**.json",
+      "files": ["**.json", "**.md"],
       "options": {
         "tabWidth": 2,
-        "printWidth": 200
+        "printWidth": 200,
+        "singleQuote": true
       }
     }
   ]

diff --git a/README.md b/README.md
@@ -20,9 +20,12 @@ Want to quickly check if your natspec smells?
 Just run:
 
 ```
-npx @defi-wonderland/natspec-smells --include solidity --exclude solidity/(test|scripts)/**/*.sol
+npx @defi-wonderland/natspec-smells --include src --exclude "src/**/*.sol" "(test|scripts)/**/*.sol"
 ```
 
+> [!NOTE]
+> Remember to put quotes around the glob strings when using the `include` and `exclude` options.
+
 ## Recommended setup
 
 1. Install the package:
@@ -40,8 +43,8 @@ npx @defi-wonderland/natspec-smells --include solidity --exclude solidity/(test|
 
    /** @type {import('@defi-wonderland/natspec-smells').Config} */
    module.exports = {
-     include: "solidity",
-     exclude: ["solidity/(test|scripts)/**/*.sol"],
+     include: 'src/**/*.sol',
+     exclude: '(test|scripts)/**/*.sol',
    };
    ```
 
@@ -59,7 +62,7 @@ _Soon to come._
 | Option               | Description                                                        | Required | Default |
 | -------------------- | ------------------------------------------------------------------ | -------- | ------- |
 | `include`            | Glob pattern of files to process.                                  | Yes      |         |
-| `exclude`            | Glob patterns of files to exclude.                                 | No       | `[]`    |
+| `exclude`            | Glob pattern of files to exclude.                                  | No       | `""`    |
 | `root`               | Project root directory.                                            | No       | `./`    |
 | `enforceInheritdoc`  | True if all external and public functions should have @inheritdoc. | No       | `true`  |
 | `constructorNatspec` | True if the constructor should have natspec.                       | No       | `false` |