class Ameba::Rule::Lint::UnusedArgument

Overview

A rule that reports unused arguments. For example, this is considered invalid:

def method(a, b, c)
  a + b
end

and should be written as:

def method(a, b)
  a + b
end

YAML configuration example:

Lint/UnusedArgument:
  Enabled: true
  IgnoreDefs: true
  IgnoreBlocks: false
  IgnoreProcs: false

Included Modules

Defined in:

ameba/rule/lint/unused_argument.cr

Constant Summary

MSG = "Unused argument `%s`. If it's necessary, use `%s` as an argument name to indicate that it won't be used."

Constructors

Class Method Summary

Instance Method Summary

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

==(other : self) ==, catch(source : Source) catch, excluded?(source, root = Dir.current) excluded?, group group, hash(hasher) 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, group_name group_name, rule_name rule_name

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 reports unused arguments. For example, this is considered invalid:

def method(a, b, c)
  a + b
end

and should be written as:

def method(a, b)
  a + b
end

YAML configuration example:

Lint/UnusedArgument:
  Enabled: true
  IgnoreDefs: true
  IgnoreBlocks: false
  IgnoreProcs: false

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

def ignore_blocks? : Bool #

def ignore_defs=(ignore_defs : Bool) #

def ignore_defs? : Bool #

def ignore_procs=(ignore_procs : Bool) #

def ignore_procs? : Bool #

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::ProcLiteral, scope : AST::Scope) #

def test(source, node : Crystal::Block, scope : AST::Scope) #

def test(source, node : Crystal::Def, scope : AST::Scope) #

def test(source) #