class

Ameba::Rule::Lint::ComparisonToBoolean

Inherits Ameba::AST::Util < YAML::Serializable < Ameba::Rule::Base < Ameba::Config::RuleConfig < Reference < Object

A rule that disallows comparison to booleans.

For example, these are considered invalid:

foo == true
bar != false
false === baz

This is because these expressions evaluate to true or false, so you could get the same result by using either the variable directly, or negating the variable.

YAML configuration example:

Lint/ComparisonToBoolean:
  Enabled: true

Constants

MSG = "Comparison to a boolean is pointless"

OP_NAMES = ["==", "!=", "==="] of ::String

Constructors

new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)

new(config = nil)

A rule that disallows comparison to booleans.

For example, these are considered invalid:

foo == true
bar != false
false === baz

This is because these expressions evaluate to true or false, so you could get the same result by using either the variable directly, or negating the variable.

YAML configuration example:

Lint/ComparisonToBoolean:
  Enabled: true

Source

new(*, __context_for_yaml_serializable ctx : YAML::ParseContext, __node_for_yaml_serializable node : YAML::Nodes::Node)

Class methods

deprecated?

Returns true if this rule is deprecated, false otherwise.

deprecation_reason

Returns the deprecation reason for this rule, if there is any.

documentation_url

Returns the documentation URL for this rule.

Ameba::Rule::Lint::Syntax.documentation_url
# => "https://crystal-ameba.org/api/master/Ameba/Rule/Lint/Syntax.html"

parsed_doc

Returns the documentation for this rule, if there is any.

module Ameba
  # This is a test rule.
  # Does nothing.
  class Rule::MyRule < Rule::Base
    def test(source)
    end
  end
end

Ameba::Rule::MyRule.parsed_doc # => "This is a test rule.\nDoes nothing."

to_json_schema(builder : JSON::Builder) : Nil

Source

Instance methods

description

description=(description : String)

enabled=(enabled : Bool)

enabled?

excluded

excluded=(excluded : Set(String) | Nil)

severity

severity=(severity : Ameba::Severity)

since_version

Source

since_version=(since_version : String)

test(source, node : Crystal::Call)

Source