language_server-protocol 3.17.0.5 → 3.18.0.0.pre.1

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

@@ -1,14 +1,17 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Parameters for a {@link DefinitionRequest}.
+      #
       class DefinitionParams
         def initialize(text_document:, position:, work_done_token: nil, partial_result_token: nil)
           @attributes = {}
 
           @attributes[:textDocument] = text_document
           @attributes[:position] = position
-          @attributes[:workDoneToken] = work_done_token if work_done_token
-          @attributes[:partialResultToken] = partial_result_token if partial_result_token
+          @attributes[:workDoneToken] = work_done_token unless work_done_token.nil?
+          @attributes[:partialResultToken] = partial_result_token unless partial_result_token.nil?
 
           @attributes.freeze
         end
@@ -38,8 +41,8 @@ module LanguageServer
         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]
         def partial_result_token

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

@@ -1,21 +1,24 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Registration options for a {@link DefinitionRequest}.
+      #
       class DefinitionRegistrationOptions
         def initialize(document_selector:, work_done_progress: nil)
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @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.
+        # 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 | nil]
         def document_selector
           attributes.fetch(:documentSelector)
         end

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

@@ -10,8 +10,8 @@ module LanguageServer
 
           @attributes[:kind] = kind
           @attributes[:uri] = uri
-          @attributes[:options] = options if options
-          @attributes[:annotationId] = annotation_id if annotation_id
+          @attributes[:options] = options unless options.nil?
+          @attributes[:annotationId] = annotation_id unless annotation_id.nil?
 
           @attributes.freeze
         end
@@ -27,7 +27,7 @@ module LanguageServer
         #
         # The file to delete.
         #
-        # @return [string]
+        # @return [DocumentUri]
         def uri
           attributes.fetch(:uri)
         end
@@ -43,7 +43,9 @@ module LanguageServer
         #
         # An optional annotation identifier describing the operation.
         #
-        # @return [string]
+        # @since 3.16.0
+        #
+        # @return [ChangeAnnotationIdentifier]
         def annotation_id
           attributes.fetch(:annotationId)
         end

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

@@ -8,8 +8,8 @@ module LanguageServer
         def initialize(recursive: nil, ignore_if_not_exists: nil)
           @attributes = {}
 
-          @attributes[:recursive] = recursive if recursive
-          @attributes[:ignoreIfNotExists] = ignore_if_not_exists if ignore_if_not_exists
+          @attributes[:recursive] = recursive unless recursive.nil?
+          @attributes[:ignoreIfNotExists] = ignore_if_not_exists unless ignore_if_not_exists.nil?
 
           @attributes.freeze
         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,25 +1,29 @@
 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 = {}
 
           @attributes[:range] = range
-          @attributes[:severity] = severity if severity
-          @attributes[:code] = code if code
-          @attributes[:codeDescription] = code_description if code_description
-          @attributes[:source] = source if source
+          @attributes[:severity] = severity unless severity.nil?
+          @attributes[:code] = code unless code.nil?
+          @attributes[:codeDescription] = code_description unless code_description.nil?
+          @attributes[:source] = source unless source.nil?
           @attributes[:message] = message
-          @attributes[:tags] = tags if tags
-          @attributes[:relatedInformation] = related_information if related_information
-          @attributes[:data] = data if data
+          @attributes[:tags] = tags unless tags.nil?
+          @attributes[:relatedInformation] = related_information unless related_information.nil?
+          @attributes[:data] = data unless data.nil?
 
           @attributes.freeze
         end
 
         #
-        # The range at which the message applies.
+        # The range at which the message applies
         #
         # @return [Range]
         def range
@@ -27,8 +31,9 @@ module LanguageServer
         end
 
         #
-        # The diagnostic's severity. Can be omitted. If omitted it is up to the
-        # client to interpret diagnostics as error, warning, info or hint.
+        # The diagnostic's severity. To avoid interpretation mismatches when a
+        # server is used with different clients it is highly recommended that servers
+        # always provide a severity value.
         #
         # @return [DiagnosticSeverity]
         def severity
@@ -36,15 +41,18 @@ module LanguageServer
         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]
         def code
           attributes.fetch(:code)
         end
 
         #
         # An optional property to describe the error code.
+        # Requires the code field (above) to be present/not null.
+        #
+        # @since 3.16.0
         #
         # @return [CodeDescription]
         def code_description
@@ -53,7 +61,8 @@ module LanguageServer
 
         #
         # 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]
         def source
@@ -61,9 +70,12 @@ module LanguageServer
         end
 
         #
-        # The diagnostic's message.
+        # The diagnostic's message. It usually appears in the user interface.
         #
-        # @return [string]
+        # @since 3.18.0 - support for MarkupContent. This is guarded by the client
+        # capability `textDocument.diagnostic.markupMessageSupport`.
+        #
+        # @return [string | MarkupContent]
         def message
           attributes.fetch(:message)
         end
@@ -71,6 +83,8 @@ module LanguageServer
         #
         # Additional metadata about the diagnostic.
         #
+        # @since 3.15.0
+        #
         # @return [DiagnosticTag[]]
         def tags
           attributes.fetch(:tags)
@@ -86,11 +100,12 @@ module LanguageServer
         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]
         def data
           attributes.fetch(:data)
         end

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

@@ -4,20 +4,26 @@ module LanguageServer
       #
       # Client capabilities specific to diagnostic pull requests.
       #
+      # @since 3.17.0
+      #
       class DiagnosticClientCapabilities
-        def initialize(dynamic_registration: nil, related_document_support: nil)
+        def initialize(dynamic_registration: nil, related_document_support: nil, markup_message_support: nil, related_information: nil, tag_support: nil, code_description_support: nil, data_support: nil)
           @attributes = {}
 
-          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
-          @attributes[:relatedDocumentSupport] = related_document_support if related_document_support
+          @attributes[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
+          @attributes[:relatedDocumentSupport] = related_document_support unless related_document_support.nil?
+          @attributes[:markupMessageSupport] = markup_message_support unless markup_message_support.nil?
+          @attributes[:relatedInformation] = related_information unless related_information.nil?
+          @attributes[:tagSupport] = tag_support unless tag_support.nil?
+          @attributes[:codeDescriptionSupport] = code_description_support unless code_description_support.nil?
+          @attributes[:dataSupport] = data_support unless data_support.nil?
 
           @attributes.freeze
         end
 
         #
-        # Whether implementation supports dynamic registration. If this is set to
-        # `true` the client supports the new
-        # `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
+        # 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]
@@ -26,14 +32,64 @@ module LanguageServer
         end
 
         #
-        # Whether the clients supports related documents for document diagnostic
-        # pulls.
+        # Whether the clients supports related documents for document diagnostic pulls.
         #
         # @return [boolean]
         def related_document_support
           attributes.fetch(:relatedDocumentSupport)
         end
 
+        #
+        # Whether the client supports `MarkupContent` in diagnostic messages.
+        #
+        # @since 3.18.0
+        #
+        # @return [boolean]
+        def markup_message_support
+          attributes.fetch(:markupMessageSupport)
+        end
+
+        #
+        # Whether the clients accepts diagnostics with related information.
+        #
+        # @return [boolean]
+        def related_information
+          attributes.fetch(:relatedInformation)
+        end
+
+        #
+        # Client supports the tag property to provide meta data about a diagnostic.
+        # Clients supporting tags have to handle unknown tags gracefully.
+        #
+        # @since 3.15.0
+        #
+        # @return [ClientDiagnosticsTagOptions]
+        def tag_support
+          attributes.fetch(:tagSupport)
+        end
+
+        #
+        # Client supports a codeDescription property
+        #
+        # @since 3.16.0
+        #
+        # @return [boolean]
+        def code_description_support
+          attributes.fetch(:codeDescriptionSupport)
+        end
+
+        #
+        # Whether code action supports the `data` property which is
+        # preserved between a `textDocument/publishDiagnostics` and
+        # `textDocument/codeAction` request.
+        #
+        # @since 3.16.0
+        #
+        # @return [boolean]
+        def data_support
+          attributes.fetch(:dataSupport)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -4,23 +4,20 @@ module LanguageServer
       #
       # Diagnostic options.
       #
+      # @since 3.17.0
+      #
       class DiagnosticOptions
-        def initialize(work_done_progress: nil, identifier: nil, inter_file_dependencies:, workspace_diagnostics:)
+        def initialize(identifier: nil, inter_file_dependencies:, workspace_diagnostics:, work_done_progress: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
-          @attributes[:identifier] = identifier if identifier
+          @attributes[:identifier] = identifier unless identifier.nil?
           @attributes[:interFileDependencies] = inter_file_dependencies
           @attributes[:workspaceDiagnostics] = workspace_diagnostics
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @attributes.freeze
         end
 
-        # @return [boolean]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         #
         # An optional identifier under which the diagnostics are
         # managed by the client.
@@ -49,6 +46,11 @@ module LanguageServer
           attributes.fetch(:workspaceDiagnostics)
         end
 
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -4,34 +4,31 @@ module LanguageServer
       #
       # Diagnostic registration options.
       #
+      # @since 3.17.0
+      #
       class DiagnosticRegistrationOptions
-        def initialize(document_selector:, work_done_progress: nil, identifier: nil, inter_file_dependencies:, workspace_diagnostics:, id: nil)
+        def initialize(document_selector:, identifier: nil, inter_file_dependencies:, workspace_diagnostics:, work_done_progress: nil, id: nil)
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
-          @attributes[:identifier] = identifier if identifier
+          @attributes[:identifier] = identifier unless identifier.nil?
           @attributes[:interFileDependencies] = inter_file_dependencies
           @attributes[:workspaceDiagnostics] = workspace_diagnostics
-          @attributes[:id] = id if id
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
+          @attributes[:id] = id unless id.nil?
 
           @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.
+        # 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 | nil]
         def document_selector
           attributes.fetch(:documentSelector)
         end
 
-        # @return [boolean]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         #
         # An optional identifier under which the diagnostics are
         # managed by the client.
@@ -60,6 +57,11 @@ module LanguageServer
           attributes.fetch(:workspaceDiagnostics)
         end
 
+        # @return [boolean]
+        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.

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

@@ -2,9 +2,9 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # Represents a related message and source code location for a diagnostic.
-      # This should be used to point to code locations that cause or are related to
-      # a diagnostics, e.g when duplicating a symbol in a scope.
+      # Represents a related message and source code location for a diagnostic. This should be
+      # used to point to code locations that cause or related to a diagnostics, e.g when duplicating
+      # a symbol in a scope.
       #
       class DiagnosticRelatedInformation
         def initialize(location:, message:)

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

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # Cancellation data returned from a diagnostic request.
       #
+      # @since 3.17.0
+      #
       class DiagnosticServerCancellationData
         def initialize(retrigger_request:)
           @attributes = {}

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

@@ -4,11 +4,13 @@ module LanguageServer
       #
       # Workspace client capabilities specific to diagnostic pull requests.
       #
+      # @since 3.17.0
+      #
       class DiagnosticWorkspaceClientCapabilities
         def initialize(refresh_support: nil)
           @attributes = {}
 
-          @attributes[:refreshSupport] = refresh_support if refresh_support
+          @attributes[:refreshSupport] = refresh_support unless refresh_support.nil?
 
           @attributes.freeze
         end
@@ -18,9 +20,9 @@ module LanguageServer
         # the server to the client.
         #
         # Note that this event is global and will force the client to refresh all
-        # pulled diagnostics currently shown. It should be used with absolute care
-        # and is useful for situation where a server for example detects a project
-        # wide change that requires such a calculation.
+        # pulled diagnostics currently shown. It should be used with absolute care and
+        # is useful for situation where a server for example detects a project wide
+        # change that requires such a calculation.
         #
         # @return [boolean]
         def refresh_support

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

@@ -0,0 +1,72 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # General diagnostics capabilities for pull and push model.
+      #
+      class DiagnosticsCapabilities
+        def initialize(related_information: nil, tag_support: nil, code_description_support: nil, data_support: nil)
+          @attributes = {}
+
+          @attributes[:relatedInformation] = related_information unless related_information.nil?
+          @attributes[:tagSupport] = tag_support unless tag_support.nil?
+          @attributes[:codeDescriptionSupport] = code_description_support unless code_description_support.nil?
+          @attributes[:dataSupport] = data_support unless data_support.nil?
+
+          @attributes.freeze
+        end
+
+        #
+        # Whether the clients accepts diagnostics with related information.
+        #
+        # @return [boolean]
+        def related_information
+          attributes.fetch(:relatedInformation)
+        end
+
+        #
+        # Client supports the tag property to provide meta data about a diagnostic.
+        # Clients supporting tags have to handle unknown tags gracefully.
+        #
+        # @since 3.15.0
+        #
+        # @return [ClientDiagnosticsTagOptions]
+        def tag_support
+          attributes.fetch(:tagSupport)
+        end
+
+        #
+        # Client supports a codeDescription property
+        #
+        # @since 3.16.0
+        #
+        # @return [boolean]
+        def code_description_support
+          attributes.fetch(:codeDescriptionSupport)
+        end
+
+        #
+        # Whether code action supports the `data` property which is
+        # preserved between a `textDocument/publishDiagnostics` and
+        # `textDocument/codeAction` request.
+        #
+        # @since 3.16.0
+        #
+        # @return [boolean]
+        def data_support
+          attributes.fetch(:dataSupport)
+        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/did_change_configuration_client_capabilities.rb

@@ -5,7 +5,7 @@ module LanguageServer
         def initialize(dynamic_registration: nil)
           @attributes = {}
 
-          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+          @attributes[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
 
           @attributes.freeze
         end

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

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

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

@@ -0,0 +1,30 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class DidChangeConfigurationRegistrationOptions
+        def initialize(section: nil)
+          @attributes = {}
+
+          @attributes[:section] = section unless section.nil?
+
+          @attributes.freeze
+        end
+
+        # @return [string | string[]]
+        def section
+          attributes.fetch(:section)
+        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/did_change_notebook_document_params.rb

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # The params sent in a change notebook document notification.
       #
+      # @since 3.17.0
+      #
       class DidChangeNotebookDocumentParams
         def initialize(notebook_document:, change:)
           @attributes = {}
@@ -16,7 +18,9 @@ module LanguageServer
 
         #
         # The notebook document that did change. The version number points
-        # to the version after all provided changes have been applied.
+        # to the version after all provided changes have been applied. If
+        # only the text document content of a cell changes the notebook version
+        # doesn't necessarily have to change.
         #
         # @return [VersionedNotebookDocumentIdentifier]
         def notebook_document
@@ -26,15 +30,17 @@ module LanguageServer
         #
         # The actual changes to the notebook document.
         #
-        # The change describes single state change to the notebook document.
-        # So it moves a notebook document, its cells and its cell text document
-        # contents from state S to S'.
+        # The changes describe single state changes to the notebook document.
+        # So if there are two changes c1 (at array index 0) and c2 (at array
+        # index 1) for a notebook in state S then c1 moves the notebook from
+        # S to S' and c2 from S' to S''. So c1 is computed on the state S and
+        # c2 is computed on the state S'.
         #
-        # To mirror the content of a notebook using change events use the
-        # following approach:
+        # To mirror the content of a notebook using change events use the following approach:
         # - start with the same initial content
-        # - apply the 'notebookDocument/didChange' notifications in the order
-        # you receive them.
+        # - apply the 'notebookDocument/didChange' notifications in the order you receive them.
+        # - apply the `NotebookChangeEvent`s in a single notification in the order
+        #   you receive them.
         #
         # @return [NotebookDocumentChangeEvent]
         def change