language_server-protocol 3.16.0.1 → 3.17.0.0

data/lib/language_server/protocol/interface/configuration_item.rb

@@ -14,7 +14,7 @@ module LanguageServer
         #
         # The scope to get the configuration section for.
         #
-        # @return [string]
+        # @return [string | nil]
         def scope_uri
           attributes.fetch(:scopeUri)
         end
@@ -22,7 +22,7 @@ module LanguageServer
         #
         # The configuration section asked for.
         #
-        # @return [string]
+        # @return [string | nil]
         def section
           attributes.fetch(:section)
         end

data/lib/language_server/protocol/interface/configuration_params.rb

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The parameters of a configuration request.
+      #
       class ConfigurationParams
         def initialize(items:)
           @attributes = {}

data/lib/language_server/protocol/interface/create_file.rb

@@ -2,7 +2,7 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # Create file operation
+      # Create file operation.
       #
       class CreateFile
         def initialize(kind:, uri:, options: nil, annotation_id: nil)
@@ -27,7 +27,7 @@ module LanguageServer
         #
         # The resource to create.
         #
-        # @return [string]
+        # @return [DocumentUri]
         def uri
           attributes.fetch(:uri)
         end
@@ -35,15 +35,17 @@ module LanguageServer
         #
         # Additional options
         #
-        # @return [CreateFileOptions]
+        # @return [CreateFileOptions | nil]
         def options
           attributes.fetch(:options)
         end
 
         #
-        # An optional annotation identifer describing the operation.
+        # An optional annotation identifier describing the operation.
         #
-        # @return [string]
+        # @since 3.16.0
+        #
+        # @return [ChangeAnnotationIdentifier | nil]
         def annotation_id
           attributes.fetch(:annotationId)
         end

data/lib/language_server/protocol/interface/create_file_options.rb

@@ -17,7 +17,7 @@ module LanguageServer
         #
         # Overwrite existing file. Overwrite wins over `ignoreIfExists`
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def overwrite
           attributes.fetch(:overwrite)
         end
@@ -25,7 +25,7 @@ module LanguageServer
         #
         # Ignore if exists.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def ignore_if_exists
           attributes.fetch(:ignoreIfExists)
         end

data/lib/language_server/protocol/interface/create_files_params.rb

@@ -2,8 +2,10 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # The parameters sent in notifications/requests for user-initiated creation
-      # of files.
+      # The parameters sent in notifications/requests for user-initiated creation of
+      # files.
+      #
+      # @since 3.16.0
       #
       class CreateFilesParams
         def initialize(files:)

data/lib/language_server/protocol/interface/declaration_client_capabilities.rb

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # @since 3.14.0
+      #
       class DeclarationClientCapabilities
         def initialize(dynamic_registration: nil, link_support: nil)
           @attributes = {}
@@ -12,11 +15,11 @@ module LanguageServer
         end
 
         #
-        # Whether declaration supports dynamic registration. If this is set to
-        # `true` the client supports the new `DeclarationRegistrationOptions`
-        # return value for the corresponding server capability as well.
+        # Whether declaration supports dynamic registration. If this is set to `true`
+        # the client supports the new `DeclarationRegistrationOptions` return value
+        # for the corresponding server capability as well.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end
@@ -24,7 +27,7 @@ module LanguageServer
         #
         # The client supports additional metadata in the form of declaration links.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def link_support
           attributes.fetch(:linkSupport)
         end

data/lib/language_server/protocol/interface/declaration_options.rb

@@ -10,7 +10,7 @@ module LanguageServer
           @attributes.freeze
         end
 
-        # @return [boolean]
+        # @return [boolean | nil]
         def work_done_progress
           attributes.fetch(:workDoneProgress)
         end

data/lib/language_server/protocol/interface/declaration_params.rb

@@ -32,16 +32,16 @@ module LanguageServer
         #
         # An optional token that a server can use to report work done progress.
         #
-        # @return [ProgressToken]
+        # @return [ProgressToken | nil]
         def work_done_token
           attributes.fetch(:workDoneToken)
         end
 
         #
-        # An optional token that a server can use to report partial results (e.g.
-        # streaming) to the client.
+        # An optional token that a server can use to report partial results (e.g. streaming) to
+        # the client.
         #
-        # @return [ProgressToken]
+        # @return [ProgressToken | nil]
         def partial_result_token
           attributes.fetch(:partialResultToken)
         end

data/lib/language_server/protocol/interface/declaration_registration_options.rb

@@ -12,16 +12,16 @@ module LanguageServer
           @attributes.freeze
         end
 
-        # @return [boolean]
+        # @return [boolean | nil]
         def work_done_progress
           attributes.fetch(:workDoneProgress)
         end
 
         #
-        # 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.
+        # 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]
+        # @return [DocumentSelector | null]
         def document_selector
           attributes.fetch(:documentSelector)
         end
@@ -30,7 +30,7 @@ module LanguageServer
         # The id used to register the request. The id can be used to deregister
         # the request again. See also Registration#id.
         #
-        # @return [string]
+        # @return [string | nil]
         def id
           attributes.fetch(:id)
         end

data/lib/language_server/protocol/interface/definition_client_capabilities.rb

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Client Capabilities for a [DefinitionRequest](#DefinitionRequest).
+      #
       class DefinitionClientCapabilities
         def initialize(dynamic_registration: nil, link_support: nil)
           @attributes = {}
@@ -14,7 +17,7 @@ module LanguageServer
         #
         # Whether definition supports dynamic registration.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end
@@ -22,7 +25,9 @@ module LanguageServer
         #
         # The client supports additional metadata in the form of definition links.
         #
-        # @return [boolean]
+        # @since 3.14.0
+        #
+        # @return [boolean | nil]
         def link_support
           attributes.fetch(:linkSupport)
         end

data/lib/language_server/protocol/interface/definition_options.rb

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Server Capabilities for a [DefinitionRequest](#DefinitionRequest).
+      #
       class DefinitionOptions
         def initialize(work_done_progress: nil)
           @attributes = {}
@@ -10,7 +13,7 @@ module LanguageServer
           @attributes.freeze
         end
 
-        # @return [boolean]
+        # @return [boolean | nil]
         def work_done_progress
           attributes.fetch(:workDoneProgress)
         end

data/lib/language_server/protocol/interface/definition_params.rb

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Parameters for a [DefinitionRequest](#DefinitionRequest).
+      #
       class DefinitionParams
         def initialize(text_document:, position:, work_done_token: nil, partial_result_token: nil)
           @attributes = {}
@@ -32,16 +35,16 @@ module LanguageServer
         #
         # An optional token that a server can use to report work done progress.
         #
-        # @return [ProgressToken]
+        # @return [ProgressToken | nil]
         def work_done_token
           attributes.fetch(:workDoneToken)
         end
 
         #
-        # An optional token that a server can use to report partial results (e.g.
-        # streaming) to the client.
+        # An optional token that a server can use to report partial results (e.g. streaming) to
+        # the client.
         #
-        # @return [ProgressToken]
+        # @return [ProgressToken | nil]
         def partial_result_token
           attributes.fetch(:partialResultToken)
         end

data/lib/language_server/protocol/interface/definition_registration_options.rb

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Registration options for a [DefinitionRequest](#DefinitionRequest).
+      #
       class DefinitionRegistrationOptions
         def initialize(document_selector:, work_done_progress: nil)
           @attributes = {}
@@ -12,15 +15,15 @@ module LanguageServer
         end
 
         #
-        # 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.
+        # 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]
+        # @return [DocumentSelector | null]
         def document_selector
           attributes.fetch(:documentSelector)
         end
 
-        # @return [boolean]
+        # @return [boolean | nil]
         def work_done_progress
           attributes.fetch(:workDoneProgress)
         end

data/lib/language_server/protocol/interface/delete_file.rb

@@ -27,7 +27,7 @@ module LanguageServer
         #
         # The file to delete.
         #
-        # @return [string]
+        # @return [DocumentUri]
         def uri
           attributes.fetch(:uri)
         end
@@ -35,15 +35,17 @@ module LanguageServer
         #
         # Delete options.
         #
-        # @return [DeleteFileOptions]
+        # @return [DeleteFileOptions | nil]
         def options
           attributes.fetch(:options)
         end
 
         #
-        # An optional annotation identifer describing the operation.
+        # An optional annotation identifier describing the operation.
         #
-        # @return [string]
+        # @since 3.16.0
+        #
+        # @return [ChangeAnnotationIdentifier | nil]
         def annotation_id
           attributes.fetch(:annotationId)
         end

data/lib/language_server/protocol/interface/delete_file_options.rb

@@ -17,7 +17,7 @@ module LanguageServer
         #
         # Delete the content recursively if a folder is denoted.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def recursive
           attributes.fetch(:recursive)
         end
@@ -25,7 +25,7 @@ module LanguageServer
         #
         # Ignore the operation if the file doesn't exist.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def ignore_if_not_exists
           attributes.fetch(:ignoreIfNotExists)
         end

data/lib/language_server/protocol/interface/delete_files_params.rb

@@ -2,8 +2,10 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # The parameters sent in notifications/requests for user-initiated deletes
-      # of files.
+      # The parameters sent in notifications/requests for user-initiated deletes of
+      # files.
+      #
+      # @since 3.16.0
       #
       class DeleteFilesParams
         def initialize(files:)

data/lib/language_server/protocol/interface/diagnostic.rb

@@ -1,6 +1,10 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Represents a diagnostic, such as a compiler error or warning. Diagnostic objects
+      # are only valid in the scope of a resource.
+      #
       class Diagnostic
         def initialize(range:, severity: nil, code: nil, code_description: nil, source: nil, message:, tags: nil, related_information: nil, data: nil)
           @attributes = {}
@@ -19,7 +23,7 @@ module LanguageServer
         end
 
         #
-        # The range at which the message applies.
+        # The range at which the message applies
         #
         # @return [Range]
         def range
@@ -30,38 +34,42 @@ module LanguageServer
         # The diagnostic's severity. Can be omitted. If omitted it is up to the
         # client to interpret diagnostics as error, warning, info or hint.
         #
-        # @return [DiagnosticSeverity]
+        # @return [DiagnosticSeverity | nil]
         def severity
           attributes.fetch(:severity)
         end
 
         #
-        # The diagnostic's code, which might appear in the user interface.
+        # The diagnostic's code, which usually appear in the user interface.
         #
-        # @return [string | number]
+        # @return [integer | string | nil]
         def code
           attributes.fetch(:code)
         end
 
         #
         # An optional property to describe the error code.
+        # Requires the code field (above) to be present/not null.
         #
-        # @return [CodeDescription]
+        # @since 3.16.0
+        #
+        # @return [CodeDescription | nil]
         def code_description
           attributes.fetch(:codeDescription)
         end
 
         #
         # A human-readable string describing the source of this
-        # diagnostic, e.g. 'typescript' or 'super lint'.
+        # diagnostic, e.g. 'typescript' or 'super lint'. It usually
+        # appears in the user interface.
         #
-        # @return [string]
+        # @return [string | nil]
         def source
           attributes.fetch(:source)
         end
 
         #
-        # The diagnostic's message.
+        # The diagnostic's message. It usually appears in the user interface
         #
         # @return [string]
         def message
@@ -71,7 +79,9 @@ module LanguageServer
         #
         # Additional metadata about the diagnostic.
         #
-        # @return [DiagnosticTag[]]
+        # @since 3.15.0
+        #
+        # @return [DiagnosticTag[] | nil]
         def tags
           attributes.fetch(:tags)
         end
@@ -80,17 +90,18 @@ module LanguageServer
         # An array of related diagnostic information, e.g. when symbol-names within
         # a scope collide all definitions can be marked via this property.
         #
-        # @return [DiagnosticRelatedInformation[]]
+        # @return [DiagnosticRelatedInformation[] | nil]
         def related_information
           attributes.fetch(:relatedInformation)
         end
 
         #
-        # A data entry field that is preserved between a
-        # `textDocument/publishDiagnostics` notification and
-        # `textDocument/codeAction` request.
+        # A data entry field that is preserved between a `textDocument/publishDiagnostics`
+        # notification and `textDocument/codeAction` request.
+        #
+        # @since 3.16.0
         #
-        # @return [unknown]
+        # @return [LSPAny | nil]
         def data
           attributes.fetch(:data)
         end

data/lib/language_server/protocol/interface/diagnostic_client_capabilities.rb

@@ -0,0 +1,49 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Client capabilities specific to diagnostic pull requests.
+      #
+      # @since 3.17.0
+      #
+      class DiagnosticClientCapabilities
+        def initialize(dynamic_registration: nil, related_document_support: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+          @attributes[:relatedDocumentSupport] = related_document_support if related_document_support
+
+          @attributes.freeze
+        end
+
+        #
+        # Whether implementation supports dynamic registration. If this is set to `true`
+        # the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
+        # return value for the corresponding server capability as well.
+        #
+        # @return [boolean | nil]
+        def dynamic_registration
+          attributes.fetch(:dynamicRegistration)
+        end
+
+        #
+        # Whether the clients supports related documents for document diagnostic pulls.
+        #
+        # @return [boolean | nil]
+        def related_document_support
+          attributes.fetch(:relatedDocumentSupport)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interface/diagnostic_options.rb

@@ -0,0 +1,66 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Diagnostic options.
+      #
+      # @since 3.17.0
+      #
+      class DiagnosticOptions
+        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
+
+        #
+        # An optional identifier under which the diagnostics are
+        # managed by the client.
+        #
+        # @return [string | nil]
+        def identifier
+          attributes.fetch(:identifier)
+        end
+
+        #
+        # 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]
+        def inter_file_dependencies
+          attributes.fetch(:interFileDependencies)
+        end
+
+        #
+        # The server provides support for workspace diagnostics as well.
+        #
+        # @return [boolean]
+        def workspace_diagnostics
+          attributes.fetch(:workspaceDiagnostics)
+        end
+
+        # @return [boolean | nil]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interface/diagnostic_registration_options.rb

@@ -0,0 +1,86 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Diagnostic registration options.
+      #
+      # @since 3.17.0
+      #
+      class DiagnosticRegistrationOptions
+        def initialize(document_selector:, identifier: nil, inter_file_dependencies:, workspace_diagnostics:, work_done_progress: nil, id: nil)
+          @attributes = {}
+
+          @attributes[:documentSelector] = document_selector
+          @attributes[:identifier] = identifier if identifier
+          @attributes[:interFileDependencies] = inter_file_dependencies
+          @attributes[:workspaceDiagnostics] = workspace_diagnostics
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:id] = id if id
+
+          @attributes.freeze
+        end
+
+        #
+        # 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 | null]
+        def document_selector
+          attributes.fetch(:documentSelector)
+        end
+
+        #
+        # An optional identifier under which the diagnostics are
+        # managed by the client.
+        #
+        # @return [string | nil]
+        def identifier
+          attributes.fetch(:identifier)
+        end
+
+        #
+        # 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]
+        def inter_file_dependencies
+          attributes.fetch(:interFileDependencies)
+        end
+
+        #
+        # The server provides support for workspace diagnostics as well.
+        #
+        # @return [boolean]
+        def workspace_diagnostics
+          attributes.fetch(:workspaceDiagnostics)
+        end
+
+        # @return [boolean | nil]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
+        #
+        # The id used to register the request. The id can be used to deregister
+        # the request again. See also Registration#id.
+        #
+        # @return [string | nil]
+        def id
+          attributes.fetch(:id)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end