class

Ameba::Rule::Style::HeredocEscape

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

A rule that enforces heredoc variant that escapes interpolation or control chars in a heredoc body. The opposite is enforced too - i.e. regular heredoc variant that doesn't escape interpolation or control chars in a heredoc body, when there is no need to escape it.

For example, this is considered invalid:

<<-DOC
  This is an escaped \#{:interpolated} string \\n
  DOC

And should be written as:

<<-'DOC'
  This is an escaped #{:interpolated} string \n
  DOC

YAML configuration example:

Style/HeredocEscape:
  Enabled: true

Constants

ESCAPE_SEQUENCE_PATTERN = /\\(?:[abefnrtv]|[CdDhHRsSvVwWX]|[0-7]{1,3}|x[0-9a-fA-F]{2}|u[0-9a-fA-F]{4}|u\{[0-9a-fA-F]{1,6}\})/
MSG_ESCAPE_NEEDED = "Use an escaped heredoc marker: `<<-'%s'`"
MSG_ESCAPE_NOT_NEEDED = "Use an unescaped heredoc marker: `<<-%s`"

Constructors

new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
new(config = nil)

A rule that enforces heredoc variant that escapes interpolation or control chars in a heredoc body. The opposite is enforced too - i.e. regular heredoc variant that doesn't escape interpolation or control chars in a heredoc body, when there is no need to escape it.

For example, this is considered invalid:

<<-DOC
  This is an escaped \#{:interpolated} string \\n
  DOC

And should be written as:

<<-'DOC'
  This is an escaped #{:interpolated} string \n
  DOC

YAML configuration example:

Style/HeredocEscape:
  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

Instance methods

description
description=(description : String)
enabled=(enabled : Bool)
enabled?
excluded
excluded=(excluded : Set(String) | Nil)
severity
severity=(severity : Ameba::Severity)
since_version
Source
since_version=(since_version : String)
test(source, node : Crystal::StringInterpolation)
Source