Support no-visibility constructors in >=0.7.0

docs/rules/security/func-visibility.md

@@ -15,13 +15,19 @@ title:       "func-visibility | Solhint"
 Explicitly mark visibility in function.
 
 ## Options
-This rule accepts a string option of rule severity. Must be one of "error", "warn", "off". Default to warn.
+This rule accepts an array of options:
+
+| Index | Description                                                                                                                                                                                    | Default Value                |
+| ----- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- |
+| 0     | Rule severity. Must be one of "error", "warn", "off".                                                                                                                                          | warn                         |
+| 1     | A JSON object with a single property "ignoreConstructors" specifying if the rule should ignore constructors. (**Note: This is required to be true for Solidity >=0.7.0 and false for <0.7.0**) | {"ignoreConstructors":false} |
+
 
 ### Example Config
 ```json
 {
   "rules": {
-    "func-visibility": "warn"
+    "func-visibility": ["warn",{"ignoreConstructors":false}]
   }
 }
 ```
@@ -37,6 +43,7 @@ function b() internal { }
 function b() external { }
 function b() private { }
 function b() public { }
+constructor() public { }
 ```
 
 ### 👎 Examples of **incorrect** code for this rule

lib/rules/security/func-visibility.js

@@ -1,4 +1,9 @@
 const BaseChecker = require('./../base-checker')
+const { severityDescription } = require('../../doc/utils')
+
+const DEFAULT_SEVERITY = 'warn'
+const DEFAULT_IGNORE_CONSTRUCTORS = false
+const DEFAULT_OPTION = { ignoreConstructors: DEFAULT_IGNORE_CONSTRUCTORS }
 
 const ruleId = 'func-visibility'
 const meta = {
@@ -7,6 +12,17 @@ const meta = {
   docs: {
     description: `Explicitly mark visibility in function.`,
     category: 'Security Rules',
+    options: [
+      {
+        description: severityDescription,
+        default: DEFAULT_SEVERITY
+      },
+      {
+        description:
+          'A JSON object with a single property "ignoreConstructors" specifying if the rule should ignore constructors. (**Note: This is required to be true for Solidity >=0.7.0 and false for <0.7.0**)',
+        default: JSON.stringify(DEFAULT_OPTION)
+      }
+    ],
     examples: {
       good: [
         {
@@ -25,19 +41,38 @@ const meta = {
 
   isDefault: false,
   recommended: true,
-  defaultSetup: 'warn',
+  defaultSetup: [DEFAULT_SEVERITY, DEFAULT_OPTION],
 
-  schema: null
+  schema: {
+    type: 'object',
+    properties: {
+      ignoreConstructors: {
+        type: 'boolean'
+      }
+    }
+  }
 }
 
 class FuncVisibilityChecker extends BaseChecker {
-  constructor(reporter) {
+  constructor(reporter, config) {
     super(reporter, ruleId, meta)
+
+    this.ignoreConstructors =
+      config && config.getObjectPropertyBoolean(ruleId, 'ignoreConstructors', false)
   }
 
   FunctionDefinition(node) {
+    if (node.isConstructor && this.ignoreConstructors) {
+      return
+    }
+
     if (node.visibility === 'default') {
-      this.warn(node, 'Explicitly mark visibility in function')
+      this.warn(
+        node,
+        node.isConstructor
+          ? 'Explicitly mark visibility in function (Set ignoreConstructors to true if using solidity >=0.7.0)'
+          : 'Explicitly mark visibility in function'
+      )
     }
   }
 }

lib/rules/security/index.js

@@ -26,7 +26,7 @@ module.exports = function security(reporter, config, inputSrc) {
     new AvoidTxOriginChecker(reporter),
     new CheckSendResultChecker(reporter),
     new CompilerVersionChecker(reporter, config),
-    new FuncVisibilityChecker(reporter),
+    new FuncVisibilityChecker(reporter, config),
     new MarkCallableContractsChecker(reporter),
     new MultipleSendsChecker(reporter),
     new NoComplexFallbackChecker(reporter),

package.json

@@ -29,7 +29,7 @@
   "author": "Ilya Drabenia <ilya.drobenya@gmail.com>",
   "license": "MIT",
   "dependencies": {
-    "@solidity-parser/parser": "^0.6.0",
+    "@solidity-parser/parser": "^0.7.0",
     "ajv": "^6.6.1",
     "antlr4": "4.7.1",
     "ast-parents": "0.0.1",

test/fixtures/security/functions-with-visibility.js

@@ -2,5 +2,6 @@ module.exports = [
   'function b() internal { }',
   'function b() external { }',
   'function b() private { }',
-  'function b() public { }'
+  'function b() public { }',
+  'constructor() public { }'
 ]

test/rules/security/func-visibility.js

@@ -27,4 +27,30 @@ describe('Linter - func-visibility', () => {
       assert.equal(report.warningCount, 0)
     })
   })
+
+  describe("when 'ignoreConstructors' is enabled", () => {
+    it('should ignore constructors without visibility', () => {
+      const code = contractWith('constructor () {}')
+
+      const report = linter.processStr(code, {
+        rules: {
+          'func-visibility': ['warn', { ignoreConstructors: true }]
+        }
+      })
+
+      assert.equal(report.warningCount, 0)
+    })
+
+    it('should still report functions without visibility', () => {
+      const code = contractWith('function foo() {}')
+
+      const report = linter.processStr(code, {
+        rules: {
+          'func-visibility': ['warn', { ignoreConstructors: true }]
+        }
+      })
+
+      assert.equal(report.warningCount, 1)
+    })
+  })
 })