class Ameba::Rule::Style::HeredocIndent

Overview

A rule that enforces Heredoc bodies be indented one level above the indentation of the line they're used on.

For example, this is considered invalid:

<<-HERERDOC
  hello world
HEREDOC

  <<-HERERDOC
hello world
HEREDOC

And should be written as:

<<-HERERDOC
    hello world
  HEREDOC

  <<-HERERDOC
    hello world
    HEREDOC

The IndentBy configuration option changes the enforced indentation level of the heredoc.

Style/HeredocIndent:
  Enabled: true
  IndentBy: 2

Included Modules

Defined in:

ameba/rule/style/heredoc_indent.cr

Constant Summary

MSG = "Heredoc body should be indented by %s spaces"

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from class Ameba::Rule::Base

==(other) ==, catch(source : Source) catch, excluded?(source) excluded?, group group, hash hash, name name, special? special?, test(source : Source, node : Crystal::ASTNode, *opts)
test(source : Source) test

Class methods inherited from class Ameba::Rule::Base

default_severity : Ameba::Severity default_severity

Macros inherited from class Ameba::Rule::Base

issue_for(*args, **kwargs, &block) issue_for

Macros inherited from module Ameba::Config::RuleConfig

properties(&block) properties

Constructor Detail

def self.new(ctx : YAML::ParseContext, node : YAML::Nodes::Node) #

def self.new(config = nil) #

A rule that enforces Heredoc bodies be indented one level above the indentation of the line they're used on.

For example, this is considered invalid:

<<-HERERDOC
  hello world
HEREDOC

  <<-HERERDOC
hello world
HEREDOC

And should be written as:

<<-HERERDOC
    hello world
  HEREDOC

  <<-HERERDOC
    hello world
    HEREDOC

The IndentBy configuration option changes the enforced indentation level of the heredoc.

Style/HeredocIndent:
  Enabled: true
  IndentBy: 2

[View source]

Class Method Detail

def self.parsed_doc : String | Nil #

Returns documentation for this rule, if there is any.

module Ameba
  # This is a test rule.
  # Does nothing.
  class MyRule < Ameba::Rule::Base
    def test(source)
    end
  end
end

MyRule.parsed_doc # => "This is a test rule.\nDoes nothing."

Instance Method Detail

def description : String #

def description=(description : String) #

def enabled=(enabled : Bool) #

def enabled? : Bool #

def excluded : Array(String) | Nil #

def excluded=(excluded : Array(String) | Nil) #

def indent_by : Int32 #

def indent_by=(indent_by : Int32) #

def severity : Ameba::Severity #

def severity=(severity : Ameba::Severity) #

def since_version : SemanticVersion | Nil #

[View source]
def since_version=(since_version : String) #

def test(source, node : Crystal::StringInterpolation) #

[View source]