solhint/lib/rules/naming/immutable-vars-naming.js

Solidity Code Linter

const BaseChecker = require('../base-checker')
const naming = require('../../common/identifier-naming')
const { severityDescription } = require('../../doc/utils')

const ruleId = 'immutable-vars-naming'

const DEFAULT_IMMUTABLE_AS_CONSTANTS = true
const DEFAULT_SEVERITY = 'warn'
const DEFAULT_OPTION = { immutablesAsConstants: DEFAULT_IMMUTABLE_AS_CONSTANTS }
const ERR_DESCRIPTION =
  'When True, immutable variables are expected to be in capitalized SNAKE_CASE. Otherwise mixedCase is expected.'

const meta = {
  type: 'naming',

  docs: {
    description:
      'Check Immutable variables. Capitalized SNAKE_CASE or mixedCase depending on configuration.',
    category: 'Style Guide Rules',
    options: [
      {
        description: severityDescription,
        default: DEFAULT_SEVERITY,
      },
      {
        description:
          'A JSON object with a single property "immutablesAsConstants" as boolean specifying if immutable variables should be treated as constants',
        default: JSON.stringify(DEFAULT_OPTION),
      },
    ],
  },

  recommended: true,
  defaultSetup: [DEFAULT_SEVERITY, DEFAULT_OPTION],

  schema: {
    type: 'object',
    required: ['immutablesAsConstants'],
    properties: {
      immutablesAsConstants: {
        type: 'boolean',
        description: ERR_DESCRIPTION + ' And should be a boolean.',
      },
    },
  },
}

class ImmutableVarsNamingChecker extends BaseChecker {
  constructor(reporter, config) {
    super(reporter, ruleId, meta)

    this.treatImmutablesAsConstants =
      config &&
      config.getObjectPropertyBoolean(
        ruleId,
        'immutablesAsConstants',
        DEFAULT_IMMUTABLE_AS_CONSTANTS
      )
  }

  VariableDeclaration(node) {
    if (node.isImmutable) {
      if (this.treatImmutablesAsConstants) {
        this.validateImmutableAsConstantName(node)
      } else {
        this.validateImmutableAsRegularVariables(node)
      }
    }
  }

  validateImmutableAsConstantName(node) {
    if (naming.isNotUpperSnakeCase(node.name)) {
      this.error(node, 'Immutable variables name are set to be in capitalized SNAKE_CASE')
    }
  }

  validateImmutableAsRegularVariables(node) {
    if (naming.isNotMixedCase(node.name)) {
      this.error(node, 'Immutable variables names are set to be in mixedCase')
    }
  }
}

module.exports = ImmutableVarsNamingChecker