solhint/lib/rules/order/one-line-between-contract-parts.js

Solidity Code Linter

const BaseChecker = require('./../base-checker')
const BlankLineCounter = require('./../../common/blank-line-counter')
const { typeOf } = require('./../../common/tree-traversing')

class OneLineBetweenContractPartsChecker extends BaseChecker {
  constructor(reporter) {
    super(reporter)
    this.lineCounter = new BlankLineCounter()
  }

  enterContractDefinition(ctx) {
    const lineCounter = this.lineCounter
    lineCounter.calcTokenLines(ctx)

    const items = ctx.children.filter(i => typeOf(i) === 'contractPart')

    for (let i = 0, j = i + 1; j < items.length; i += 1, j += 1) {
      const curItem = items[i]
      const nextItem = items[j]
      const bothPartsIsNotSingleLine = !(this.isSingleLine(curItem) && this.isSingleLine(nextItem))

      if (
        bothPartsIsNotSingleLine &&
        lineCounter.countOfEmptyLinesBetween(curItem, nextItem) !== 1
      ) {
        this._error(nextItem)
      }
    }
  }

  isSingleLine(item) {
    return item.start.line === item.stop.line
  }

  _error(ctx) {
    const message = 'Definitions inside contract / library must be separated by one line'
    this.error(ctx, 'separate-by-one-line-in-contract', message)
  }
}

module.exports = OneLineBetweenContractPartsChecker