class

Ameba::Rule::Naming::VariableNames

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

A rule that enforces variable names to be in underscored case.

For example, these variable names are considered valid:

var_name = 1
name = 2
_another_good_name = 3

And these are invalid variable names:

myBadNamedVar = 1
wrong_Name = 2

YAML configuration example:

Naming/VariableNames:
  Enabled: true

Constants

MSG = "Variable name should be underscore-cased: `%s`, not `%s`"

Constructors

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

A rule that enforces variable names to be in underscored case.

For example, these variable names are considered valid:

var_name = 1
name = 2
_another_good_name = 3

And these are invalid variable names:

myBadNamedVar = 1
wrong_Name = 2

YAML configuration example:

Naming/VariableNames:
  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::Var | Crystal::InstanceVar | Crystal::ClassVar)
Source
test(source : Source)

This method is designed to test the source passed in. If source has issues that are tested by this rule, it should add an issue.

By default it uses a node visitor to traverse all the nodes in the source.

NOTE: Must be overridden for other type of rules.

Source