Class: LanguageServer::Protocol::Interface::DiagnosticOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/language_server/protocol/interface/diagnostic_options.rb,
sig/language_server/protocol/interface/diagnostic_options.rbs

Overview

Diagnostic options.

Since:

  • 3.17.0

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(identifier: nil, inter_file_dependencies:, workspace_diagnostics:, work_done_progress: nil) ⇒ DiagnosticOptions

Returns a new instance of DiagnosticOptions.

Parameters:

  • identifier: (String) (defaults to: nil)
  • inter_file_dependencies: (Boolean)
  • workspace_diagnostics: (Boolean)
  • work_done_progress: (Boolean) (defaults to: nil)

Since:

  • 3.17.0



10
11
12
13
14
15
16
17
18
19
 
# File 'lib/language_server/protocol/interface/diagnostic_options.rb', line 10

def initialize(identifier: nil, inter_file_dependencies:, workspace_diagnostics:, work_done_progress: nil)
  @attributes = {}

  @attributes[:identifier] = identifier if identifier
  @attributes[:interFileDependencies] = inter_file_dependencies
  @attributes[:workspaceDiagnostics] = workspace_diagnostics
  @attributes[:workDoneProgress] = work_done_progress if work_done_progress

  @attributes.freeze
end

Instance Attribute Details

#attributes ⇒ Hash[Symbol, untyped] (readonly)

Returns:

  • (Hash[Symbol, untyped])

Since:

  • 3.17.0



54
55
56
 
# File 'lib/language_server/protocol/interface/diagnostic_options.rb', line 54

def attributes
  @attributes
end

Instance Method Details

#identifier ⇒ string

An optional identifier under which the diagnostics are managed by the client.

Returns:

  • (string)

Since:

  • 3.17.0



26
27
28
 
# File 'lib/language_server/protocol/interface/diagnostic_options.rb', line 26

def identifier
  attributes.fetch(:identifier)
end

#inter_file_dependencies ⇒ boolean

Whether the language has inter file dependencies meaning that editing code in one file can result in a different diagnostic set in another file. Inter file dependencies are common for most programming languages and typically uncommon for linters.

Returns:

  • (boolean)

Since:

  • 3.17.0



37
38
39
 
# File 'lib/language_server/protocol/interface/diagnostic_options.rb', line 37

def inter_file_dependencies
  attributes.fetch(:interFileDependencies)
end

#to_hash ⇒ Hash[Symbol, untyped]

Returns:

  • (Hash[Symbol, untyped])

Since:

  • 3.17.0



56
57
58
 
# File 'lib/language_server/protocol/interface/diagnostic_options.rb', line 56

def to_hash
  attributes
end

#to_json(*args) ⇒ String

Parameters:

  • (Object)

Returns:

  • (String)

Since:

  • 3.17.0



60
61
62
 
# File 'lib/language_server/protocol/interface/diagnostic_options.rb', line 60

def to_json(*args)
  to_hash.to_json(*args)
end

#work_done_progress ⇒ boolean

Returns:

  • (boolean)

Since:

  • 3.17.0



50
51
52
 
# File 'lib/language_server/protocol/interface/diagnostic_options.rb', line 50

def work_done_progress
  attributes.fetch(:workDoneProgress)
end

#workspace_diagnostics ⇒ boolean

The server provides support for workspace diagnostics as well.

Returns:

  • (boolean)

Since:

  • 3.17.0



45
46
47
 
# File 'lib/language_server/protocol/interface/diagnostic_options.rb', line 45

def workspace_diagnostics
  attributes.fetch(:workspaceDiagnostics)
end