Class: LanguageServer::Protocol::Interface::DiagnosticRegistrationOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/language_server/protocol/interface/diagnostic_registration_options.rb

Overview

Diagnostic registration options.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(document_selector:, work_done_progress: nil, identifier: nil, inter_file_dependencies:, workspace_diagnostics:, id: nil) ⇒ DiagnosticRegistrationOptions

Returns a new instance of DiagnosticRegistrationOptions.



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

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

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

  @attributes.freeze
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



72
73
74
 
# File 'lib/language_server/protocol/interface/diagnostic_registration_options.rb', line 72

def attributes
  @attributes
end

Instance Method Details

#document_selector ⇒ DocumentSelector

A document selector to identify the scope of the registration. If set to null the document selector provided on the client side will be used.

Returns:

  • (DocumentSelector) 


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

def document_selector
  attributes.fetch(:documentSelector)
end

#id ⇒ string

The id used to register the request. The id can be used to deregister the request again. See also Registration#id.

Returns:

  • (string) 


68
69
70
 
# File 'lib/language_server/protocol/interface/diagnostic_registration_options.rb', line 68

def id
  attributes.fetch(:id)
end

#identifier ⇒ string

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

Returns:

  • (string) 


40
41
42
 
# File 'lib/language_server/protocol/interface/diagnostic_registration_options.rb', line 40

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) 


51
52
53
 
# File 'lib/language_server/protocol/interface/diagnostic_registration_options.rb', line 51

def inter_file_dependencies
  attributes.fetch(:interFileDependencies)
end

#to_hash ⇒ Object 



74
75
76
 
# File 'lib/language_server/protocol/interface/diagnostic_registration_options.rb', line 74

def to_hash
  attributes
end

#to_json(*args) ⇒ Object 



78
79
80
 
# File 'lib/language_server/protocol/interface/diagnostic_registration_options.rb', line 78

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

#work_done_progress ⇒ boolean

Returns:

  • (boolean) 


31
32
33
 
# File 'lib/language_server/protocol/interface/diagnostic_registration_options.rb', line 31

def work_done_progress
  attributes.fetch(:workDoneProgress)
end

#workspace_diagnostics ⇒ boolean

The server provides support for workspace diagnostics as well.

Returns:

  • (boolean) 


59
60
61
 
# File 'lib/language_server/protocol/interface/diagnostic_registration_options.rb', line 59

def workspace_diagnostics
  attributes.fetch(:workspaceDiagnostics)
end