Merge pull request #6 from Decurity/constant-not-in-uppercase

Adding the constant-not-in-uppercase rule
Decurity · Mar 30, 2023 · 132061c · 132061c
2 parents 11ff862 + 06afd81
commit 132061c
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 0 deletions.
diff --git a/solidity/constant-not-in-uppercase.sol b/solidity/constant-not-in-uppercase.sol
@@ -0,0 +1,12 @@
+contract Test {
+  // ruleid: constant-not-in-uppercase
+  uint8 constant test = 1337;
+  // ruleid: constant-not-in-uppercase
+  string constant Test = "kekeke";
+  // ruleid: constant-not-in-uppercase
+  bytes internal constant aTEST = hex"616161";
+  // ok: constant-not-in-uppercase
+  uint256 constant TEST = 31338;
+  // ok: constant-not-in-uppercase
+  int64 constant THE_TEST = 123;
+}
diff --git a/solidity/constant-not-in-uppercase.yaml b/solidity/constant-not-in-uppercase.yaml
@@ -0,0 +1,18 @@
+rules:
+  - id: constant-not-in-uppercase
+    message: A constant name is not in UPPER_CASE like other constant variables.
+    languages:
+      - solidity
+    severity: WARNING
+    metadata:
+      category: coding-style
+      tags:
+        - compound
+      references:
+        - https://github.com/compound-finance/comet/issues/396
+    patterns:
+      - metavariable-regex:
+          metavariable: $NAME
+          regex: ".*[a-z].*"
+      - pattern: |
+          $TYPE constant $NAME = ...;