class Ameba::Rule::Lint::DebugCalls

Overview

A rule that disallows calls to debug-related methods.

This is because we don't want debug calls accidentally being committed into our codebase.

YAML configuration example:

Lint/DebugCalls:
  Enabled: true
  MethodNames:
    - p
    - p!
    - pp
    - pp!

Included Modules

Defined in:

ameba/rule/lint/debug_calls.cr

Constant Summary

MSG = "Possibly forgotten debug-related `%s` call detected"

Constructors

Instance Method Summary

Instance methods inherited from class Ameba::Rule::Base

==(other) ==, catch(source : Source) catch, excluded?(source) excluded?, group group, hash hash, name name, special? special?, test(source : Source, node : Crystal::ASTNode, *opts)
test(source : Source) test

Class methods inherited from class Ameba::Rule::Base

parsed_doc parsed_doc

Constructor Detail

def self.new(ctx : YAML::ParseContext, node : YAML::Nodes::Node) #

def self.new(config = nil) #

A rule that disallows calls to debug-related methods.

This is because we don't want debug calls accidentally being committed into our codebase.

YAML configuration example:

Lint/DebugCalls:
  Enabled: true
  MethodNames:
    - p
    - p!
    - pp
    - pp!

[View source]

Instance Method Detail

def description : String #

def description=(description : String) #

def enabled : Bool #

def enabled=(enabled : Bool) #

def excluded : Array(String) | Nil #

def excluded=(excluded : Array(String) | Nil) #

def method_names : Array(String) #

def method_names=(method_names : Array(String)) #

def severity : Ameba::Severity #

def severity=(severity : Ameba::Severity) #

def test(source, node : Crystal::Call) #

[View source]