class Ameba::Rule::Style::WhileTrue

Overview

A rule that disallows the use of while true instead of using the idiomatic loop

For example, this is considered invalid:

while true
  do_something
  break if some_condition
end

And should be replaced by the following:

loop do
  do_something
  break if some_condition
end

YAML configuration example:

Style/WhileTrue:
  Enabled: true

Included Modules

YAML::Serializable

Defined in:

ameba/rule/style/while_true.cr

Constant Summary

MSG = "While statement using `true` literal as condition"

Constructors

.new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
.new(config = nil)
A rule that disallows the use of while true instead of using the idiomatic loop
.new(*, __context_for_yaml_serializable ctx : YAML::ParseContext, __node_for_yaml_serializable node : YAML::Nodes::Node)

Class Method Summary

.deprecated?
Returns true if this rule is deprecated, false otherwise.
.deprecation_reason : String | Nil
Returns the deprecation reason for this rule, if there is any.
.documentation_url : String
Returns the documentation URL for this rule.
.parsed_doc : String | Nil
Returns the documentation for this rule, if there is any.
.to_json_schema(builder : JSON::Builder) : Nil

Instance Method Summary

#description : String
#description=(description : String)
#enabled=(enabled : Bool)
#enabled? : Bool
#excluded : Set(String) | Nil
#excluded=(excluded : Set(String) | Nil)
#severity : Ameba::Severity
#severity=(severity : Ameba::Severity)
#since_version : SemanticVersion | Nil
#since_version=(since_version : String)
#test(source, node : Crystal::While)

Instance methods inherited from class `Ameba::Rule::Base`

, , , , , , ,

Class methods inherited from class `Ameba::Rule::Base`

, ,

Macros inherited from class `Ameba::Rule::Base`

Macros inherited from module `Ameba::Config::RuleConfig`

Constructor Detail

def self.new(ctx : YAML::ParseContext, node : YAML::Nodes::Node) #

def self.new(config = nil) #

A rule that disallows the use of while true instead of using the idiomatic loop

For example, this is considered invalid:

while true
  do_something
  break if some_condition
end

And should be replaced by the following:

loop do
  do_something
  break if some_condition
end

YAML configuration example:

Style/WhileTrue:
  Enabled: true

def self.new(*, __context_for_yaml_serializable ctx : YAML::ParseContext, __node_for_yaml_serializable node : YAML::Nodes::Node) #

Class Method Detail

def self.deprecated? #

Returns true if this rule is deprecated, false otherwise.

def self.deprecation_reason : String | Nil #

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

def self.documentation_url : String #

Returns the documentation URL for this rule.

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

def self.parsed_doc : String | Nil #

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

def self.to_json_schema(builder : JSON::Builder) : Nil #

Instance Method Detail

def description : String #

def description=(description : String) #

def enabled=(enabled : Bool) #

def enabled? : Bool #

def excluded : Set(String) | Nil #

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

def severity : Ameba::Severity #

def severity=(severity : Ameba::Severity) #

def since_version : SemanticVersion | Nil #

def since_version=(since_version : String) #

def test(source, node : Crystal::While) #

ameba