solhint/test/rules/naming/func-param-name-mixedcase.js

Solidity Code Linter

const assert = require('assert')
const linter = require('../../../lib/index')
const contractWith = require('../../common/contract-builder').contractWith

describe('Linter - func-param-name-mixedcase', () => {
  it('should raise incorrect func param name error', () => {
    const code = contractWith('function funcName (uint A) public {}')

    const report = linter.processStr(code, {
      rules: { 'func-param-name-mixedcase': 'error' },
    })

    assert.equal(report.errorCount, 1)
    assert.ok(report.messages[0].message.includes('param'))
  })

  it('should raise var name error for event arguments illegal styling', () => {
    const code = contractWith('event Event1(uint B);')

    const report = linter.processStr(code, {
      rules: { 'func-param-name-mixedcase': 'error' },
    })

    assert.equal(report.errorCount, 1)
    assert.ok(report.messages[0].message.includes('mixedCase'))
  })

  describe('Function Paramters name with $ character', () => {
    const WITH_$ = {
      'starting with $': contractWith('function funcName (uint $param) public {}'),
      'containing a $': contractWith('function funcName (uint pa$ram) public {}'),
      'ending with $': contractWith('function funcName (uint param$) public {}'),
      'only with $': contractWith('function funcName(uint $) public {}'),
    }

    for (const [key, code] of Object.entries(WITH_$)) {
      it(`should not raise func param name error for Function Parameters ${key}`, () => {
        const report = linter.processStr(code, {
          rules: { 'func-param-name-mixedcase': 'error' },
        })

        assert.equal(report.errorCount, 0)
      })
    }
  })
  describe('Event parameters name with $ character', () => {
    const WITH_$ = {
      'starting with $': contractWith('event Event1(uint $param);'),
      'containing a $': contractWith('event Event1(uint pa$ram);'),
      'ending with $': contractWith('event Event1(uint param$);'),
      'only with $': contractWith('event Event1(uint $);'),
    }

    for (const [key, code] of Object.entries(WITH_$)) {
      it(`should not raise func name error for Event Parameters ${key}`, () => {
        const report = linter.processStr(code, {
          rules: { 'func-name-mixedcase': 'error' },
        })

        assert.equal(report.errorCount, 0)
      })
    }
  })
})