class Ameba::Rule::Naming::MethodNames
- Ameba::Rule::Naming::MethodNames
- Ameba::Rule::Base
- Reference
- Object
Overview
A rule that enforces method names to be in underscored case.
For example, these are considered valid:
class Person
def first_name
end
def date_of_birth
end
def homepage_url
end
end
And these are invalid method names:
class Person
def firstName
end
def date_of_Birth
end
def homepageURL
end
end
YAML configuration example:
Naming/MethodNames:
Enabled: true
Included Modules
- YAML::Serializable
- YAML::Serializable::Strict
Defined in:
ameba/rule/naming/method_names.crConstant Summary
-
MSG =
"Method name should be underscore-cased: %s, not %s"
Constructors
- .new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
-
.new(config = nil)
A rule that enforces method names to be in underscored case.
Class Method Summary
-
.parsed_doc : String | Nil
Returns documentation for this rule, if there is any.
Instance Method Summary
- #description : String
- #description=(description : String)
- #enabled=(enabled : Bool)
- #enabled? : Bool
- #excluded : Array(String) | Nil
- #excluded=(excluded : Array(String) | Nil)
- #severity : Ameba::Severity
- #severity=(severity : Ameba::Severity)
- #test(source, node : Crystal::Def)
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
default_severity : Ameba::Severity
default_severity
Macros inherited from class Ameba::Rule::Base
issue_for(*args, **kwargs, &block)
issue_for
Macros inherited from module Ameba::Config::RuleConfig
properties(&block)
properties
Constructor Detail
def self.new(config = nil)
#
A rule that enforces method names to be in underscored case.
For example, these are considered valid:
class Person
def first_name
end
def date_of_birth
end
def homepage_url
end
end
And these are invalid method names:
class Person
def firstName
end
def date_of_Birth
end
def homepageURL
end
end
YAML configuration example:
Naming/MethodNames:
Enabled: true
Class Method Detail
def self.parsed_doc : String | Nil
#
Returns documentation for this rule, if there is any.
module Ameba
# This is a test rule.
# Does nothing.
class MyRule < Ameba::Rule::Base
def test(source)
end
end
end
MyRule.parsed_doc # => "This is a test rule.\nDoes nothing."