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
    def test(source)
      AST::Visitor.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,
        "Possible forgotten debugger statement detected"
    end
  end
end
Ameba::Rule -> Ameba::Rule::Base 2017-11-07 21:50:25 +00:00			`module Ameba::Rule`
New rule: debugger statement 2017-11-01 12:42:58 +00:00			`# A rule that disallows calls to debugger.`
			`#`
			`# This is because we don't want debugger breakpoints accidentally being`
			`# committed into our codebase.`
Style improvements 2017-11-01 17:30:08 +00:00			`#`
Document configuration properties & specs 2017-11-14 07:24:36 +00:00			`# YAML configuration example:`
			`#`
			# ```
			`# DebuggerStatement:`
			`# Enabled: true`
			# ```
			`#`
Ameba::Rule -> Ameba::Rule::Base 2017-11-07 21:50:25 +00:00			`struct DebuggerStatement < Base`
New rule: debugger statement 2017-11-01 12:42:58 +00:00			`def test(source)`
Performance improvements (#15) * Performance improvements Two main changes: 1. Cache parsed AST in a Source. So Parser will parse content only once. 2. Use one unified visitor with multiple callbacks instead of multiple visitors to traverse AST. This improves performance significantly, for example running it on Crystal repository takes ~1 second, which 6 times faster than before. * Change readme example 2017-11-06 18:54:58 +00:00			`AST::Visitor.new self, source`
New rule: debugger statement 2017-11-01 12:42:58 +00:00			`end`

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

Source#content -> Source#code, Source::Error#pos -> Source::Error#location 2017-11-07 20:02:51 +00:00			`source.error self, node.location,`
New rule: debugger statement 2017-11-01 12:42:58 +00:00			`"Possible forgotten debugger statement detected"`
			`end`
			`end`
			`end`