struct Ameba::Rule::Style::ConstantNames

Overview

A rule that enforces constant names to be in screaming case.

For example, these constant names are considered valid:

LUCKY_NUMBERS     = [3, 7, 11]
DOCUMENTATION_URL = "http://crystal-lang.org/docs"

And these are invalid names:

myBadConstant = 1
Wrong_NAME = 2

YAML configuration example:

Style/ConstantNames:
  Enabled: true

Included Modules

Defined in:

ameba/rule/style/constant_names.cr

Constant Summary

MSG = "Constant name should be screaming-cased: %s, not %s"

Constructors

Instance Method Summary

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

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

Constructor methods inherited from struct Ameba::Rule::Base

new new

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

parsed_doc parsed_doc

Macros inherited from struct Ameba::Rule::Base

issue_for(*args) issue_for

Macros inherited from module Ameba::Config::RuleConfig

properties(&block) properties

Constructor Detail

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

def self.new(config = nil) #

A rule that enforces constant names to be in screaming case.

For example, these constant names are considered valid:

LUCKY_NUMBERS     = [3, 7, 11]
DOCUMENTATION_URL = "http://crystal-lang.org/docs"

And these are invalid names:

myBadConstant = 1
Wrong_NAME = 2

YAML configuration example:

Style/ConstantNames:
  Enabled: true

[View source]
def self.new(*, __context_for_yaml_serializable ctx : YAML::ParseContext, __node_for_yaml_serializable node : YAML::Nodes::Node) #

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 severity : Ameba::Severity #

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

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

[View source]