class

Ameba::Rule::Style::RedundantSelf

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

A rule that disallows redundant uses of self.

This is considered bad:

class Greeter
  getter name : String

  def self.init
    self.new("Crystal").greet
  end

  def initialize(@name)
  end

  def greet
    puts "Hello, my name is #{self.name}"
  end

  self.init
end

And needs to be written as:

class Greeter
  getter name : String

  def self.init
    new("Crystal").greet
  end

  def initialize(@name)
  end

  def greet
    puts "Hello, my name is #{name}"
  end

  init
end

YAML configuration example:

Style/RedundantSelf:
  Enabled: true
  AllowedMethodNames:
    - in?
    - inspect
    - not_nil!

Constants

CRYSTAL_KEYWORDS = Crystal::Keyword.values.map(&.to_s)

MSG = "Redundant `self` detected"

Constructors

new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)

new(config = nil)

A rule that disallows redundant uses of self.

This is considered bad:

class Greeter
  getter name : String

  def self.init
    self.new("Crystal").greet
  end

  def initialize(@name)
  end

  def greet
    puts "Hello, my name is #{self.name}"
  end

  self.init
end

And needs to be written as:

class Greeter
  getter name : String

  def self.init
    new("Crystal").greet
  end

  def initialize(@name)
  end

  def greet
    puts "Hello, my name is #{name}"
  end

  init
end

YAML configuration example:

Style/RedundantSelf:
  Enabled: true
  AllowedMethodNames:
    - in?
    - inspect
    - not_nil!

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