class Ameba::Rule::Lint::UnreachableCode

Overview

A rule that reports unreachable code.

For example, this is considered invalid:

def method(a)
  return 42
  a + 1
end
a = 1
loop do
  break
  a += 1
end

And has to be written as the following:

def method(a)
  return 42 if a == 0
  a + 1
end
a = 1
loop do
  break a > 3
  a += 1
end

YAML configuration example:

Lint/UnreachableCode:
  Enabled: true

Included Modules

Defined in:

ameba/rule/lint/unreachable_code.cr

Constant Summary

MSG = "Unreachable code detected"

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from module Ameba::AST::Util

abort?(node) abort?, control_exp_code(node : Crystal::ControlExpression, code_lines) control_exp_code, dynamic_literal?(node, include_paths = false) : Bool dynamic_literal?, exit?(node) exit?, flow_command?(node, in_loop) flow_command?, flow_expression?(node, in_loop = false) flow_expression?, literal?(node, include_paths = false) : Bool literal?, loop?(node) loop?, name_end_location(node) name_end_location, name_location(node) name_location, name_size(node) name_size, node_source(node, code_lines) node_source, raise?(node) raise?, source_between(loc, end_loc, code_lines) : String? source_between, static_literal?(node, include_paths = false) : Bool static_literal?

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

==(other) ==, catch(source : Source) catch, excluded?(source) excluded?, group group, hash hash, name name, special? special?, test(source : Source, node : Crystal::ASTNode, *opts)
test(source : Source) test

Constructor Detail

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

def self.new(config = nil) #

A rule that reports unreachable code.

For example, this is considered invalid:

def method(a)
  return 42
  a + 1
end
a = 1
loop do
  break
  a += 1
end

And has to be written as the following:

def method(a)
  return 42 if a == 0
  a + 1
end
a = 1
loop do
  break a > 3
  a += 1
end

YAML configuration example:

Lint/UnreachableCode:
  Enabled: true

[View source]

Class Method Detail

def self.parsed_doc : String? #

Returns documentation for this rule, if there is any.

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

def description : String #

def description=(description : String) #

def enabled : Bool #

def enabled=(enabled : Bool) #

def excluded : Array(String)? #

def excluded=(excluded : Array(String)?) #

def severity : Ameba::Severity #

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

def test(source, node, flow_expression : AST::FlowExpression) #

[View source]
def test(source) #

[View source]