Ameba::Rule::Lint::TopLevelOperatorDefinition

A rule that disallows top level operator method definitions, since these cannot be called.

For example, this is considered invalid:

def +(other)
end

And has to be written within a class, struct, or module:

class Foo
  def +(other)
  end
end

YAML configuration example:

Lint/TopLevelOperatorDefinition:
  Enabled: true

Returns true if this rule is deprecated, false otherwise.

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

Returns the documentation URL for this rule.

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

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."