class Ameba::Rule::Naming::BlockParameterName

Overview

A rule that reports non-descriptive block parameter names.

Favour this:

tokens.each { |token| token.last_accessed_at = Time.utc }

Over this:

tokens.each { |t| t.last_accessed_at = Time.utc }

YAML configuration example:

Naming/BlockParameterName:
  Enabled: true
  MinNameLength: 3
  AllowNamesEndingInNumbers: true
  AllowedNames: [e, i, j, k, v, x, y, ex, io, ws, op, tx, id, ip, k1, k2, v1, v2]
  ForbiddenNames: []

Included Modules

Defined in:

ameba/rule/naming/block_parameter_name.cr

Constant Summary

MSG = "Disallowed block parameter name found"

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 reports non-descriptive block parameter names.

Favour this:

tokens.each { |token| token.last_accessed_at = Time.utc }

Over this:

tokens.each { |t| t.last_accessed_at = Time.utc }

YAML configuration example:

Naming/BlockParameterName:
  Enabled: true
  MinNameLength: 3
  AllowNamesEndingInNumbers: true
  AllowedNames: [e, i, j, k, v, x, y, ex, io, ws, op, tx, id, ip, k1, k2, v1, v2]
  ForbiddenNames: []

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

def allow_names_ending_in_numbers? : Bool #

def allowed_names : Array(String) #

def allowed_names=(allowed_names : Array(String)) #

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 forbidden_names : Array(String) #

def forbidden_names=(forbidden_names : Array(String)) #

def min_name_length : Int32 #

def min_name_length=(min_name_length : Int32) #

def severity : Ameba::Severity #

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

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

[View source]