Class: Lintrunner::Reporter::Base

Inherits:

Object

• Object
• Lintrunner::Reporter::Base

Defined in:

lib/lintrunner/reporter/base.rb

Direct Known Subclasses

File, Text

Instance Attribute Summary

• #path ⇒ Object readonly

  Returns the value of attribute path.

Instance Method Summary

• #description ⇒ Object

  The description of this reporter.

• #finish(messages) ⇒ Object

  Called when the lintrunner is finished executing.

• #initialize(path) ⇒ Base constructor

  A new instance of Base.

• #report(message) ⇒ Object

  Called when a message is discovered from the lintrunner.

• #start(name) ⇒ Object

  Called when a lintrunner is started.

Constructor Details

#initialize(path) ⇒ Base

Returns a new instance of Base.

# File 'lib/lintrunner/reporter/base.rb', line 9

def initialize(path)
  @path = path
end

Instance Attribute Details

#path ⇒ Object (readonly)

Returns the value of attribute path.

# File 'lib/lintrunner/reporter/base.rb', line 7

def path
  @path
end

Instance Method Details

#description ⇒ Object

The description of this reporter. Used for CLI when listing possible reporters

# File 'lib/lintrunner/reporter/base.rb', line 26

def description; end

#finish(messages) ⇒ Object

Called when the lintrunner is finished executing

Parameters:

• messages (Array<Lintrunner::Message>)

# File 'lib/lintrunner/reporter/base.rb', line 23

def finish(messages); end

#report(message) ⇒ Object

Called when a message is discovered from the lintrunner

Parameters:

• message (Lintrunner::Message)

# File 'lib/lintrunner/reporter/base.rb', line 19

def report(message); end

#start(name) ⇒ Object

Called when a lintrunner is started

Parameters:

• name (String) —

  The name of the lintrunner (ex. “binding.pry check”)

# File 'lib/lintrunner/reporter/base.rb', line 15

def start(name); end