#143846

Committed 09 May 2026 04:07PM UTC coverage: 97.831% (+5.8%) from 92.08%

Build # #143846

Build Type

push

Coverage Stats

589 of 666 branches covered (88.44%)

2796 of 2858 relevant lines covered (97.83%)

119.24 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

69.57

/../lib/config/config-validator.js

const chalk = require('chalk')
const _ = require('lodash')
const ajv = require('../common/ajv')
const configSchema = require('./config-schema')

let validateSchema

const validSeverityMap = ['error', 'warn']

const invalidSeverityMap = ['off']

const defaultSchemaValueForRules = Object.freeze({
  oneOf: [{ type: 'string', enum: [...validSeverityMap, ...invalidSeverityMap] }, { const: false }],
})

const formatErrors = (errors) =>
  errors
    .map((error) => {
      const dataPath = error.instancePath || ''
      if (error.keyword === 'additionalProperties') {
        const formattedPropertyPath = dataPath.length
          ? `${dataPath.slice(1)}.${error.params.additionalProperty}`
          : error.params.additionalProperty

        return `Unexpected top-level property "${formattedPropertyPath}"`
      }
      if (error.keyword === 'type') {
        const formattedField = dataPath.slice(1)
        const formattedExpectedType = Array.isArray(error.schema)
          ? error.schema.join('/')
          : error.schema
        const formattedValue = JSON.stringify(error.data)

        return `Property "${formattedField}" is the wrong type (expected ${formattedExpectedType} but got \`${formattedValue}\`)`
      }

      const field = dataPath[0] === '/' ? dataPath.slice(1) : dataPath

      return `"${field}" ${error.message}. Value: ${JSON.stringify(error.data)}`
    })
    .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 = {
  validate,
  validSeverityMap,
  invalidSeverityMap,
  defaultSchemaValueForRules,
}

1	const chalk = require('chalk')	1✔
2	const _ = require('lodash')	1✔
3	const ajv = require('../common/ajv')
4	const configSchema = require('./config-schema')
5
6	let validateSchema	1✔
7
8	const validSeverityMap = ['error', 'warn']	1✔
9
10	const invalidSeverityMap = ['off']	1✔
11
12	const defaultSchemaValueForRules = Object.freeze({
13	oneOf: [{ type: 'string', enum: [...validSeverityMap, ...invalidSeverityMap] }, { const: false }],
14	})	1✔
15		1✔
16	const formatErrors = (errors) =>
17	errors	1!
18	.map((error) => {	1!
19	const dataPath = error.instancePath \|\| ''
20	if (error.keyword === 'additionalProperties') {
21	const formattedPropertyPath = dataPath.length
22	? `${dataPath.slice(1)}.${error.params.additionalProperty}`	1✔
23	: error.params.additionalProperty
24		×
25	return `Unexpected top-level property "${formattedPropertyPath}"`	×
26	}	×
27	if (error.keyword === 'type') {
28	const formattedField = dataPath.slice(1)
29	const formattedExpectedType = Array.isArray(error.schema)	×
30	? error.schema.join('/')
31	: error.schema	×
32	const formattedValue = JSON.stringify(error.data)
33
34	return `Property "${formattedField}" is the wrong type (expected ${formattedExpectedType} but got \`${formattedValue}\`)`	×
35	}
36		×
37	const field = dataPath[0] === '/' ? dataPath.slice(1) : dataPath
38		1✔
39	return `"${field}" ${error.message}. Value: ${JSON.stringify(error.data)}`
40	})
41	.map((message) => `\t- ${message}.\n`)	1✔
42	.join('')	2✔
43
44	const deprecatedDisableValue = _.once(() => {	2✔
45	console.warn(	1✔
46	chalk.yellow(
47	'[Solhint] Warning: Disabling rules with `false` or `0` is deprecated. Please use `"off"` instead.',
48	),
49	)	1✔
50	})
51
52	const validate = (config) => {
53	validateSchema = validateSchema \|\| ajv.compile(configSchema)
54
55	if (!validateSchema(config)) {
56	throw new Error(`Solhint configuration is invalid:\n${formatErrors(validateSchema.errors)}`)
57	}
58
59	// show deprecated warning for rules that are configured with `false` or `0`
60	Object.keys(config.rules \|\| {}).forEach((key) => {
61	let severity = config.rules[key]
62	if (Array.isArray(severity)) {
63	severity = severity[0]
64	}
65
66	if (severity === false \|\| severity === 0) {
67	deprecatedDisableValue()
68	}
69	})
70	}
71
72	module.exports = {
73	validate,
74	validSeverityMap,
75	invalidSeverityMap,
76	defaultSchemaValueForRules,
77	}

protofire / solhint / #143846

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous