class

Ameba::Rule::Lint::Formatting

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

A rule that verifies syntax formatting according to the Crystal's built-in formatter.

For example, this syntax is invalid:

def foo(a,b,c=0)
  #foobar
  a+b+c
end

And should be properly written:

def foo(a, b, c = 0)
  # foobar
  a + b + c
end

YAML configuration example:

Lint/Formatting:
  Enabled: true
  FailOnError: false

Constants

MSG = "Use built-in formatter to format this source"

MSG_ERROR = "Error while formatting: %s"

Constructors

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

new(config = nil)

A rule that verifies syntax formatting according to the Crystal's built-in formatter.

For example, this syntax is invalid:

def foo(a,b,c=0)
  #foobar
  a+b+c
end

And should be properly written:

def foo(a, b, c = 0)
  # foobar
  a + b + c
end

YAML configuration example:

Lint/Formatting:
  Enabled: true
  FailOnError: false

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

description

description=(description : String)

enabled=(enabled : Bool)

enabled?

excluded

excluded=(excluded : Set(String) | Nil)

fail_on_error=(fail_on_error : Bool)

fail_on_error?

severity

severity=(severity : Ameba::Severity)

since_version

Source

since_version=(since_version : String)

test(source)

Source