language_server-protocol 3.17.0.5 → 3.17.0.6

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

@@ -1,46 +1,41 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Registration options for a {@link CompletionRequest}.
+      #
       class CompletionRegistrationOptions
-        def initialize(document_selector:, work_done_progress: nil, trigger_characters: nil, all_commit_characters: nil, resolve_provider: nil, completion_item: nil)
+        def initialize(document_selector:, trigger_characters: nil, all_commit_characters: nil, resolve_provider: nil, completion_item: nil, work_done_progress: nil)
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
           @attributes[:triggerCharacters] = trigger_characters if trigger_characters
           @attributes[:allCommitCharacters] = all_commit_characters if all_commit_characters
           @attributes[:resolveProvider] = resolve_provider if resolve_provider
           @attributes[:completionItem] = completion_item if completion_item
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
 
           @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
-
         #
-        # The additional characters, beyond the defaults provided by the client (typically
-        # [a-zA-Z]), that should automatically trigger a completion request. For example
-        # `.` in JavaScript represents the beginning of an object property or method and is
-        # thus a good candidate for triggering a completion request.
+        # Most tools trigger completion request automatically without explicitly requesting
+        # it using a keyboard shortcut (e.g. Ctrl+Space). Typically they do so when the user
+        # starts to type an identifier. For example if the user types `c` in a JavaScript file
+        # code complete will automatically pop up present `console` besides others as a
+        # completion item. Characters that make up identifiers don't need to be listed here.
         #
-        # Most tools trigger a completion request automatically without explicitly
-        # requesting it using a keyboard shortcut (e.g. Ctrl+Space). Typically they
-        # do so when the user starts to type an identifier. For example if the user
-        # types `c` in a JavaScript file code complete will automatically pop up
-        # present `console` besides others as a completion item. Characters that
-        # make up identifiers don't need to be listed here.
+        # If code complete should automatically be trigger on characters not being valid inside
+        # an identifier (for example `.` in JavaScript) list them in `triggerCharacters`.
         #
         # @return [string[]]
         def trigger_characters
@@ -48,13 +43,14 @@ module LanguageServer
         end
 
         #
-        # The list of all possible characters that commit a completion. This field
-        # can be used if clients don't support individual commit characters per
-        # completion item. See client capability
-        # `completion.completionItem.commitCharactersSupport`.
+        # The list of all possible characters that commit a completion. This field can be used
+        # if clients don't support individual commit characters per completion item. See
+        # `ClientCapabilities.textDocument.completion.completionItem.commitCharactersSupport`
         #
-        # If a server provides both `allCommitCharacters` and commit characters on
-        # an individual completion item the ones on the completion item win.
+        # If a server provides both `allCommitCharacters` and commit characters on an individual
+        # completion item the ones on the completion item win.
+        #
+        # @since 3.2.0
         #
         # @return [string[]]
         def all_commit_characters
@@ -74,11 +70,18 @@ module LanguageServer
         # The server supports the following `CompletionItem` specific
         # capabilities.
         #
+        # @since 3.17.0
+        #
         # @return [{ labelDetailsSupport?: boolean; }]
         def completion_item
           attributes.fetch(:completionItem)
         end
 
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         attr_reader :attributes
 
         def to_hash

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
@@ -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/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,9 +15,9 @@ 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]
         def dynamic_registration

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

@@ -38,8 +38,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/declaration_registration_options.rb

@@ -18,10 +18,10 @@ 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 | nil]
         def document_selector
           attributes.fetch(:documentSelector)
         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 {@link DefinitionRequest}.
+      #
       class DefinitionClientCapabilities
         def initialize(dynamic_registration: nil, link_support: nil)
           @attributes = {}
@@ -22,6 +25,8 @@ module LanguageServer
         #
         # The client supports additional metadata in the form of definition links.
         #
+        # @since 3.14.0
+        #
         # @return [boolean]
         def link_support
           attributes.fetch(:linkSupport)

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Server Capabilities for a {@link DefinitionRequest}.
+      #
       class DefinitionOptions
         def initialize(work_done_progress: nil)
           @attributes = {}

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

@@ -1,6 +1,9 @@
 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 = {}
@@ -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,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Registration options for a {@link DefinitionRequest}.
+      #
       class DefinitionRegistrationOptions
         def initialize(document_selector:, work_done_progress: nil)
           @attributes = {}
@@ -12,10 +15,10 @@ 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 | nil]
         def document_selector
           attributes.fetch(:documentSelector)
         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
@@ -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_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
@@ -36,15 +40,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 +60,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,7 +69,7 @@ module LanguageServer
         end
 
         #
-        # The diagnostic's message.
+        # The diagnostic's message. It usually appears in the user interface
         #
         # @return [string]
         def message
@@ -71,6 +79,8 @@ module LanguageServer
         #
         # Additional metadata about the diagnostic.
         #
+        # @since 3.15.0
+        #
         # @return [DiagnosticTag[]]
         def tags
           attributes.fetch(:tags)
@@ -86,11 +96,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,6 +4,8 @@ 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 = {}
@@ -15,9 +17,8 @@ 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]
@@ -26,8 +27,7 @@ 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

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[: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.
@@ -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[: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]
+        # @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,6 +4,8 @@ module LanguageServer
       #
       # Workspace client capabilities specific to diagnostic pull requests.
       #
+      # @since 3.17.0
+      #
       class DiagnosticWorkspaceClientCapabilities
         def initialize(refresh_support: nil)
           @attributes = {}
@@ -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/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 if section
+
+          @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