shard-ameba/src/ameba/rule/debugger_statement.cr

module Ameba::Rule
  # A rule that disallows calls to debugger.
  #
  # This is because we don't want debugger breakpoints accidentally being
  # committed into our codebase.
  #
  # YAML configuration example:
  #
  # ```
  # DebuggerStatement:
  #   Enabled: true
  # ```
  #
  struct DebuggerStatement < Base
    properties do
      description "Disallows calls to debugger"
    end

    MSG = "Possible forgotten debugger statement detected"

    def test(source)
      AST::NodeVisitor.new self, source
    end

    def test(source, node : Crystal::Call)
      return unless node.name == "debugger" &&
                    node.args.empty? &&
                    node.obj.nil?

      source.error self, node.location, MSG
    end
  end
end