Class: Parser::Diagnostic

Inherits:

Object

• Object
• Parser::Diagnostic

Defined in:

sorbet/rbi/parser@3.3.7.4.rbi

Overview

source://parser//lib/parser/diagnostic.rb#31

Defined Under Namespace

Classes: Engine

Constant Summary

LEVELS =

Collection of the available diagnostic levels.

source://parser//lib/parser/diagnostic.rb#37

Returns:

• (Array)

T.let(T.unsafe(nil), Array)

Instance Method Summary

• #arguments ⇒ Symbol

  source://parser//lib/parser/diagnostic.rb#39.

• #highlights ⇒ Array<Parser::Source::Range>

  Supplementary error-related source ranges.

• #initialize(level, reason, arguments, location, highlights = T.unsafe(nil)) ⇒ Diagnostic constructor

  source://parser//lib/parser/diagnostic.rb#49.

• #level ⇒ Symbol

  source://parser//lib/parser/diagnostic.rb#39.

• #location ⇒ Parser::Source::Range

  Main error-related source range.

• #message ⇒ String

  source://parser//lib/parser/diagnostic.rb#69.

• #reason ⇒ Symbol

  source://parser//lib/parser/diagnostic.rb#39.

• #render ⇒ Array<String>

  Renders the diagnostic message as a clang-like diagnostic.

Constructor Details

#initialize(level, reason, arguments, location, highlights = T.unsafe(nil)) ⇒ Diagnostic

source://parser//lib/parser/diagnostic.rb#49

Parameters:

• level (Symbol)
• reason (Symbol)
• arguments (Hash)
• location (Parser::Source::Range)
• highlights (Array<Parser::Source::Range>) (defaults to: T.unsafe(nil))

# File 'sorbet/rbi/parser@3.3.7.4.rbi', line 1714

def initialize(level, reason, arguments, location, highlights = T.unsafe(nil)); end

Instance Method Details

#arguments ⇒ Symbol

source://parser//lib/parser/diagnostic.rb#39

Returns:

• (Symbol) —

  extended arguments that describe the error

See Also:

• MESSAGES

# File 'sorbet/rbi/parser@3.3.7.4.rbi', line 1721

def arguments; end

#highlights ⇒ Array<Parser::Source::Range>

Supplementary error-related source ranges.

source://parser//lib/parser/diagnostic.rb#40

Returns:

• (Array<Parser::Source::Range>)

# File 'sorbet/rbi/parser@3.3.7.4.rbi', line 1729

def highlights; end

#level ⇒ Symbol

source://parser//lib/parser/diagnostic.rb#39

Returns:

• (Symbol) —

  diagnostic level

See Also:

• LEVELS

# File 'sorbet/rbi/parser@3.3.7.4.rbi', line 1736

def level; end

#location ⇒ Parser::Source::Range

Main error-related source range.

source://parser//lib/parser/diagnostic.rb#40

Returns:

• (Parser::Source::Range)

# File 'sorbet/rbi/parser@3.3.7.4.rbi', line 1744

def location; end

#message ⇒ String

source://parser//lib/parser/diagnostic.rb#69

Returns:

• (String) —

  the rendered message.

# File 'sorbet/rbi/parser@3.3.7.4.rbi', line 1750

def message; end

#reason ⇒ Symbol

source://parser//lib/parser/diagnostic.rb#39

Returns:

• (Symbol) —

  reason for error

See Also:

• MESSAGES

# File 'sorbet/rbi/parser@3.3.7.4.rbi', line 1757

def reason; end

#render ⇒ Array<String>

Renders the diagnostic message as a clang-like diagnostic.

source://parser//lib/parser/diagnostic.rb#86

Examples:

diagnostic.render # =>
# [
#   "(fragment:0):1:5: error: unexpected token $end",
#   "foo +",
#   "    ^"
# ]

Returns:

• (Array<String>)

# File 'sorbet/rbi/parser@3.3.7.4.rbi', line 1772

def render; end