Merge pull request #131 from protofire/deprecations

Deprecate old compiler rules and disabling rules with falsy values

lib/config/config-validator.js

@@ -1,3 +1,5 @@
+const chalk = require('chalk')
+const _ = require('lodash')
 const ajv = require('../common/ajv')
 const configSchema = require('./config-schema')
 
@@ -38,12 +40,32 @@ const formatErrors = errors =>
     .map(message => `\t- ${message}.\n`)
     .join('')
 
+const deprecatedDisableValue = _.once(() => {
+  console.warn(
+    chalk.yellow(
+      '[Solhint] Warning: Disabling rules with `false` or `0` is deprecated. Please use `"off"` instead.'
+    )
+  )
+})
+
 const validate = config => {
   validateSchema = validateSchema || ajv.compile(configSchema)
 
   if (!validateSchema(config)) {
     throw new Error(`Solhint configuration is invalid:\n${formatErrors(validateSchema.errors)}`)
   }
+
+  // show deprecated warning for rules that are configured with `false` or `0`
+  Object.keys(config.rules || {}).forEach(key => {
+    let severity = config.rules[key]
+    if (Array.isArray(severity)) {
+      severity = severity[0]
+    }
+
+    if (severity === false || severity === 0) {
+      deprecatedDisableValue()
+    }
+  })
 }
 
 module.exports = {

lib/rules/index.js

@@ -1,3 +1,4 @@
+const chalk = require('chalk')
 const _ = require('lodash')
 const security = require('./security/index')
 const naming = require('./naming/index')
@@ -22,7 +23,16 @@ module.exports = function checkers(reporter, configVals, inputSrc, fileName) {
 
   const allRules = [...coreRules(meta), ...pluginsRules(plugins, meta)]
 
-  return allRules.filter(coreRule => ruleEnabled(coreRule, rules))
+  const enabledRules = allRules.filter(coreRule => ruleEnabled(coreRule, rules))
+
+  // show warnings for deprecated rules
+  for (const rule of enabledRules) {
+    if (rule.meta && rule.meta.deprecated) {
+      console.warn(chalk.yellow(`[solhint] Warning: rule '${rule.ruleId}' is deprecated.`))
+    }
+  }
+
+  return enabledRules
 }
 
 function coreRules(meta) {

lib/rules/security/compiler-fixed.js

@@ -13,6 +13,8 @@ const meta = {
   recommended: true,
   defaultSetup: 'warn',
 
+  deprecated: true,
+
   schema: []
 }
 

lib/rules/security/compiler-gt-0_4.js

@@ -13,6 +13,8 @@ const meta = {
   recommended: true,
   defaultSetup: 'warn',
 
+  deprecated: true,
+
   schema: []
 }
 

package.json

@@ -30,6 +30,7 @@
   "dependencies": {
     "ajv": "^6.6.1",
     "antlr4": "4.7.1",
+    "chalk": "^2.4.2",
     "commander": "2.18.0",
     "cosmiconfig": "^5.0.7",
     "eslint": "^5.6.0",

test/common/config-validator.js

@@ -38,4 +38,10 @@ describe('Config validator', () => {
     }
     assert.throws(() => validate(config), Error)
   })
+
+  it('should work with an empty config', () => {
+    const config = {}
+
+    validate(config) // should not throw
+  })
 })