class Ameba::Formatter::BaseFormatter

• Ameba::Formatter::BaseFormatter
• Reference
• Object

Overview

A base formatter for all formatters. It uses #output IO to report results and also implements stub methods for callbacks in Ameba::Runner#run method.

Direct Known Subclasses

• Ameba::Formatter::DisabledFormatter
• Ameba::Formatter::DotFormatter
• Ameba::Formatter::FlycheckFormatter
• Ameba::Formatter::GitHubActionsFormatter
• Ameba::Formatter::JSONFormatter

Defined in:

ameba/formatter/base_formatter.cr

Constructors

• .new(output : IO = STDOUT)

Instance Method Summary

• #config : Hash(Symbol, Bool | String)
• #finished(sources) : Nil

  Callback that indicates when inspection is finished.

• #output : IO::FileDescriptor | IO::Memory

  TODO allow other IOs

• #source_finished(source : Source) : Nil

  Callback that indicates when source inspection is finished.

• #source_started(source : Source) : Nil

  Callback that indicates when source inspection is started.

• #started(sources) : Nil

  Callback that indicates when inspecting is started.

Constructor Detail

Instance Method Detail