class

Ameba::Rule::Lint::Typos

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

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

Constants

BIN_PATH = begin Process.find_executable("typos") rescue nil end

MSG = "Typo found: `%s` -> %s"

Constructors

new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)

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

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

bin_path

Source

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

description

description=(description : String)

enabled=(enabled : Bool)

enabled?

excluded

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

fail_on_error=(fail_on_error : Bool)

fail_on_error?

fail_on_missing_bin=(fail_on_missing_bin : Bool)

fail_on_missing_bin?

severity

severity=(severity : Ameba::Severity)

since_version

Source

since_version=(since_version : String)

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