class Ameba::Rule::Lint::UnusedGenericOrUnion

Overview

A rule that disallows unused generics or unions (String?, StaticArray(Int32, 10), etc).

For example, these are considered invalid:

String?

Float64 | StaticArray(Float64, 10)

def size
  Float64 | Int32
  0.1
end

And these are considered valid:

a : Int32 = 10

klass = String?

alias MyType = Float64 | StaticArray(Float64, 10)

def size : Float64
  0.1
end

YAML configuration example:

Lint/UnusedGenericOrUnion:
  Enabled: true

Included Modules

Defined in:

ameba/rule/lint/unused_generic_or_union.cr

Constant Summary

MSG_GENERIC = "Generic is not used"
MSG_UNION = "Union is not used"

Constructors

Class Method Summary

Instance Method Summary

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

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

default_severity : Ameba::Severity default_severity

Macros inherited from class Ameba::Rule::Base

issue_for(*args, **kwargs, &block) issue_for

Macros inherited from module Ameba::Config::RuleConfig

properties(&block) properties

Constructor Detail

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

def self.new(config = nil) #

A rule that disallows unused generics or unions (String?, StaticArray(Int32, 10), etc).

For example, these are considered invalid:

String?

Float64 | StaticArray(Float64, 10)

def size
  Float64 | Int32
  0.1
end

And these are considered valid:

a : Int32 = 10

klass = String?

alias MyType = Float64 | StaticArray(Float64, 10)

def size : Float64
  0.1
end

YAML configuration example:

Lint/UnusedGenericOrUnion:
  Enabled: true

[View source]

Class Method Detail

def self.parsed_doc : String | Nil #

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=(enabled : Bool) #

def enabled? : Bool #

def excluded : Array(String) | Nil #

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

def severity : Ameba::Severity #

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

def since_version : SemanticVersion | Nil #

[View source]
def since_version=(since_version : String) #

def test(source, node : Crystal::Call, node_is_used : Bool) #

[View source]
def test(source, node : Crystal::Generic, node_is_used : Bool) #

[View source]
def test(source : Source) #
Description copied from class Ameba::Rule::Base

This method is designed to test the source passed in. If source has issues that are tested by this rule, it should add an issue.

By default it uses a node visitor to traverse all the nodes in the source.

NOTE Must be overridden for other type of rules.


[View source]