Class: Solargraph::Diagnostics::Base

Inherits:

Object

• Object
• Solargraph::Diagnostics::Base

Defined in:

lib/solargraph/diagnostics/base.rb

Overview

The base class for diagnostics reporters.

Direct Known Subclasses

RequireNotFound, Rubocop, TypeCheck, UpdateErrors

Instance Attribute Summary

• #args ⇒ Array<String> readonly

Instance Method Summary

• #diagnose(source, api_map) ⇒ Array<Hash>

  Perform a diagnosis on a Source within the context of an ApiMap.

• #initialize(*args) ⇒ Base constructor

  A new instance of Base.

Constructor Details

#initialize(*args) ⇒ Base

Returns a new instance of Base.

# File 'lib/solargraph/diagnostics/base.rb', line 11

def initialize *args
  @args = args
end

Instance Attribute Details

#args ⇒ Array<String> (readonly)

Returns:

• (Array<String>)

# File 'lib/solargraph/diagnostics/base.rb', line 9

def args
  @args
end

Instance Method Details

#diagnose(source, api_map) ⇒ Array<Hash>

Perform a diagnosis on a Source within the context of an ApiMap. The result is an array of hash objects that conform to the LSP’s Diagnostic specification.

Subclasses should override this method.

Parameters:

• source (Solargraph::Source)
• api_map (Solargraph::ApiMap)

Returns:

• (Array<Hash>)

# File 'lib/solargraph/diagnostics/base.rb', line 24

def diagnose source, api_map
  []
end