language_server-protocol 3.16.0.2 → 3.17.0.1

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

@@ -0,0 +1,48 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Notebook specific client capabilities.
+      #
+      class NotebookDocumentSyncClientCapabilities
+        def initialize(dynamic_registration: nil, execution_summary_support: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+          @attributes[:executionSummarySupport] = execution_summary_support if execution_summary_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]
+        def dynamic_registration
+          attributes.fetch(:dynamicRegistration)
+        end
+
+        #
+        # The client supports sending execution summary data per cell.
+        #
+        # @return [boolean]
+        def execution_summary_support
+          attributes.fetch(:executionSummarySupport)
+        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/notebook_document_sync_options.rb

@@ -0,0 +1,56 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Options specific to a notebook plus its cells
+      # to be synced to the server.
+      #
+      # If a selector provides a notebook document
+      # filter but no cell selector all cells of a
+      # matching notebook document will be synced.
+      #
+      # If a selector provides no notebook document
+      # filter but only a cell selector all notebook
+      # documents that contain at least one matching
+      # cell will be synced.
+      #
+      class NotebookDocumentSyncOptions
+        def initialize(notebook_selector:, save: nil)
+          @attributes = {}
+
+          @attributes[:notebookSelector] = notebook_selector
+          @attributes[:save] = save if save
+
+          @attributes.freeze
+        end
+
+        #
+        # The notebooks to be synced
+        #
+        # @return [({ notebook: string | NotebookDocumentFilter; cells?: { language: string; }[]; } | { notebook?: string | NotebookDocumentFilter; cells: { ...; }[]; })[]]
+        def notebook_selector
+          attributes.fetch(:notebookSelector)
+        end
+
+        #
+        # Whether save notification should be forwarded to
+        # the server. Will only be honored if mode === `notebook`.
+        #
+        # @return [boolean]
+        def save
+          attributes.fetch(:save)
+        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/notebook_document_sync_registration_options.rb

@@ -0,0 +1,56 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Registration options specific to a notebook.
+      #
+      class NotebookDocumentSyncRegistrationOptions
+        def initialize(notebook_selector:, save: nil, id: nil)
+          @attributes = {}
+
+          @attributes[:notebookSelector] = notebook_selector
+          @attributes[:save] = save if save
+          @attributes[:id] = id if id
+
+          @attributes.freeze
+        end
+
+        #
+        # The notebooks to be synced
+        #
+        # @return [({ notebook: string | NotebookDocumentFilter; cells?: { language: string; }[]; } | { notebook?: string | NotebookDocumentFilter; cells: { ...; }[]; })[]]
+        def notebook_selector
+          attributes.fetch(:notebookSelector)
+        end
+
+        #
+        # Whether save notification should be forwarded to
+        # the server. Will only be honored if mode === `notebook`.
+        #
+        # @return [boolean]
+        def save
+          attributes.fetch(:save)
+        end
+
+        #
+        # The id used to register the request. The id can be used to deregister
+        # the request again. See also Registration#id.
+        #
+        # @return [string]
+        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

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

@@ -20,9 +20,8 @@ module LanguageServer
         end
 
         #
-        # Character offset on a line in a document (zero-based). Assuming that
-        # the line is represented as a string, the `character` value represents
-        # the gap between the `character` and `character + 1`.
+        # Character offset on a line in a document (zero-based). The meaning of this
+        # offset is determined by the negotiated `PositionEncodingKind`.
         #
         # If the character value is greater than the line length it defaults back
         # to the line length.

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

@@ -2,11 +2,12 @@ module LanguageServer
   module Protocol
     module Interface
       class PrepareRenameParams
-        def initialize(text_document:, position:)
+        def initialize(text_document:, position:, work_done_token: nil)
           @attributes = {}
 
           @attributes[:textDocument] = text_document
           @attributes[:position] = position
+          @attributes[:workDoneToken] = work_done_token if work_done_token
 
           @attributes.freeze
         end
@@ -27,6 +28,14 @@ module LanguageServer
           attributes.fetch(:position)
         end
 
+        #
+        # An optional token that a server can use to report work done progress.
+        #
+        # @return [ProgressToken]
+        def work_done_token
+          attributes.fetch(:workDoneToken)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -0,0 +1,46 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A previous result id in a workspace pull request.
+      #
+      class PreviousResultId
+        def initialize(uri:, value:)
+          @attributes = {}
+
+          @attributes[:uri] = uri
+          @attributes[:value] = value
+
+          @attributes.freeze
+        end
+
+        #
+        # The URI for which the client knows a
+        # result id.
+        #
+        # @return [string]
+        def uri
+          attributes.fetch(:uri)
+        end
+
+        #
+        # The value of the previous result id.
+        #
+        # @return [string]
+        def value
+          attributes.fetch(:value)
+        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/registration.rb

@@ -35,7 +35,7 @@ module LanguageServer
         #
         # Options necessary for the registration.
         #
-        # @return [any]
+        # @return [LSPAny]
         def register_options
           attributes.fetch(:registerOptions)
         end

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

@@ -0,0 +1,69 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A full diagnostic report with a set of related documents.
+      #
+      class RelatedFullDocumentDiagnosticReport
+        def initialize(kind:, result_id: nil, items:, related_documents: nil)
+          @attributes = {}
+
+          @attributes[:kind] = kind
+          @attributes[:resultId] = result_id if result_id
+          @attributes[:items] = items
+          @attributes[:relatedDocuments] = related_documents if related_documents
+
+          @attributes.freeze
+        end
+
+        #
+        # A full document diagnostic report.
+        #
+        # @return [any]
+        def kind
+          attributes.fetch(:kind)
+        end
+
+        #
+        # An optional result id. If provided it will
+        # be sent on the next diagnostic request for the
+        # same document.
+        #
+        # @return [string]
+        def result_id
+          attributes.fetch(:resultId)
+        end
+
+        #
+        # The actual items.
+        #
+        # @return [Diagnostic[]]
+        def items
+          attributes.fetch(:items)
+        end
+
+        #
+        # Diagnostics of related documents. This information is useful
+        # in programming languages where code in a file A can generate
+        # diagnostics in a file B which A depends on. An example of
+        # such a language is C/C++ where marco definitions in a file
+        # a.cpp and result in errors in a header file b.hpp.
+        #
+        # @return [{ [uri: string]: FullDocumentDiagnosticReport | UnchangedDocumentDiagnosticReport; }]
+        def related_documents
+          attributes.fetch(:relatedDocuments)
+        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/related_unchanged_document_diagnostic_report.rb

@@ -0,0 +1,62 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # An unchanged diagnostic report with a set of related documents.
+      #
+      class RelatedUnchangedDocumentDiagnosticReport
+        def initialize(kind:, result_id:, related_documents: nil)
+          @attributes = {}
+
+          @attributes[:kind] = kind
+          @attributes[:resultId] = result_id
+          @attributes[:relatedDocuments] = related_documents if related_documents
+
+          @attributes.freeze
+        end
+
+        #
+        # A document diagnostic report indicating
+        # no changes to the last result. A server can
+        # only return `unchanged` if result ids are
+        # provided.
+        #
+        # @return [any]
+        def kind
+          attributes.fetch(:kind)
+        end
+
+        #
+        # A result id which will be sent on the next
+        # diagnostic request for the same document.
+        #
+        # @return [string]
+        def result_id
+          attributes.fetch(:resultId)
+        end
+
+        #
+        # Diagnostics of related documents. This information is useful
+        # in programming languages where code in a file A can generate
+        # diagnostics in a file B which A depends on. An example of
+        # such a language is C/C++ where marco definitions in a file
+        # a.cpp and result in errors in a header file b.hpp.
+        #
+        # @return [{ [uri: string]: FullDocumentDiagnosticReport | UnchangedDocumentDiagnosticReport; }]
+        def related_documents
+          attributes.fetch(:relatedDocuments)
+        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/relative_pattern.rb

@@ -0,0 +1,48 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A relative pattern is a helper to construct glob patterns that are matched
+      # relatively to a base URI. The common value for a `baseUri` is a workspace
+      # folder root, but it can be another absolute URI as well.
+      #
+      class RelativePattern
+        def initialize(base_uri:, pattern:)
+          @attributes = {}
+
+          @attributes[:baseUri] = base_uri
+          @attributes[:pattern] = pattern
+
+          @attributes.freeze
+        end
+
+        #
+        # A workspace folder or a base URI to which this pattern will be matched
+        # against relatively.
+        #
+        # @return [string | WorkspaceFolder]
+        def base_uri
+          attributes.fetch(:baseUri)
+        end
+
+        #
+        # The actual glob pattern;
+        #
+        # @return [string]
+        def pattern
+          attributes.fetch(:pattern)
+        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/rename_client_capabilities.rb

@@ -37,7 +37,7 @@ module LanguageServer
         # The value indicates the default behavior used by the
         # client.
         #
-        # @return [any]
+        # @return [1]
         def prepare_support_default_behavior
           attributes.fetch(:prepareSupportDefaultBehavior)
         end

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

@@ -50,7 +50,7 @@ module LanguageServer
         end
 
         #
-        # An optional annotation identifer describing the operation.
+        # An optional annotation identifier describing the operation.
         #
         # @return [string]
         def annotation_id

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

@@ -2,7 +2,7 @@ module LanguageServer
   module Protocol
     module Interface
       class SemanticTokensClientCapabilities
-        def initialize(dynamic_registration: nil, requests:, token_types:, token_modifiers:, formats:, overlapping_token_support: nil, multiline_token_support: nil)
+        def initialize(dynamic_registration: nil, requests:, token_types:, token_modifiers:, formats:, overlapping_token_support: nil, multiline_token_support: nil, server_cancel_support: nil, augments_syntax_tokens: nil)
           @attributes = {}
 
           @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
@@ -12,6 +12,8 @@ module LanguageServer
           @attributes[:formats] = formats
           @attributes[:overlappingTokenSupport] = overlapping_token_support if overlapping_token_support
           @attributes[:multilineTokenSupport] = multiline_token_support if multiline_token_support
+          @attributes[:serverCancelSupport] = server_cancel_support if server_cancel_support
+          @attributes[:augmentsSyntaxTokens] = augments_syntax_tokens if augments_syntax_tokens
 
           @attributes.freeze
         end
@@ -82,6 +84,32 @@ module LanguageServer
           attributes.fetch(:multilineTokenSupport)
         end
 
+        #
+        # Whether the client allows the server to actively cancel a
+        # semantic token request, e.g. supports returning
+        # ErrorCodes.ServerCancelled. If a server does the client
+        # needs to retrigger the request.
+        #
+        # @return [boolean]
+        def server_cancel_support
+          attributes.fetch(:serverCancelSupport)
+        end
+
+        #
+        # Whether the client uses semantic tokens to augment existing
+        # syntax tokens. If set to `true` client side created syntax
+        # tokens and semantic tokens are both used for colorization. If
+        # set to `false` the client only uses the returned semantic tokens
+        # for colorization.
+        #
+        # If the value is `undefined` then the client behavior is not
+        # specified.
+        #
+        # @return [boolean]
+        def augments_syntax_tokens
+          attributes.fetch(:augmentsSyntaxTokens)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -2,10 +2,12 @@ module LanguageServer
   module Protocol
     module Interface
       class ServerCapabilities
-        def initialize(text_document_sync: nil, completion_provider: nil, hover_provider: nil, signature_help_provider: nil, declaration_provider: nil, definition_provider: nil, type_definition_provider: nil, implementation_provider: nil, references_provider: nil, document_highlight_provider: nil, document_symbol_provider: nil, code_action_provider: nil, code_lens_provider: nil, document_link_provider: nil, color_provider: nil, document_formatting_provider: nil, document_range_formatting_provider: nil, document_on_type_formatting_provider: nil, rename_provider: nil, folding_range_provider: nil, execute_command_provider: nil, selection_range_provider: nil, linked_editing_range_provider: nil, call_hierarchy_provider: nil, semantic_tokens_provider: nil, moniker_provider: nil, workspace_symbol_provider: nil, workspace: nil, experimental: nil)
+        def initialize(position_encoding: nil, text_document_sync: nil, notebook_document_sync: nil, completion_provider: nil, hover_provider: nil, signature_help_provider: nil, declaration_provider: nil, definition_provider: nil, type_definition_provider: nil, implementation_provider: nil, references_provider: nil, document_highlight_provider: nil, document_symbol_provider: nil, code_action_provider: nil, code_lens_provider: nil, document_link_provider: nil, color_provider: nil, document_formatting_provider: nil, document_range_formatting_provider: nil, document_on_type_formatting_provider: nil, rename_provider: nil, folding_range_provider: nil, execute_command_provider: nil, selection_range_provider: nil, linked_editing_range_provider: nil, call_hierarchy_provider: nil, semantic_tokens_provider: nil, moniker_provider: nil, type_hierarchy_provider: nil, inline_value_provider: nil, inlay_hint_provider: nil, diagnostic_provider: nil, workspace_symbol_provider: nil, workspace: nil, experimental: nil)
           @attributes = {}
 
+          @attributes[:positionEncoding] = position_encoding if position_encoding
           @attributes[:textDocumentSync] = text_document_sync if text_document_sync
+          @attributes[:notebookDocumentSync] = notebook_document_sync if notebook_document_sync
           @attributes[:completionProvider] = completion_provider if completion_provider
           @attributes[:hoverProvider] = hover_provider if hover_provider
           @attributes[:signatureHelpProvider] = signature_help_provider if signature_help_provider
@@ -31,6 +33,10 @@ module LanguageServer
           @attributes[:callHierarchyProvider] = call_hierarchy_provider if call_hierarchy_provider
           @attributes[:semanticTokensProvider] = semantic_tokens_provider if semantic_tokens_provider
           @attributes[:monikerProvider] = moniker_provider if moniker_provider
+          @attributes[:typeHierarchyProvider] = type_hierarchy_provider if type_hierarchy_provider
+          @attributes[:inlineValueProvider] = inline_value_provider if inline_value_provider
+          @attributes[:inlayHintProvider] = inlay_hint_provider if inlay_hint_provider
+          @attributes[:diagnosticProvider] = diagnostic_provider if diagnostic_provider
           @attributes[:workspaceSymbolProvider] = workspace_symbol_provider if workspace_symbol_provider
           @attributes[:workspace] = workspace if workspace
           @attributes[:experimental] = experimental if experimental
@@ -38,6 +44,20 @@ module LanguageServer
           @attributes.freeze
         end
 
+        #
+        # The position encoding the server picked from the encodings offered
+        # by the client via the client capability `general.positionEncodings`.
+        #
+        # If the client didn't provide any position encodings the only valid
+        # value that a server can return is 'utf-16'.
+        #
+        # If omitted it defaults to 'utf-16'.
+        #
+        # @return [string]
+        def position_encoding
+          attributes.fetch(:positionEncoding)
+        end
+
         #
         # Defines how text documents are synced. Is either a detailed structure
         # defining each notification or for backwards compatibility the
@@ -49,6 +69,14 @@ module LanguageServer
           attributes.fetch(:textDocumentSync)
         end
 
+        #
+        # Defines how notebook documents are synced.
+        #
+        # @return [NotebookDocumentSyncOptions | NotebookDocumentSyncRegistrationOptions]
+        def notebook_document_sync
+          attributes.fetch(:notebookDocumentSync)
+        end
+
         #
         # The server provides completion support.
         #
@@ -253,6 +281,38 @@ module LanguageServer
           attributes.fetch(:monikerProvider)
         end
 
+        #
+        # The server provides type hierarchy support.
+        #
+        # @return [boolean | TypeHierarchyOptions | TypeHierarchyRegistrationOptions]
+        def type_hierarchy_provider
+          attributes.fetch(:typeHierarchyProvider)
+        end
+
+        #
+        # The server provides inline values.
+        #
+        # @return [boolean | InlineValueOptions | InlineValueRegistrationOptions]
+        def inline_value_provider
+          attributes.fetch(:inlineValueProvider)
+        end
+
+        #
+        # The server provides inlay hints.
+        #
+        # @return [boolean | InlayHintOptions | InlayHintRegistrationOptions]
+        def inlay_hint_provider
+          attributes.fetch(:inlayHintProvider)
+        end
+
+        #
+        # The server has support for pull model diagnostics.
+        #
+        # @return [DiagnosticOptions | DiagnosticRegistrationOptions]
+        def diagnostic_provider
+          attributes.fetch(:diagnosticProvider)
+        end
+
         #
         # The server provides workspace symbol support.
         #
@@ -272,7 +332,7 @@ module LanguageServer
         #
         # Experimental server capabilities.
         #
-        # @return [any]
+        # @return [LSPAny]
         def experimental
           attributes.fetch(:experimental)
         end

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

@@ -28,8 +28,8 @@ module LanguageServer
 
         #
         # The active signature. If omitted or the value lies outside the
-        # range of `signatures` the value defaults to zero or is ignored if
-        # the `SignatureHelp` has no signatures.
+        # range of `signatures` the value defaults to zero or is ignore if
+        # the `SignatureHelp` as no signatures.
         #
         # Whenever possible implementors should make an active decision about
         # the active signature and shouldn't rely on a default value.

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

@@ -30,7 +30,7 @@ module LanguageServer
         #
         # The kind of this symbol.
         #
-        # @return [any]
+        # @return [SymbolKind]
         def kind
           attributes.fetch(:kind)
         end