solhint/lib/rules/best-practices/no-console.js

Solidity Code Linter

const BaseChecker = require('../base-checker')

const ruleId = 'no-console'
const meta = {
  type: 'best-practices',
  docs: {
    description:
      'No console.log/logInt/logBytesX/logString/etc & No hardhat and forge-std console.sol import statements.',
    category: 'Best Practice Rules',
    examples: {
      bad: [
        {
          description: 'No console.logX statements',
          code: "console.log('test')",
        },
        {
          description: 'No hardhat/console.sol import statements',
          code: 'import "hardhat/console.sol"',
        },
        {
          description: 'No forge-std console.sol & console2.sol import statements',
          code: 'import "forge-std/consoleN.sol"',
        },
      ],
    },
    notes: [
      {
        note: 'Solhint allows this rule to automatically fix the code with `--fix` option',
      },
    ],
  },

  isDefault: true,
  recommended: true,
  defaultSetup: 'error',
  fixable: true,
  schema: null,
}

class NoConsoleLogChecker extends BaseChecker {
  constructor(reporter) {
    super(reporter, ruleId, meta)
  }

  ImportDirective(node) {
    if (this.isConsoleImport(node)) {
      this.error(node, 'Unexpected import of console file', this.fixStatement(node, 'import'))
    }
  }

  FunctionCall(node) {
    if (this.isConsoleLog(node)) {
      this.error(node, 'Unexpected console statement', this.fixStatement(node, 'call'))
    }
  }

  isConsoleLog(node) {
    return (
      node.expression.expression.type === 'Identifier' &&
      (node.expression.expression.name === 'console' ||
        node.expression.expression.name === 'console2') &&
      node.expression.memberName.startsWith('log')
    )
  }

  isConsoleImport(node) {
    return (
      node.path === 'hardhat/console.sol' ||
      node.path === 'forge-std/console.sol' ||
      node.path === 'forge-std/console2.sol'
    )
  }

  fixStatement(node, type) {
    const range = node.range
    // to remove the ';'
    if (type === 'call') range[1] += 1

    // // to remove the ';' and the 'enter'
    // if (type === 'call') range[1] += 2
    // else range[1] += 1 // to remove the 'enter'

    return (fixer) => fixer.removeRange(range)
  }
}

module.exports = NoConsoleLogChecker