Merge pull request #1470 from ardislu/dev

Fix `naming-convention` to flag single letter `O` or `I` variable
crytic · Dec 20, 2022 · 696b42e · 696b42e
2 parents ed8e585 + 82ab988
commit 696b42e
Show file tree

Hide file tree

Showing 9 changed files with 1,170 additions and 67 deletions.
diff --git a/slither/detectors/naming_convention/naming_convention.py b/slither/detectors/naming_convention/naming_convention.py
@@ -119,22 +119,21 @@ def _detect(self):  # pylint: disable=too-many-branches,too-many-statements
 
             for var in contract.state_variables_declared:
                 if self.should_avoid_name(var.name):
-                    if not self.is_upper_case_with_underscores(var.name):
-                        info = [
-                            "Variable ",
-                            var,
-                            " used l, O, I, which should not be used\n",
-                        ]
+                    info = [
+                        "Variable ",
+                        var,
+                        " is single letter l, O, or I, which should not be used\n",
+                    ]
 
-                        res = self.generate_result(info)
-                        res.add(
-                            var,
-                            {
-                                "target": "variable",
-                                "convention": "l_O_I_should_not_be_used",
-                            },
-                        )
-                        results.append(res)
+                    res = self.generate_result(info)
+                    res.add(
+                        var,
+                        {
+                            "target": "variable",
+                            "convention": "l_O_I_should_not_be_used",
+                        },
+                    )
+                    results.append(res)
 
                 if var.is_constant is True:
                     # For ERC20 compatibility

diff --git a/tests/detectors/naming-convention/0.4.25/naming_convention.sol b/tests/detectors/naming-convention/0.4.25/naming_convention.sol
@@ -65,6 +65,8 @@ contract T {
     uint constant M = 1;
 
     uint l = 1;
+    uint O = 1;
+    uint I = 1;
 }
 
 contract ParameterNameEmptyString {

diff --git a/tests/detectors/naming-convention/0.4.25/naming_convention.sol.0.4.25.NamingConvention.json b/tests/detectors/naming-convention/0.4.25/naming_convention.sol.0.4.25.NamingConvention.json
diff --git a/tests/detectors/naming-convention/0.5.16/naming_convention.sol b/tests/detectors/naming-convention/0.5.16/naming_convention.sol
@@ -65,6 +65,8 @@ contract T {
     uint constant M = 1;
 
     uint l = 1;
+    uint O = 1;
+    uint I = 1;
 }
 
 contract ParameterNameEmptyString {

diff --git a/tests/detectors/naming-convention/0.5.16/naming_convention.sol.0.5.16.NamingConvention.json b/tests/detectors/naming-convention/0.5.16/naming_convention.sol.0.5.16.NamingConvention.json
diff --git a/tests/detectors/naming-convention/0.6.11/naming_convention.sol b/tests/detectors/naming-convention/0.6.11/naming_convention.sol
@@ -65,6 +65,8 @@ contract T {
     uint constant M = 1;
 
     uint l = 1;
+    uint O = 1;
+    uint I = 1;
 }
 
 contract ParameterNameEmptyString {

diff --git a/tests/detectors/naming-convention/0.6.11/naming_convention.sol.0.6.11.NamingConvention.json b/tests/detectors/naming-convention/0.6.11/naming_convention.sol.0.6.11.NamingConvention.json
diff --git a/tests/detectors/naming-convention/0.7.6/naming_convention.sol b/tests/detectors/naming-convention/0.7.6/naming_convention.sol
@@ -65,6 +65,8 @@ contract T {
     uint constant M = 1;
 
     uint l = 1;
+    uint O = 1;
+    uint I = 1;
 }
 
 contract ParameterNameEmptyString {

diff --git a/tests/detectors/naming-convention/0.7.6/naming_convention.sol.0.7.6.NamingConvention.json b/tests/detectors/naming-convention/0.7.6/naming_convention.sol.0.7.6.NamingConvention.json