language_server-protocol 3.17.0.0 → 3.17.0.1

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 | nil]
+        # @return [boolean]
         def overwrite
           attributes.fetch(:overwrite)
         end
@@ -25,7 +25,7 @@ module LanguageServer
         #
         # Ignore if exists.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def ignore_if_exists
           attributes.fetch(:ignoreIfExists)
         end

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

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

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

@@ -1,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # @since 3.14.0
-      #
       class DeclarationClientCapabilities
         def initialize(dynamic_registration: nil, link_support: nil)
           @attributes = {}
@@ -15,11 +12,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 | nil]
+        # @return [boolean]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end
@@ -27,7 +24,7 @@ module LanguageServer
         #
         # The client supports additional metadata in the form of declaration links.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         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 | nil]
+        # @return [boolean]
         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 | nil]
+        # @return [ProgressToken]
         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 | nil]
+        # @return [ProgressToken]
         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 | nil]
+        # @return [boolean]
         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 | null]
+        # @return [DocumentSelector]
         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 | nil]
+        # @return [string]
         def id
           attributes.fetch(:id)
         end

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

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

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

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

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

@@ -1,9 +1,6 @@
 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 = {}
@@ -35,16 +32,16 @@ module LanguageServer
         #
         # An optional token that a server can use to report work done progress.
         #
-        # @return [ProgressToken | nil]
+        # @return [ProgressToken]
         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 | nil]
+        # @return [ProgressToken]
         def partial_result_token
           attributes.fetch(:partialResultToken)
         end

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

@@ -1,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Registration options for a [DefinitionRequest](#DefinitionRequest).
-      #
       class DefinitionRegistrationOptions
         def initialize(document_selector:, work_done_progress: nil)
           @attributes = {}
@@ -15,15 +12,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 | null]
+        # @return [DocumentSelector]
         def document_selector
           attributes.fetch(:documentSelector)
         end
 
-        # @return [boolean | nil]
+        # @return [boolean]
         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 [DocumentUri]
+        # @return [string]
         def uri
           attributes.fetch(:uri)
         end
@@ -35,7 +35,7 @@ module LanguageServer
         #
         # Delete options.
         #
-        # @return [DeleteFileOptions | nil]
+        # @return [DeleteFileOptions]
         def options
           attributes.fetch(:options)
         end
@@ -43,9 +43,7 @@ module LanguageServer
         #
         # An optional annotation identifier describing the operation.
         #
-        # @since 3.16.0
-        #
-        # @return [ChangeAnnotationIdentifier | nil]
+        # @return [string]
         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 | nil]
+        # @return [boolean]
         def recursive
           attributes.fetch(:recursive)
         end
@@ -25,7 +25,7 @@ module LanguageServer
         #
         # Ignore the operation if the file doesn't exist.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def ignore_if_not_exists
           attributes.fetch(:ignoreIfNotExists)
         end

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

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

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

@@ -1,10 +1,6 @@
 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 = {}
@@ -23,7 +19,7 @@ module LanguageServer
         end
 
         #
-        # The range at which the message applies
+        # The range at which the message applies.
         #
         # @return [Range]
         def range
@@ -34,42 +30,38 @@ 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 | nil]
+        # @return [DiagnosticSeverity]
         def severity
           attributes.fetch(:severity)
         end
 
         #
-        # The diagnostic's code, which usually appear in the user interface.
+        # The diagnostic's code, which might appear in the user interface.
         #
-        # @return [integer | string | nil]
+        # @return [string | number]
         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 | nil]
+        # @return [CodeDescription]
         def code_description
           attributes.fetch(:codeDescription)
         end
 
         #
         # A human-readable string describing the source of this
-        # diagnostic, e.g. 'typescript' or 'super lint'. It usually
-        # appears in the user interface.
+        # diagnostic, e.g. 'typescript' or 'super lint'.
         #
-        # @return [string | nil]
+        # @return [string]
         def source
           attributes.fetch(:source)
         end
 
         #
-        # The diagnostic's message. It usually appears in the user interface
+        # The diagnostic's message.
         #
         # @return [string]
         def message
@@ -79,9 +71,7 @@ module LanguageServer
         #
         # Additional metadata about the diagnostic.
         #
-        # @since 3.15.0
-        #
-        # @return [DiagnosticTag[] | nil]
+        # @return [DiagnosticTag[]]
         def tags
           attributes.fetch(:tags)
         end
@@ -90,18 +80,17 @@ 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[] | nil]
+        # @return [DiagnosticRelatedInformation[]]
         def related_information
           attributes.fetch(:relatedInformation)
         end
 
         #
-        # A data entry field that is preserved between a `textDocument/publishDiagnostics`
-        # notification and `textDocument/codeAction` request.
-        #
-        # @since 3.16.0
+        # A data entry field that is preserved between a
+        # `textDocument/publishDiagnostics` notification and
+        # `textDocument/codeAction` request.
         #
-        # @return [LSPAny | nil]
+        # @return [unknown]
         def data
           attributes.fetch(:data)
         end

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

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # Client capabilities specific to diagnostic pull requests.
       #
-      # @since 3.17.0
-      #
       class DiagnosticClientCapabilities
         def initialize(dynamic_registration: nil, related_document_support: nil)
           @attributes = {}
@@ -17,19 +15,21 @@ module LanguageServer
         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 | nil]
+        # @return [boolean]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end
 
         #
-        # Whether the clients supports related documents for document diagnostic pulls.
+        # Whether the clients supports related documents for document diagnostic
+        # pulls.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def related_document_support
           attributes.fetch(:relatedDocumentSupport)
         end

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

@@ -4,25 +4,28 @@ module LanguageServer
       #
       # Diagnostic options.
       #
-      # @since 3.17.0
-      #
       class DiagnosticOptions
-        def initialize(identifier: nil, inter_file_dependencies:, workspace_diagnostics:, work_done_progress: nil)
+        def initialize(work_done_progress: nil, identifier: nil, inter_file_dependencies:, workspace_diagnostics:)
           @attributes = {}
 
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
           @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
 
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         #
         # An optional identifier under which the diagnostics are
         # managed by the client.
         #
-        # @return [string | nil]
+        # @return [string]
         def identifier
           attributes.fetch(:identifier)
         end
@@ -46,11 +49,6 @@ module LanguageServer
           attributes.fetch(:workspaceDiagnostics)
         end
 
-        # @return [boolean | nil]
-        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,36 +4,39 @@ module LanguageServer
       #
       # 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)
+        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[: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.
+        # 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]
+        # @return [DocumentSelector]
         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.
         #
-        # @return [string | nil]
+        # @return [string]
         def identifier
           attributes.fetch(:identifier)
         end
@@ -57,16 +60,11 @@ module LanguageServer
           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]
+        # @return [string]
         def id
           attributes.fetch(:id)
         end

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 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 are 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,8 +4,6 @@ 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,8 +4,6 @@ module LanguageServer
       #
       # Workspace client capabilities specific to diagnostic pull requests.
       #
-      # @since 3.17.0
-      #
       class DiagnosticWorkspaceClientCapabilities
         def initialize(refresh_support: nil)
           @attributes = {}
@@ -20,11 +18,11 @@ 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 | nil]
+        # @return [boolean]
         def refresh_support
           attributes.fetch(:refreshSupport)
         end

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

@@ -13,7 +13,7 @@ module LanguageServer
         #
         # Did change configuration notification supports dynamic registration.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end

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

@@ -1,9 +1,6 @@
 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_notebook_document_params.rb

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # The params sent in a change notebook document notification.
       #
-      # @since 3.17.0
-      #
       class DidChangeNotebookDocumentParams
         def initialize(notebook_document:, change:)
           @attributes = {}
@@ -18,9 +16,7 @@ module LanguageServer
 
         #
         # The notebook document that did change. The version number points
-        # 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.
+        # to the version after all provided changes have been applied.
         #
         # @return [VersionedNotebookDocumentIdentifier]
         def notebook_document
@@ -30,17 +26,15 @@ module LanguageServer
         #
         # The actual changes to the notebook document.
         #
-        # 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'.
+        # 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'.
         #
-        # 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 `NotebookChangeEvent`s in a single notification in the order
-        #   you receive them.
+        # - apply the 'notebookDocument/didChange' notifications in the order
+        # you receive them.
         #
         # @return [NotebookDocumentChangeEvent]
         def change