class Ameba::Rule::Style::PercentLiteralDelimiters

Overview

A rule that enforces the consistent usage of %-literal delimiters.

Specifying DefaultDelimiters option will set all preferred delimiters at once. You can continue to specify individual preferred delimiters via PreferredDelimiters setting to override the default. In both cases the delimiters should be specified as a string of two characters, or nil to ignore a particular %-literal / default.

Setting IgnoreLiteralsContainingDelimiters to true will ignore %-literals that contain one or both delimiters.

YAML configuration example:

Style/PercentLiteralDelimiters:
  Enabled: true
  DefaultDelimiters: '()'
  PreferredDelimiters:
    '%w': '[]'
    '%i': '[]'
    '%r': '{}'
  IgnoreLiteralsContainingDelimiters: false

Included Modules

Defined in:

ameba/rule/style/percent_literal_delimiters.cr

Constant Summary

MSG = "`%s`-literals should be delimited by `%s` and `%s`"

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(hasher) 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 the consistent usage of %-literal delimiters.

Specifying DefaultDelimiters option will set all preferred delimiters at once. You can continue to specify individual preferred delimiters via PreferredDelimiters setting to override the default. In both cases the delimiters should be specified as a string of two characters, or nil to ignore a particular %-literal / default.

Setting IgnoreLiteralsContainingDelimiters to true will ignore %-literals that contain one or both delimiters.

YAML configuration example:

Style/PercentLiteralDelimiters:
  Enabled: true
  DefaultDelimiters: '()'
  PreferredDelimiters:
    '%w': '[]'
    '%i': '[]'
    '%r': '{}'
  IgnoreLiteralsContainingDelimiters: false

[View source]
def self.new(*, __context_for_yaml_serializable ctx : YAML::ParseContext, __node_for_yaml_serializable node : YAML::Nodes::Node) #

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 default_delimiters : Union(String, Nil) #

def default_delimiters=(default_delimiters : Union(String, Nil)) #

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 ignore_literals_containing_delimiters=(ignore_literals_containing_delimiters : Bool) #

def ignore_literals_containing_delimiters? : Bool #

def preferred_delimiters : Hash(String, String?) #

def preferred_delimiters=(preferred_delimiters : Hash(String, Nil | String)) #

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) #

[View source]