improve

Author: Amxx

scripts/solhint-custom/index.js

@@ -14,8 +14,8 @@ class Base {
     }
   }
 
-  error(node, message) {
-    if (!this.ignored) {
+  require(condition, node, message) {
+    if (!condition && !this.ignored) {
       this.reporter.error(node, this.ruleId, message);
     }
   }
@@ -26,8 +26,8 @@ module.exports = [
     static ruleId = 'interface-only-external-functions';
 
     FunctionDefinition(node) {
-      if (node.parent.kind === 'interface' && node.visibility !== 'external') {
-        this.error(node, 'Interface functions must be external');
+      if (node.parent.kind === 'interface') {
+        this.require(node.visibility === 'external', node, 'Interface functions must be external');
       }
     }
   },
@@ -36,8 +36,12 @@ module.exports = [
     static ruleId = 'private-variables';
 
     VariableDeclaration(node) {
-      if (node.isStateVar && !node.isDeclaredConst && !node.isImmutable && node.visibility !== 'private') {
-        this.error(node, 'State variables must be private');
+      if (node.isStateVar) {
+        this.require(
+          node.isDeclaredConst || node.isImmutable || node.visibility === 'private',
+          node,
+          'State variables must be private',
+        );
       }
     }
   },
@@ -46,38 +50,45 @@ module.exports = [
     static ruleId = 'leading-underscore';
 
     VariableDeclaration(node) {
-      if (node.isDeclaredConst && node.name.startsWith('_')) {
-        this.error(node, 'Constant variables should not have leading underscore');
-      }
-      if (node.isImmutable && node.name.startsWith('_')) {
-        this.error(node, 'Immutable variables should not have leading underscore');
-      }
-      if (node.isStateVar && node.visibility === 'private' && !node.name.startsWith('_')) {
-        this.error(node, 'Private state variables must have leading underscore');
-      }
-      if (node.isStateVar && node.visibility === 'internal' && !node.name.startsWith('_')) {
-        this.error(node, 'Internal state variables must have leading underscore');
-      }
-      if (node.isStateVar && node.visibility === 'public' && node.name.startsWith('_')) {
-        this.error(node, 'Public state variables should not have leading underscore');
+      if (node.isDeclaredConst) {
+        this.require(!node.name.startsWith('_'), node, 'Constant variables should not have leading underscore');
+      } else if (node.isImmutable) {
+        this.require(!node.name.startsWith('_'), node, 'Immutable variables should not have leading underscore');
+      } else if (node.isStateVar) {
+        switch (node.visibility) {
+          case 'private':
+            this.require(node.name.startsWith('_'), node, 'Private state variables must have leading underscore');
+            break;
+          case 'internal':
+            this.require(node.name.startsWith('_'), node, 'Internal state variables must have leading underscore');
+            break;
+          case 'public':
+            this.require(!node.name.startsWith('_'), node, 'Public state variables should not have leading underscore');
+            break;
+        }
       }
     }
 
     FunctionDefinition(node) {
-      if (node.visibility === 'private' && !node.name.startsWith('_')) {
-        this.error(node, 'Private functions must have leading underscore');
-      }
-      if (node.visibility === 'internal' && node.parent.kind !== 'library' && !node.name.startsWith('_')) {
-        this.error(node, 'Non-library internal functions must have leading underscore');
-      }
-      if (node.visibility === 'internal' && node.parent.kind === 'library' && node.name.startsWith('_')) {
-        this.error(node, 'Library internal functions should not have leading underscore');
-      }
-      if (node.visibility === 'public' && node.name.startsWith('_')) {
-        this.error(node, 'Public functions should not have leading underscore');
-      }
-      if (node.visibility === 'external' && node.name.startsWith('_')) {
-        this.error(node, 'External functions should not have leading underscore');
+      switch (node.visibility) {
+        case 'external':
+          this.require(!node.name.startsWith('_'), node, 'External functions should not have leading underscore');
+          break;
+        case 'public':
+          this.require(!node.name.startsWith('_'), node, 'Public functions should not have leading underscore');
+          break;
+        case 'internal':
+          this.require(
+            node.name.startsWith('_') !== (node.parent.kind === 'library'),
+            node,
+            node.parent.kind === 'library'
+              ? 'Library internal functions should not have leading underscore'
+              : 'Non-library internal functions must have leading underscore',
+          );
+          break;
+        case 'private':
+          this.require(node.name.startsWith('_'), node, 'Private functions must have leading underscore');
+          break;
       }
     }
   },
@@ -86,8 +97,12 @@ module.exports = [
     static ruleId = 'no-external-virtual';
 
     FunctionDefinition(node) {
-      if (node.visibility == 'external' && node.isVirtual) {
-        this.error(node, 'Functions should not be external and virtual');
+      if (node.visibility == 'external') {
+        this.require(
+          node.isReceiveEther || node.isFallback || !node.isVirtual,
+          node,
+          'Functions should not be external and virtual',
+        );
       }
     }
   },