class Ameba::Rule::Lint::UnusedLiteral

• Ameba::Rule::Lint::UnusedLiteral
• Ameba::Rule::Base
• Reference
• Object

Overview

A rule that disallows unused literal values (strings, symbols, integers, etc).

For example, these are considered invalid:

1234_f32

"hello world"

if check?
  true
else
  false
end

def method
  if guard?
    false
  end

  true
end

And these are considered valid:

a = 1234_f32

def method
  if guard?
    false
  else
    true
  end
end

my_proc = -> : Bool { true }

YAML configuration example:

Lint/UnusedLiteral:
  Enabled: true

Included Modules

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

Defined in:

Constant Summary

MSG = "Literal value is not used"

Constructors

• .new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
• .new(config = nil)

  A rule that disallows unused literal values (strings, symbols, integers, etc).

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, node : Crystal::RegexLiteral, last_is_used : Bool)
• #test(source, node : Crystal::BoolLiteral | Crystal::CharLiteral | Crystal::HashLiteral | Crystal::ProcLiteral | Crystal::ArrayLiteral | Crystal::RangeLiteral | Crystal::TupleLiteral | Crystal::NumberLiteral | Crystal::StringLiteral | Crystal::SymbolLiteral | Crystal::NamedTupleLiteral | Crystal::StringInterpolation, last_is_used : Bool)
• #test(source : Source)

  This method is designed to test the source passed in.

Constructor Detail

1234_f32

"hello world"

if check?
  true
else
  false
end

def method
  if guard?
    false
  end

  true
end

a = 1234_f32

def method
  if guard?
    false
  else
    true
  end
end

my_proc = -> : Bool { true }

Lint/UnusedLiteral:
  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