class

Ameba::Rule::Naming::BinaryOperatorParameterName

Inherits Ameba::AST::Util < YAML::Serializable < Ameba::Rule::Base < Ameba::Config::RuleConfig < Reference < Object

A rule that enforces that certain binary operator methods have standardized parameter names - by default other.

For example, this is considered valid:

class Money
  def +(other)
  end
end

And this is invalid parameter name:

class Money
  def +(amount)
  end
end

YAML configuration example:

Naming/BinaryOperatorParameterName:
  Enabled: true
  ExcludedOperators: ["[]", "[]?", "[]=", "<<", ">>", "=~", "!~"]
  AllowedNames: [other]

Constants

MSG = "When defining the `%s` operator, name its argument %s"

Constructors

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

A rule that enforces that certain binary operator methods have standardized parameter names - by default other.

For example, this is considered valid:

class Money
  def +(other)
  end
end

And this is invalid parameter name:

class Money
  def +(amount)
  end
end

YAML configuration example:

Naming/BinaryOperatorParameterName:
  Enabled: true
  ExcludedOperators: ["[]", "[]?", "[]=", "<<", ">>", "=~", "!~"]
  AllowedNames: [other]
Source
new(*, __context_for_yaml_serializable ctx : YAML::ParseContext, __node_for_yaml_serializable node : YAML::Nodes::Node)

Class methods

deprecated?

Returns true if this rule is deprecated, false otherwise.

deprecation_reason

Returns the deprecation reason for this rule, if there is any.

documentation_url

Returns the documentation URL for this rule.

Ameba::Rule::Lint::Syntax.documentation_url
# => "https://crystal-ameba.org/api/master/Ameba/Rule/Lint/Syntax.html"
parsed_doc

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."
to_json_schema(builder : JSON::Builder) : Nil
Source

Instance methods

allowed_names
allowed_names=(allowed_names : Array(String))
description
description=(description : String)
enabled=(enabled : Bool)
enabled?
excluded
excluded=(excluded : Set(String) | Nil)
excluded_operators
excluded_operators=(excluded_operators : Array(String))
severity
severity=(severity : Ameba::Severity)
since_version
Source
since_version=(since_version : String)
test(source, node : Crystal::Def)
Source