class Ameba::Rule::Lint::Typos

• Ameba::Rule::Lint::Typos
• Ameba::Rule::Base
• Reference
• Object

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: ~
  FailOnError: false

Included Modules

• YAML::Serializable
• YAML::Serializable::Strict

Defined in:

Constant Summary

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.

Class Method Summary

• .parsed_doc : String | Nil

  Returns documentation for this rule, if there is any.

Instance Method Summary

• #bin_path : String | Nil
• #bin_path=(bin_path : Union(String, Nil))
• #description : String
• #description=(description : String)
• #enabled=(enabled : Bool)
• #enabled? : Bool
• #excluded : Array(String) | Nil
• #excluded=(excluded : Array(String) | Nil)
• #fail_on_error=(fail_on_error : Bool)
• #fail_on_error? : Bool
• #severity : Ameba::Severity
• #severity=(severity : Ameba::Severity)
• #since_version : SemanticVersion | Nil
• #since_version=(since_version : String)
• #test(source : Source)

  This method is designed to test the source passed in.

Constructor Detail

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

Class Method Detail

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