solhint/lib/formatters/unix.js

Solidity Code Linter

/**
 * @fileoverview Unix Style formatter
 * @author oshi-shinobu
 */

//------------------------------------------------------------------------------
// Helper Functions
//------------------------------------------------------------------------------

/**
 * Returns a canonical error level string based upon the error message passed in.
 * @param {Object} message Individual error message provided by eslint
 * @returns {string} Error level string
 */
function getMessageType(message) {
  if (message.fatal || message.severity === 2) {
    return 'Error'
  }
  return 'Warning'
}

//------------------------------------------------------------------------------
// Public Interface
//------------------------------------------------------------------------------

// eslint-disable-next-line func-names
module.exports = function (results) {
  let output = ''
  let total = 0
  let errors = 0
  let warnings = 0

  results.forEach((result) => {
    const messages = result.messages

    total += messages.length

    messages.forEach((message) => {
      output += `${result.filePath}:`
      output += `${message.line || 0}:`
      output += `${message.column || 0}:`
      output += ` ${message.message} `
      output += `[${getMessageType(message)}${message.ruleId ? `/${message.ruleId}` : ''}]`
      output += '\n'
      if (message.severity === 2) errors += 1
      else warnings += 1
    })
  })

  let finalMessage = ''
  if (errors > 0 && warnings > 0) {
    finalMessage = `${errors + warnings} problem/s (${errors} error/s, ${warnings} warning/s)`
  } else if (errors > 0 && warnings === 0) {
    finalMessage = `${errors} problem/s (${errors} error/s)`
  } else if (errors === 0 && warnings > 0) {
    finalMessage = `${warnings} problem/s (${warnings} warning/s)`
  }

  if (total > 0) {
    output += `\n${finalMessage}`
  }

  return output
}