Add reason-string to recommended ruleset

celo-org · May 5, 2020 · 56ff271 · 56ff271
1 parent 4b2a229
commit 56ff271
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 2 deletions.
diff --git a/docs/rules.md b/docs/rules.md
@@ -15,7 +15,7 @@ title:       "Rule Index of Solhint"
 | [no-empty-blocks](./rules/best-practises/no-empty-blocks.md)       | Code contains empty block.                                                                                            | ✔️          |
 | [no-unused-vars](./rules/best-practises/no-unused-vars.md)         | Variable "name" is unused.                                                                                            | ✔️          |
 | [payable-fallback](./rules/best-practises/payable-fallback.md)     | When fallback is not payable you will not be able to receive ethers.                                                  | ✔️          |
-| [reason-string](./rules/best-practises/reason-string.md)           | Require or revert statement must have a reason string and check that each reason string is at most N characters long. |             |
+| [reason-string](./rules/best-practises/reason-string.md)           | Require or revert statement must have a reason string and check that each reason string is at most N characters long. | ✔️          |
 | [constructor-syntax](./rules/best-practises/constructor-syntax.md) | Constructors should use the new constructor keyword.                                                                  |             |
         
 

diff --git a/docs/rules/best-practises/reason-string.md b/docs/rules/best-practises/reason-string.md
@@ -5,8 +5,11 @@ title:       "reason-string | Solhint"
 ---
 
 # reason-string
+![Recommended Badge](https://img.shields.io/badge/-Recommended-brightgreen)
 ![Category Badge](https://img.shields.io/badge/-Best%20Practise%20Rules-informational)
 ![Default Severity Badge warn](https://img.shields.io/badge/Default%20Severity-warn-yellow)
+> The {"extends": "solhint:recommended"} property in a configuration file enables this rule.
+
 
 ## Description
 Require or revert statement must have a reason string and check that each reason string is at most N characters long.

diff --git a/lib/rules/best-practises/reason-string.js b/lib/rules/best-practises/reason-string.js
@@ -42,7 +42,7 @@ const meta = {
   },
 
   isDefault: false,
-  recommended: false,
+  recommended: true,
   defaultSetup: [DEFAULT_SEVERITY, DEFAULT_OPTION],
 
   schema: {