class Ameba::Rule::Lint::Typos

Overview

A rule that reports typos found in source files.

NOTE Needs typos CLI tool.

NOTE See the chapter on false positives.

YAML configuration example:

Lint/Typos:
  Enabled: true
  BinPath: ~
  FailOnMissingBin: false
  FailOnError: true

Included Modules

Defined in:

ameba/rule/lint/typos.cr

Constant Summary

BIN_PATH = begin Process.find_executable("typos") rescue nil end
MSG = "Typo found: `%s` -> %s"

Constructors

Class Method Summary

Instance Method Summary

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

==(other : self) ==, catch(source : Source) catch, excluded?(source, root = Dir.current) 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, group_name group_name, rule_name rule_name

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 reports typos found in source files.

NOTE Needs typos CLI tool.

NOTE See the chapter on false positives.

YAML configuration example:

Lint/Typos:
  Enabled: true
  BinPath: ~
  FailOnMissingBin: false
  FailOnError: true

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

Class Method Detail

def self.deprecated? #

Returns true if this rule is deprecated, false otherwise.


def self.deprecation_reason : String | Nil #

Returns the deprecation reason for this rule, if there is any.


def self.documentation_url : String #

Returns the documentation URL for this rule.

Ameba::Rule::Lint::Syntax.documentation_url
# => "https://crystal-ameba.org/api/master/Ameba/Rule/Lint/Syntax.html"

def self.parsed_doc : String | Nil #

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."

def self.to_json_schema(builder : JSON::Builder) : Nil #

Instance Method Detail

def bin_path : String | Nil #

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

def description : String #

def description=(description : String) #

def enabled=(enabled : Bool) #

def enabled? : Bool #

def excluded : Set(String) | Nil #

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

def fail_on_error=(fail_on_error : Bool) #

def fail_on_error? : Bool #

def fail_on_missing_bin=(fail_on_missing_bin : Bool) #

def fail_on_missing_bin? : Bool #

def severity : Ameba::Severity #

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

def since_version : SemanticVersion | Nil #

def since_version=(since_version : String) #

def test(source : Source) #
Description copied from class Ameba::Rule::Base

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.