class Ameba::Rule::Style::VariableNames
- Ameba::Rule::Style::VariableNames
- Ameba::Rule::Base
- Reference
- Object
Overview
A rule that enforces variable names to be in underscored case.
For example, these variable names are considered valid:
var_name = 1
name = 2
_another_good_name = 3
And these are invalid variable names:
myBadNamedVar = 1
wrong_Name = 2
YAML configuration example:
Style/VariableNames:
Enabled: true
Included Modules
- YAML::Serializable
- YAML::Serializable::Strict
Defined in:
ameba/rule/style/variable_names.crConstant Summary
-
MSG =
"Var name should be underscore-cased: %s, not %s"
Constructors
- .new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
-
.new(config = nil)
A rule that enforces variable names to be in underscored case.
Instance Method Summary
- #description : String
- #description=(description : String)
- #enabled : Bool
- #enabled=(enabled : Bool)
- #excluded : Array(String) | Nil
- #excluded=(excluded : Array(String) | Nil)
- #severity : Ameba::Severity
- #severity=(severity : Ameba::Severity)
- #test(source, node : Crystal::Var)
- #test(source, node : Crystal::InstanceVar)
- #test(source, node : Crystal::ClassVar)
-
#test(source : Source)
This method is designed to test the source passed in.
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(config = nil)
#
A rule that enforces variable names to be in underscored case.
For example, these variable names are considered valid:
var_name = 1
name = 2
_another_good_name = 3
And these are invalid variable names:
myBadNamedVar = 1
wrong_Name = 2
YAML configuration example:
Style/VariableNames:
Enabled: true
Instance Method Detail
Description copied from class Ameba::Rule::Base
This method is designed to test the source passed in. If source has issues that are tested by this rule, it should add an issue.
Be default it uses a node visitor to traverse all the nodes in the source. Must be overriten for other type of rules.