class Ameba::Formatter::TODOFormatter

Overview

A formatter that creates a TODO config.

Basically, it takes all issues reported and disables corresponding rules or excludes failed sources from these rules.

Defined in:

ameba/formatter/todo_formatter.cr

Constructors

Instance Method Summary

Instance methods inherited from class Ameba::Formatter::DotFormatter

finished(sources) : Nil finished, source_finished(source : Source) : Nil source_finished, started(sources) : Nil started

Instance methods inherited from module Ameba::Formatter::Util

affected_code(issue : Issue, context_lines = 0, max_length = 120, ellipsis = " ...", prompt = "> ")
affected_code(code, location, end_location = nil, context_lines = 0, max_length = 120, ellipsis = " ...", prompt = "> ") affected_code, colorize_code_fences(string : String, color : Colorize::Color = :dark_gray) colorize_code_fences, colorize_markdown(string : String, code_color : Colorize::Color = :dark_gray) colorize_markdown, colorize_text_styles(string : String) colorize_text_styles, context(lines, lineno, context_lines = 3, remove_empty = true) context, deansify(message : String | Nil) : String | Nil deansify, pluralize(count : Int, singular : String, plural = "#{singular}s") pluralize, to_human(span : Time::Span) to_human, trim(str, max_length = 120, ellipsis = " ...") trim

Instance methods inherited from class Ameba::Formatter::BaseFormatter

config : Hash(Symbol, Bool | String) config, finished(sources) : Nil finished, output : IO::FileDescriptor | IO::Memory output, source_finished(source : Source) : Nil source_finished, source_started(source : Source) : Nil source_started, started(sources) : Nil started

Constructor methods inherited from class Ameba::Formatter::BaseFormatter

new(output : IO = STDOUT) new

Constructor Detail

def self.new(output = STDOUT, config_path : Path = Config::Loader::DEFAULT_PATH) #

Instance Method Detail

def config_path : Path #

def finished(sources) : Nil #
Description copied from class Ameba::Formatter::DotFormatter

Reports a message when inspection is finished.