class Ameba::Rule::Lint::BadDirective

• Ameba::Rule::Lint::BadDirective
• Ameba::Rule::Base
• Reference
• 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

Included Modules

• YAML::Serializable
• YAML::Serializable::Strict

Defined in:

Constant 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(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
• .new(config = nil)

  A rule that reports incorrect comment directives for Ameba.

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)
• #since_version : SemanticVersion | Nil
• #since_version=(since_version : String)
• #test(source)

Constructor Detail

# ameba:disable BadRuleName
def foo
  :bar
end

Lint/BadDirective:
  Enabled: true

Class Method Detail

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."

Instance Method Detail