class

Ameba::Rule::Style::ParenthesesAroundCondition

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

A rule that checks for the presence of superfluous parentheses around the condition of if, unless, case, while and until.

For example, this is considered invalid:

if (foo == 42)
  do_something
end

And should be replaced by the following:

if foo == 42
  do_something
end

YAML configuration example:

Style/ParenthesesAroundCondition:
  Enabled: true
  ExcludeTernary: false
  ExcludeMultiline: false
  AllowSafeAssignment: false

Constants

MSG_MISSING = "Missing parentheses"

MSG_REDUNDANT = "Redundant parentheses"

Constructors

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

new(config = nil)

A rule that checks for the presence of superfluous parentheses around the condition of if, unless, case, while and until.

For example, this is considered invalid:

if (foo == 42)
  do_something
end

And should be replaced by the following:

if foo == 42
  do_something
end

YAML configuration example:

Style/ParenthesesAroundCondition:
  Enabled: true
  ExcludeTernary: false
  ExcludeMultiline: false
  AllowSafeAssignment: false

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

allow_safe_assignment=(allow_safe_assignment : Bool)

allow_safe_assignment?

description

description=(description : String)

enabled=(enabled : Bool)

enabled?

exclude_multiline=(exclude_multiline : Bool)

exclude_multiline?

exclude_ternary=(exclude_ternary : Bool)

exclude_ternary?

excluded

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

severity

severity=(severity : Ameba::Severity)

since_version

Source

since_version=(since_version : String)

test(source, node : Crystal::If | Crystal::Unless | Crystal::Case | Crystal::While | Crystal::Until)

Source