const-name-snakecase.js

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

describe('Linter - const-name-snakecase', () => {
  it('should raise const name error', () => {
    const code = contractWith('uint private constant a;')

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

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

  it('should not raise const name error for constants in snake case', () => {
    const code = contractWith('uint32 private constant THE_CONSTANT = 10;')

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

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

  it('should not raise const name error for constants in snake case with single leading underscore', () => {
    const code = contractWith('uint32 private constant _THE_CONSTANT = 10;')

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

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

  it('should not raise const name error for constants in snake case with double leading underscore', () => {
    const code = contractWith('uint32 private constant __THE_CONSTANT = 10;')

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

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

  it('should raise const name error for constants in snake case with more than two leading underscores', () => {
    const code = contractWith('uint32 private constant ___THE_CONSTANT = 10;')

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

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

  it('should not raise const name error for immutable variables in SNAKE_CASE', () => {
    const code = contractWith('uint32 private immutable SNAKE_CASE;')

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

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

  it('should not raise const name error for immutable variables in mixedCase', () => {
    const code = contractWith('uint32 private immutable SNAKE_CASE;')

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

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

  describe('constant name with $ character', () => {
    const WITH_$ = {
      'starting with $': contractWith('uint32 private constant $THE_CONSTANT = 10;'),
      'containing a $': contractWith('uint32 private constant THE_$_CONSTANT = 10;'),
      'ending with $': contractWith('uint32 private constant THE_CONSTANT$ = 10;'),
      'only with $': contractWith('uint32 private constant $ = 10;'),
    }

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

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