struct Ameba::Rule::Style::TypeNames
- Ameba::Rule::Style::TypeNames
- Ameba::Rule::Base
- Struct
- Value
- Object
Overview
A rule that enforces type names in camelcase manner.
For example, these are considered valid:
class ParseError < Exception
end
module HTTP
class RequestHandler
end
end
alias NumericValue = Float32 | Float64 | Int32 | Int64
lib LibYAML
end
struct TagDirective
end
enum Time::DayOfWeek
end
And these are invalid type names
class My_class
end
module HTT_p
end
alias Numeric_value = Int32
lib Lib_YAML
end
struct Tag_directive
end
enum Time_enum::Day_of_week
end
YAML configuration example:
Style/TypeNames:
Enabled: true
Defined in:
ameba/rule/style/type_names.crConstant Summary
-
MSG =
"Type name should be camelcased: %s, but it was %s"
Constructors
-
.new(config = nil)
A rule that enforces type names in camelcase manner.
Instance Method Summary
- #test(source, node : Crystal::ClassDef)
- #test(source, node : Crystal::Alias)
- #test(source, node : Crystal::LibDef)
- #test(source, node : Crystal::EnumDef)
- #test(source, node : Crystal::ModuleDef)
- #test(source)
Instance methods inherited from struct Ameba::Rule::Base
catch(source : Source)
catch,
excluded?(source)
excluded?,
group
group,
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
Constructor Detail
def self.new(config = nil)
#
A rule that enforces type names in camelcase manner.
For example, these are considered valid:
class ParseError < Exception
end
module HTTP
class RequestHandler
end
end
alias NumericValue = Float32 | Float64 | Int32 | Int64
lib LibYAML
end
struct TagDirective
end
enum Time::DayOfWeek
end
And these are invalid type names
class My_class
end
module HTT_p
end
alias Numeric_value = Int32
lib Lib_YAML
end
struct Tag_directive
end
enum Time_enum::Day_of_week
end
YAML configuration example:
Style/TypeNames:
Enabled: true