class LanguageServer::Protocol::Interface::DiagnosticRegistrationOptions

Diagnostic registration options.

Attributes

attributes[R]

Public Class Methods

new(document_selector:, work_done_progress: nil, identifier: nil, inter_file_dependencies:, workspace_diagnostics:, id: nil) click to toggle source

# 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

Public Instance Methods

document_selector() click to toggle source

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.

@return [DocumentSelector]

# File lib/language_server/protocol/interface/diagnostic_registration_options.rb, line 26
def document_selector
  attributes.fetch(:documentSelector)
end

id() click to toggle source

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

@return [string]

# File lib/language_server/protocol/interface/diagnostic_registration_options.rb, line 68
def id
  attributes.fetch(:id)
end

identifier() click to toggle source

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

@return [string]

# File lib/language_server/protocol/interface/diagnostic_registration_options.rb, line 40
def identifier
  attributes.fetch(:identifier)
end

inter_file_dependencies() click to toggle source

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.

@return [boolean]

# File lib/language_server/protocol/interface/diagnostic_registration_options.rb, line 51
def inter_file_dependencies
  attributes.fetch(:interFileDependencies)
end

to_hash() click to toggle source

# File lib/language_server/protocol/interface/diagnostic_registration_options.rb, line 74
def to_hash
  attributes
end

to_json(*args) click to toggle source

# 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() click to toggle source

@return [boolean]

# File lib/language_server/protocol/interface/diagnostic_registration_options.rb, line 31
def work_done_progress
  attributes.fetch(:workDoneProgress)
end

workspace_diagnostics() click to toggle source

The server provides support for workspace diagnostics as well.

@return [boolean]

# File lib/language_server/protocol/interface/diagnostic_registration_options.rb, line 59
def workspace_diagnostics
  attributes.fetch(:workspaceDiagnostics)
end