class

Ameba::Rule::Lint::VoidOutsideLib

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

A rule that disallows uses of Void outside C lib bindings. Using Void outside of C lib bindings doesn't make sense, and can sometimes break the compiler. Nil should be used instead in these cases. Pointer(Void) is the only case that's allowed per this rule.

These are considered invalid:

def foo(bar : Void) : Slice(Void)?
end

alias Baz = Void

struct Qux < Void
end

YAML configuration example:

Lint/VoidOutsideLib:
  Enabled: true

Constants

MSG = "`Void` is not allowed in this context"

Constructors

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

new(config = nil)

These are considered invalid:

def foo(bar : Void) : Slice(Void)?
end

alias Baz = Void

struct Qux < Void
end

YAML configuration example:

Lint/VoidOutsideLib:
  Enabled: true

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