Validate rule schemas

protofire · Jan 30, 2020 · c2c1fb3 · c2c1fb3
1 parent e07b908
commit c2c1fb3
Show file tree

Hide file tree

Showing 42 changed files with 111 additions and 110 deletions.
diff --git a/docs/architecture.md b/docs/architecture.md
@@ -78,14 +78,9 @@ const meta = {
   recommended: true,
   defaultSetup: [DEFAULT_SEVERITY, DEFAULT_INDENTS],
 
-  schema: [
-    {
-      type: 'array',
-      items: [{ type: 'integer' }],
-      uniqueItems: true,
-      minItems: 2
-    }
-  ]
+  schema: {
+    type: 'integer'
+  }
 }
 
 class IndentChecker {

diff --git a/lib/config.js b/lib/config.js
@@ -2,7 +2,7 @@ const _ = require('lodash')
 
 module.exports = {
   from(configVals) {
-    return _.assign(configVals, this)
+    return _.assign({ rules: {} }, configVals, this)
   },
 
   getNumberByPath(path, defaultValue) {

diff --git a/lib/rules/base-checker.js b/lib/rules/base-checker.js
@@ -1,8 +1,62 @@
+const chalk = require('chalk')
+const Ajv = require('ajv')
+
+const ruleConfigSchema = schema => {
+  const baseSchema = {
+    type: 'array',
+    items: [
+      {
+        enum: ['error', 'warn', 'off']
+      }
+    ],
+    minItems: 1
+  }
+
+  if (schema) {
+    baseSchema.items.push(schema)
+  }
+
+  return baseSchema
+}
+
 class BaseChecker {
   constructor(reporter, ruleId, meta) {
     this.reporter = reporter
     this.ruleId = ruleId
     this.meta = meta
+
+    if (!reporter) {
+      return
+    }
+
+    // validate user's configuration of the rule
+    const userConfig = reporter.config[ruleId]
+    if (userConfig) {
+      if (Array.isArray(userConfig)) {
+        const ajv = new Ajv()
+        const schema = ruleConfigSchema(meta.schema)
+        const validate = ajv.compile(schema)
+        if (!validate(userConfig)) {
+          const messages = validate.errors
+            .map(e => e.message)
+            .filter(x => x) // filter out possible missing messages
+            .map(x => `  ${x}`) // indent
+            .join('\n')
+
+          console.warn(
+            chalk.yellow(
+              `[solhint] Warning: invalid configuration for rule '${ruleId}':\n${messages}`
+            )
+          )
+        }
+      } else if (!['off', 'warn', 'error'].includes(userConfig)) {
+        console.warn(
+          chalk.yellow(
+            `[solhint] Warning: rule '${ruleId}' level is '${userConfig}'; should be one of "error", "warn" or "off"`
+          )
+        )
+      }
+    }
   }
 
   error(ctx, message, fix) {

diff --git a/lib/rules/best-practises/code-complexity.js b/lib/rules/best-practises/code-complexity.js
@@ -40,14 +40,7 @@ const meta = {
   recommended: false,
   defaultSetup: [DEFAULT_SEVERITY, DEFAULT_COMPLEXITY],
 
-  schema: [
-    {
-      type: 'array',
-      items: [{ type: 'integer' }],
-      uniqueItems: true,
-      minItems: 2
-    }
-  ]
+  schema: { type: 'integer' }
 }
 
 class CodeComplexityChecker extends BaseChecker {

diff --git a/lib/rules/best-practises/function-max-lines.js b/lib/rules/best-practises/function-max-lines.js
@@ -26,14 +26,10 @@ const meta = {
   recommended: false,
   defaultSetup: [DEFAULT_SEVERITY, DEFAULT_MAX_LINES_COUNT],
 
-  schema: [
-    {
-      type: 'array',
-      items: [{ type: 'integer' }],
-      uniqueItems: true,
-      minItems: 2
-    }
-  ]
+  schema: {
+    type: 'integer',
+    minimum: 1
+  }
 }
 
 class FunctionMaxLinesChecker extends BaseChecker {

diff --git a/lib/rules/best-practises/max-line-length.js b/lib/rules/best-practises/max-line-length.js
@@ -28,14 +28,7 @@ const meta = {
   recommended: false,
   defaultSetup: [DEFAULT_SEVERITY, DEFAULT_MAX_LINE_LENGTH],
 
-  schema: [
-    {
-      type: 'array',
-      items: [{ type: 'integer' }],
-      uniqueItems: true,
-      minItems: 2
-    }
-  ]
+  schema: { type: 'integer', minimum: 1 }
 }
 
 class MaxLineLengthChecker extends BaseChecker {

diff --git a/lib/rules/best-practises/max-states-count.js b/lib/rules/best-practises/max-states-count.js
@@ -42,14 +42,7 @@ const meta = {
   recommended: true,
   defaultSetup: [DEFAULT_SEVERITY, DEFAULT_MAX_STATES_COUNT],
 
-  schema: [
-    {
-      type: 'array',
-      items: [{ type: 'integer' }],
-      uniqueItems: true,
-      minItems: 2
-    }
-  ]
+  schema: { type: 'integer' }
 }
 
 class MaxStatesCountChecker extends BaseChecker {

diff --git a/lib/rules/best-practises/no-empty-blocks.js b/lib/rules/best-practises/no-empty-blocks.js
@@ -14,7 +14,7 @@ const meta = {
   recommended: true,
   defaultSetup: 'warn',
 
-  schema: []
+  schema: null
 }
 
 class NoEmptyBlocksChecker extends BaseChecker {

diff --git a/lib/rules/best-practises/no-unused-vars.js b/lib/rules/best-practises/no-unused-vars.js
@@ -17,7 +17,7 @@ const meta = {
   recommended: true,
   defaultSetup: 'warn',
 
-  schema: []
+  schema: null
 }
 
 class NoUnusedVarsChecker extends BaseChecker {

diff --git a/lib/rules/best-practises/payable-fallback.js b/lib/rules/best-practises/payable-fallback.js
@@ -28,7 +28,7 @@ const meta = {
   recommended: true,
   defaultSetup: 'warn',
 
-  schema: []
+  schema: null
 }
 
 class PayableFallbackChecker extends BaseChecker {

diff --git a/lib/rules/best-practises/reason-string.js b/lib/rules/best-practises/reason-string.js
@@ -45,23 +45,14 @@ const meta = {
   recommended: false,
   defaultSetup: [DEFAULT_SEVERITY, DEFAULT_OPTION],
 
-  schema: [
-    {
-      type: 'array',
-      items: [
-        {
-          properties: {
-            maxLength: {
-              type: 'integer'
-            }
-          },
-          additionalProperties: false
-        }
-      ],
-      uniqueItems: true,
-      minItems: 2
+  schema: {
+    type: 'object',
+    properties: {
+      maxLength: {
+        type: 'integer'
+      }
     }
-  ]
+  }
 }
 
 class ReasonStringChecker extends BaseChecker {

diff --git a/lib/rules/deprecations/constructor-syntax.js b/lib/rules/deprecations/constructor-syntax.js
@@ -13,7 +13,7 @@ const meta = {
   recommended: false,
   defaultSetup: 'warn',
 
-  schema: []
+  schema: null
 }
 
 class ConstructorSyntax extends BaseDeprecation {

diff --git a/lib/rules/index.js b/lib/rules/index.js
@@ -11,7 +11,7 @@ const { validSeverityMap } = require('../config/config-validator')
 
 module.exports = function checkers(reporter, configVals, inputSrc, tokens, fileName) {
   const config = configObject.from(configVals)
-  const { rules = {} } = config
+  const { rules } = config
   const meta = {
     reporter,
     config,

diff --git a/lib/rules/miscellaneous/quotes.js b/lib/rules/miscellaneous/quotes.js
@@ -41,19 +41,10 @@ const meta = {
   recommended: true,
   defaultSetup: [DEFAULT_SEVERITY, DEFAULT_QUOTES_TYPE],
 
-  schema: [
-    {
-      type: 'array',
-      items: [
-        {
-          type: 'string',
-          enum: QUOTE_TYPES
-        }
-      ],
-      uniqueItems: true,
-      minItems: 2
-    }
-  ]
+  schema: {
+    type: 'string',
+    enum: QUOTE_TYPES
+  }
 }
 
 class QuotesChecker extends BaseChecker {

diff --git a/lib/rules/naming/const-name-snakecase.js b/lib/rules/naming/const-name-snakecase.js
@@ -14,7 +14,7 @@ const meta = {
   recommended: true,
   defaultSetup: 'warn',
 
-  schema: []
+  schema: null
 }
 
 class ConstNameSnakecaseChecker extends BaseChecker {

diff --git a/lib/rules/naming/contract-name-camelcase.js b/lib/rules/naming/contract-name-camelcase.js
@@ -14,7 +14,7 @@ const meta = {
   recommended: true,
   defaultSetup: 'warn',
 
-  schema: []
+  schema: null
 }
 
 class ContractNameCamelcaseChecker extends BaseChecker {

diff --git a/lib/rules/naming/event-name-camelcase.js b/lib/rules/naming/event-name-camelcase.js
@@ -14,7 +14,7 @@ const meta = {
   recommended: true,
   defaultSetup: 'warn',
 
-  schema: []
+  schema: null
 }
 
 class EventNameCamelcaseChecker extends BaseChecker {

diff --git a/lib/rules/naming/func-name-mixedcase.js b/lib/rules/naming/func-name-mixedcase.js
@@ -14,7 +14,7 @@ const meta = {
   recommended: true,
   defaultSetup: 'warn',
 
-  schema: []
+  schema: null
 }
 
 class FuncNameMixedcaseChecker extends BaseChecker {

diff --git a/lib/rules/naming/func-param-name-mixedcase.js b/lib/rules/naming/func-param-name-mixedcase.js
@@ -14,7 +14,7 @@ const meta = {
   recommended: false,
   defaultSetup: 'warn',
 
-  schema: []
+  schema: null
 }
 
 class FunctionParamNameMixedcaseChecker extends BaseChecker {

diff --git a/lib/rules/naming/modifier-name-mixedcase.js b/lib/rules/naming/modifier-name-mixedcase.js
@@ -14,7 +14,7 @@ const meta = {
   recommended: false,
   defaultSetup: 'warn',
 
-  schema: []
+  schema: null
 }
 
 class ModifierNameMixedcase extends BaseChecker {

diff --git a/lib/rules/naming/use-forbidden-name.js b/lib/rules/naming/use-forbidden-name.js
@@ -15,7 +15,7 @@ const meta = {
   recommended: true,
   defaultSetup: 'warn',
 
-  schema: []
+  schema: null
 }
 
 class UseForbiddenNameChecker extends BaseChecker {

diff --git a/lib/rules/naming/var-name-mixedcase.js b/lib/rules/naming/var-name-mixedcase.js
@@ -14,7 +14,7 @@ const meta = {
   recommended: true,
   defaultSetup: 'warn',
 
-  schema: []
+  schema: null
 }
 
 class VarNameMixedcaseChecker extends BaseChecker {

diff --git a/lib/rules/order/func-order.js b/lib/rules/order/func-order.js
@@ -31,7 +31,7 @@ const meta = {
   recommended: false,
   defaultSetup: 'warn',
 
-  schema: []
+  schema: null
 }
 
 class FuncOrderChecker extends BaseChecker {

diff --git a/lib/rules/order/imports-on-top.js b/lib/rules/order/imports-on-top.js
@@ -13,7 +13,7 @@ const meta = {
   recommended: true,
   defaultSetup: 'warn',
 
-  schema: []
+  schema: null
 }
 
 class ImportsOnTopChecker extends BaseChecker {

diff --git a/lib/rules/order/visibility-modifier-order.js b/lib/rules/order/visibility-modifier-order.js
@@ -27,7 +27,7 @@ const meta = {
   recommended: true,
   defaultSetup: 'warn',
 
-  schema: []
+  schema: null
 }
 
 class VisibilityModifierOrderChecker extends BaseChecker {

diff --git a/lib/rules/security/avoid-call-value.js b/lib/rules/security/avoid-call-value.js
@@ -13,7 +13,7 @@ const meta = {
   recommended: true,
   defaultSetup: 'warn',
 
-  schema: []
+  schema: null
 }
 
 class AvoidCallValueChecker extends BaseChecker {

diff --git a/lib/rules/security/avoid-low-level-calls.js b/lib/rules/security/avoid-low-level-calls.js
@@ -22,7 +22,7 @@ const meta = {
   recommended: true,
   defaultSetup: 'warn',
 
-  schema: []
+  schema: null
 }
 
 class AvoidLowLevelCallsChecker extends BaseChecker {

diff --git a/lib/rules/security/avoid-sha3.js b/lib/rules/security/avoid-sha3.js
@@ -14,7 +14,7 @@ const meta = {
   defaultSetup: 'warn',
   fixable: true,
 
-  schema: []
+  schema: null
 }
 
 class AvoidSha3Checker extends BaseChecker {

diff --git a/lib/rules/security/avoid-suicide.js b/lib/rules/security/avoid-suicide.js
@@ -13,7 +13,7 @@ const meta = {
   recommended: true,
   defaultSetup: 'warn',
 
-  schema: []
+  schema: null
 }
 
 class AvoidSuicideChecker extends BaseChecker {