struct Ameba::Rule::Lint::BadDirective
- Ameba::Rule::Lint::BadDirective
- Ameba::Rule::Base
- Struct
- Value
- Object
Overview
A rule that reports incorrect comment directives for Ameba.
For example, the user can mistakenly add a directive to disable a rule that even doesn't exist:
# ameba:disable BadRuleName
def foo
:bar
end
YAML configuration example:
Lint/BadDirective:
Enabled: true
Defined in:
ameba/rule/lint/bad_directive.crConstant Summary
-
ALL_GROUP_NAMES =
Rule.rules.map(&.group_name).uniq!
-
ALL_RULE_NAMES =
Rule.rules.map(&.rule_name)
-
AVAILABLE_ACTIONS =
InlineComments::Action.names.map(&.downcase)
Constructors
-
.new(config = nil)
A rule that reports incorrect comment directives for Ameba.
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
Constructor Detail
def self.new(config = nil)
#
A rule that reports incorrect comment directives for Ameba.
For example, the user can mistakenly add a directive to disable a rule that even doesn't exist:
# ameba:disable BadRuleName
def foo
:bar
end
YAML configuration example:
Lint/BadDirective:
Enabled: true