language_server-protocol 3.16.0.1 → 3.17.0.0

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

@@ -1,34 +1,32 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # @since 3.16.0
+      #
       class SemanticTokensRegistrationOptions
-        def initialize(document_selector:, work_done_progress: nil, legend:, range: nil, full: nil, id: nil)
+        def initialize(document_selector:, legend:, range: nil, full: nil, work_done_progress: nil, id: nil)
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
           @attributes[:legend] = legend
           @attributes[:range] = range if range
           @attributes[:full] = full if full
+          @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 | null]
         def document_selector
           attributes.fetch(:documentSelector)
         end
 
-        # @return [boolean]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         #
         # The legend used by the server
         #
@@ -41,7 +39,7 @@ module LanguageServer
         # Server supports providing semantic tokens for a specific range
         # of a document.
         #
-        # @return [boolean | {}]
+        # @return [boolean | {  } | nil]
         def range
           attributes.fetch(:range)
         end
@@ -49,16 +47,21 @@ module LanguageServer
         #
         # Server supports providing semantic tokens for a full document.
         #
-        # @return [boolean | { delta?: boolean; }]
+        # @return [boolean | { delta:boolean } | nil]
         def full
           attributes.fetch(:full)
         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]
+        # @return [string | nil]
         def id
           attributes.fetch(:id)
         end

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # @since 3.16.0
+      #
       class SemanticTokensWorkspaceClientCapabilities
         def initialize(refresh_support: nil)
           @attributes = {}
@@ -16,10 +19,10 @@ module LanguageServer
         #
         # Note that this event is global and will force the client to refresh all
         # semantic tokens currently shown. It should be used with absolute care
-        # and is useful for situation where a server for example detect a project
+        # and is useful for situation where a server for example detects a project
         # wide change that requires such a calculation.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def refresh_support
           attributes.fetch(:refreshSupport)
         end

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

@@ -1,11 +1,17 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Defines the capabilities provided by a language
+      # server.
+      #
       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, workspace_symbol_provider: nil, document_formatting_provider: nil, document_range_formatting_provider: nil, document_on_type_formatting_provider: nil, rename_provider: nil, folding_range_provider: nil, selection_range_provider: nil, execute_command_provider: nil, call_hierarchy_provider: nil, linked_editing_range_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: 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
@@ -20,39 +26,68 @@ module LanguageServer
           @attributes[:codeLensProvider] = code_lens_provider if code_lens_provider
           @attributes[:documentLinkProvider] = document_link_provider if document_link_provider
           @attributes[:colorProvider] = color_provider if color_provider
+          @attributes[:workspaceSymbolProvider] = workspace_symbol_provider if workspace_symbol_provider
           @attributes[:documentFormattingProvider] = document_formatting_provider if document_formatting_provider
           @attributes[:documentRangeFormattingProvider] = document_range_formatting_provider if document_range_formatting_provider
           @attributes[:documentOnTypeFormattingProvider] = document_on_type_formatting_provider if document_on_type_formatting_provider
           @attributes[:renameProvider] = rename_provider if rename_provider
           @attributes[:foldingRangeProvider] = folding_range_provider if folding_range_provider
-          @attributes[:executeCommandProvider] = execute_command_provider if execute_command_provider
           @attributes[:selectionRangeProvider] = selection_range_provider if selection_range_provider
-          @attributes[:linkedEditingRangeProvider] = linked_editing_range_provider if linked_editing_range_provider
+          @attributes[:executeCommandProvider] = execute_command_provider if execute_command_provider
           @attributes[:callHierarchyProvider] = call_hierarchy_provider if call_hierarchy_provider
+          @attributes[:linkedEditingRangeProvider] = linked_editing_range_provider if linked_editing_range_provider
           @attributes[:semanticTokensProvider] = semantic_tokens_provider if semantic_tokens_provider
           @attributes[:monikerProvider] = moniker_provider if moniker_provider
-          @attributes[:workspaceSymbolProvider] = workspace_symbol_provider if workspace_symbol_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[:workspace] = workspace if workspace
           @attributes[:experimental] = experimental if experimental
 
           @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'.
+        #
+        # @since 3.17.0
+        #
+        # @return [PositionEncodingKind | nil]
+        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
-        # TextDocumentSyncKind number. If omitted it defaults to
-        # `TextDocumentSyncKind.None`.
+        # TextDocumentSyncKind number.
         #
-        # @return [TextDocumentSyncOptions | TextDocumentSyncKind]
+        # @return [TextDocumentSyncOptions | TextDocumentSyncKind | nil]
         def text_document_sync
           attributes.fetch(:textDocumentSync)
         end
 
+        #
+        # Defines how notebook documents are synced.
+        #
+        # @since 3.17.0
+        #
+        # @return [NotebookDocumentSyncOptions | NotebookDocumentSyncRegistrationOptions | nil]
+        def notebook_document_sync
+          attributes.fetch(:notebookDocumentSync)
+        end
+
         #
         # The server provides completion support.
         #
-        # @return [CompletionOptions]
+        # @return [CompletionOptions | nil]
         def completion_provider
           attributes.fetch(:completionProvider)
         end
@@ -60,7 +95,7 @@ module LanguageServer
         #
         # The server provides hover support.
         #
-        # @return [boolean | HoverOptions]
+        # @return [boolean | HoverOptions | nil]
         def hover_provider
           attributes.fetch(:hoverProvider)
         end
@@ -68,15 +103,15 @@ module LanguageServer
         #
         # The server provides signature help support.
         #
-        # @return [SignatureHelpOptions]
+        # @return [SignatureHelpOptions | nil]
         def signature_help_provider
           attributes.fetch(:signatureHelpProvider)
         end
 
         #
-        # The server provides go to declaration support.
+        # The server provides Goto Declaration support.
         #
-        # @return [boolean | DeclarationOptions | DeclarationRegistrationOptions]
+        # @return [boolean | DeclarationOptions | DeclarationRegistrationOptions | nil]
         def declaration_provider
           attributes.fetch(:declarationProvider)
         end
@@ -84,23 +119,23 @@ module LanguageServer
         #
         # The server provides goto definition support.
         #
-        # @return [boolean | DefinitionOptions]
+        # @return [boolean | DefinitionOptions | nil]
         def definition_provider
           attributes.fetch(:definitionProvider)
         end
 
         #
-        # The server provides goto type definition support.
+        # The server provides Goto Type Definition support.
         #
-        # @return [boolean | TypeDefinitionOptions | TypeDefinitionRegistrationOptions]
+        # @return [boolean | TypeDefinitionOptions | TypeDefinitionRegistrationOptions | nil]
         def type_definition_provider
           attributes.fetch(:typeDefinitionProvider)
         end
 
         #
-        # The server provides goto implementation support.
+        # The server provides Goto Implementation support.
         #
-        # @return [boolean | ImplementationOptions | ImplementationRegistrationOptions]
+        # @return [boolean | ImplementationOptions | ImplementationRegistrationOptions | nil]
         def implementation_provider
           attributes.fetch(:implementationProvider)
         end
@@ -108,7 +143,7 @@ module LanguageServer
         #
         # The server provides find references support.
         #
-        # @return [boolean | ReferenceOptions]
+        # @return [boolean | ReferenceOptions | nil]
         def references_provider
           attributes.fetch(:referencesProvider)
         end
@@ -116,7 +151,7 @@ module LanguageServer
         #
         # The server provides document highlight support.
         #
-        # @return [boolean | DocumentHighlightOptions]
+        # @return [boolean | DocumentHighlightOptions | nil]
         def document_highlight_provider
           attributes.fetch(:documentHighlightProvider)
         end
@@ -124,17 +159,17 @@ module LanguageServer
         #
         # The server provides document symbol support.
         #
-        # @return [boolean | DocumentSymbolOptions]
+        # @return [boolean | DocumentSymbolOptions | nil]
         def document_symbol_provider
           attributes.fetch(:documentSymbolProvider)
         end
 
         #
-        # The server provides code actions. The `CodeActionOptions` return type is
-        # only valid if the client signals code action literal support via the
-        # property `textDocument.codeAction.codeActionLiteralSupport`.
+        # The server provides code actions. CodeActionOptions may only be
+        # specified if the client states that it supports
+        # `codeActionLiteralSupport` in its initial `initialize` request.
         #
-        # @return [boolean | CodeActionOptions]
+        # @return [boolean | CodeActionOptions | nil]
         def code_action_provider
           attributes.fetch(:codeActionProvider)
         end
@@ -142,7 +177,7 @@ module LanguageServer
         #
         # The server provides code lens.
         #
-        # @return [CodeLensOptions]
+        # @return [CodeLensOptions | nil]
         def code_lens_provider
           attributes.fetch(:codeLensProvider)
         end
@@ -150,7 +185,7 @@ module LanguageServer
         #
         # The server provides document link support.
         #
-        # @return [DocumentLinkOptions]
+        # @return [DocumentLinkOptions | nil]
         def document_link_provider
           attributes.fetch(:documentLinkProvider)
         end
@@ -158,15 +193,23 @@ module LanguageServer
         #
         # The server provides color provider support.
         #
-        # @return [boolean | DocumentColorOptions | DocumentColorRegistrationOptions]
+        # @return [boolean | DocumentColorOptions | DocumentColorRegistrationOptions | nil]
         def color_provider
           attributes.fetch(:colorProvider)
         end
 
+        #
+        # The server provides workspace symbol support.
+        #
+        # @return [boolean | WorkspaceSymbolOptions | nil]
+        def workspace_symbol_provider
+          attributes.fetch(:workspaceSymbolProvider)
+        end
+
         #
         # The server provides document formatting.
         #
-        # @return [boolean | DocumentFormattingOptions]
+        # @return [boolean | DocumentFormattingOptions | nil]
         def document_formatting_provider
           attributes.fetch(:documentFormattingProvider)
         end
@@ -174,7 +217,7 @@ module LanguageServer
         #
         # The server provides document range formatting.
         #
-        # @return [boolean | DocumentRangeFormattingOptions]
+        # @return [boolean | DocumentRangeFormattingOptions | nil]
         def document_range_formatting_provider
           attributes.fetch(:documentRangeFormattingProvider)
         end
@@ -182,7 +225,7 @@ module LanguageServer
         #
         # The server provides document formatting on typing.
         #
-        # @return [DocumentOnTypeFormattingOptions]
+        # @return [DocumentOnTypeFormattingOptions | nil]
         def document_on_type_formatting_provider
           attributes.fetch(:documentOnTypeFormattingProvider)
         end
@@ -192,7 +235,7 @@ module LanguageServer
         # specified if the client states that it supports
         # `prepareSupport` in its initial `initialize` request.
         #
-        # @return [boolean | RenameOptions]
+        # @return [boolean | RenameOptions | nil]
         def rename_provider
           attributes.fetch(:renameProvider)
         end
@@ -200,71 +243,111 @@ module LanguageServer
         #
         # The server provides folding provider support.
         #
-        # @return [boolean | FoldingRangeOptions | FoldingRangeRegistrationOptions]
+        # @return [boolean | FoldingRangeOptions | FoldingRangeRegistrationOptions | nil]
         def folding_range_provider
           attributes.fetch(:foldingRangeProvider)
         end
 
-        #
-        # The server provides execute command support.
-        #
-        # @return [ExecuteCommandOptions]
-        def execute_command_provider
-          attributes.fetch(:executeCommandProvider)
-        end
-
         #
         # The server provides selection range support.
         #
-        # @return [boolean | SelectionRangeOptions | SelectionRangeRegistrationOptions]
+        # @return [boolean | SelectionRangeOptions | SelectionRangeRegistrationOptions | nil]
         def selection_range_provider
           attributes.fetch(:selectionRangeProvider)
         end
 
         #
-        # The server provides linked editing range support.
+        # The server provides execute command support.
         #
-        # @return [boolean | LinkedEditingRangeOptions | LinkedEditingRangeRegistrationOptions]
-        def linked_editing_range_provider
-          attributes.fetch(:linkedEditingRangeProvider)
+        # @return [ExecuteCommandOptions | nil]
+        def execute_command_provider
+          attributes.fetch(:executeCommandProvider)
         end
 
         #
         # The server provides call hierarchy support.
         #
-        # @return [boolean | CallHierarchyOptions | CallHierarchyRegistrationOptions]
+        # @since 3.16.0
+        #
+        # @return [boolean | CallHierarchyOptions | CallHierarchyRegistrationOptions | nil]
         def call_hierarchy_provider
           attributes.fetch(:callHierarchyProvider)
         end
 
+        #
+        # The server provides linked editing range support.
+        #
+        # @since 3.16.0
+        #
+        # @return [boolean | LinkedEditingRangeOptions | LinkedEditingRangeRegistrationOptions | nil]
+        def linked_editing_range_provider
+          attributes.fetch(:linkedEditingRangeProvider)
+        end
+
         #
         # The server provides semantic tokens support.
         #
-        # @return [SemanticTokensOptions | SemanticTokensRegistrationOptions]
+        # @since 3.16.0
+        #
+        # @return [SemanticTokensOptions | SemanticTokensRegistrationOptions | nil]
         def semantic_tokens_provider
           attributes.fetch(:semanticTokensProvider)
         end
 
         #
-        # Whether server provides moniker support.
+        # The server provides moniker support.
+        #
+        # @since 3.16.0
         #
-        # @return [boolean | MonikerOptions | MonikerRegistrationOptions]
+        # @return [boolean | MonikerOptions | MonikerRegistrationOptions | nil]
         def moniker_provider
           attributes.fetch(:monikerProvider)
         end
 
         #
-        # The server provides workspace symbol support.
+        # The server provides type hierarchy support.
         #
-        # @return [boolean | WorkspaceSymbolOptions]
-        def workspace_symbol_provider
-          attributes.fetch(:workspaceSymbolProvider)
+        # @since 3.17.0
+        #
+        # @return [boolean | TypeHierarchyOptions | TypeHierarchyRegistrationOptions | nil]
+        def type_hierarchy_provider
+          attributes.fetch(:typeHierarchyProvider)
+        end
+
+        #
+        # The server provides inline values.
+        #
+        # @since 3.17.0
+        #
+        # @return [boolean | InlineValueOptions | InlineValueRegistrationOptions | nil]
+        def inline_value_provider
+          attributes.fetch(:inlineValueProvider)
+        end
+
+        #
+        # The server provides inlay hints.
+        #
+        # @since 3.17.0
+        #
+        # @return [boolean | InlayHintOptions | InlayHintRegistrationOptions | nil]
+        def inlay_hint_provider
+          attributes.fetch(:inlayHintProvider)
+        end
+
+        #
+        # The server has support for pull model diagnostics.
+        #
+        # @since 3.17.0
+        #
+        # @return [DiagnosticOptions | DiagnosticRegistrationOptions | nil]
+        def diagnostic_provider
+          attributes.fetch(:diagnosticProvider)
         end
 
         #
-        # Workspace specific server capabilities
+        # Workspace specific server capabilities.
         #
-        # @return [{ workspaceFolders?: WorkspaceFoldersServerCapabilities; fileOperations?: { didCreate?: FileOperationRegistrationOptions; ... 4 more ...; willDelete?: FileOperationRegistrationOptions; }; }]
+        # @return [{ workspaceFolders:WorkspaceFoldersServerCapabilities, fileOperations:FileOperationOptions } | nil]
         def workspace
           attributes.fetch(:workspace)
         end
@@ -272,7 +355,7 @@ module LanguageServer
         #
         # Experimental server capabilities.
         #
-        # @return [any]
+        # @return [T | nil]
         def experimental
           attributes.fetch(:experimental)
         end

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

@@ -10,10 +10,7 @@ module LanguageServer
           @attributes.freeze
         end
 
-        #
-        # The new value that should be assigned to the trace setting.
-        #
-        # @return [TraceValue]
+        # @return [TraceValues]
         def value
           attributes.fetch(:value)
         end

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

@@ -2,7 +2,9 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # Client capabilities for the show document request.
+      # Client capabilities for the showDocument request.
+      #
+      # @since 3.16.0
       #
       class ShowDocumentClientCapabilities
         def initialize(support:)
@@ -14,7 +16,7 @@ module LanguageServer
         end
 
         #
-        # The client has support for the show document
+        # The client has support for the showDocument
         # request.
         #
         # @return [boolean]

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

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # Params to show a document.
       #
+      # @since 3.16.0
+      #
       class ShowDocumentParams
         def initialize(uri:, external: nil, take_focus: nil, selection: nil)
           @attributes = {}
@@ -19,7 +21,7 @@ module LanguageServer
         #
         # The document uri to show.
         #
-        # @return [string]
+        # @return [URI]
         def uri
           attributes.fetch(:uri)
         end
@@ -29,7 +31,7 @@ module LanguageServer
         # To show for example `https://code.visualstudio.com/`
         # in the default WEB browser set `external` to `true`.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def external
           attributes.fetch(:external)
         end
@@ -40,7 +42,7 @@ module LanguageServer
         # Clients might ignore this property if an external
         # program is started.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def take_focus
           attributes.fetch(:takeFocus)
         end
@@ -51,7 +53,7 @@ module LanguageServer
         # external program is started or the file is not a text
         # file.
         #
-        # @return [Range]
+        # @return [Range | nil]
         def selection
           attributes.fetch(:selection)
         end

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

@@ -2,7 +2,9 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # The result of an show document request.
+      # The result of a showDocument request.
+      #
+      # @since 3.16.0
       #
       class ShowDocumentResult
         def initialize(success:)

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The parameters of a notification message.
+      #
       class ShowMessageParams
         def initialize(type:, message:)
           @attributes = {}
@@ -12,7 +15,7 @@ module LanguageServer
         end
 
         #
-        # The message type. See {@link MessageType}.
+        # The message type. See {@link MessageType}
         #
         # @return [MessageType]
         def type

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

@@ -16,7 +16,7 @@ module LanguageServer
         #
         # Capabilities specific to the `MessageActionItem` type.
         #
-        # @return [{ additionalPropertiesSupport?: boolean; }]
+        # @return [{ additionalPropertiesSupport:boolean } | nil]
         def message_action_item
           attributes.fetch(:messageActionItem)
         end

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

@@ -21,7 +21,7 @@ module LanguageServer
         end
 
         #
-        # The actual message
+        # The actual message.
         #
         # @return [string]
         def message
@@ -31,7 +31,7 @@ module LanguageServer
         #
         # The message action items to present.
         #
-        # @return [MessageActionItem[]]
+        # @return [MessageActionItem[] | nil]
         def actions
           attributes.fetch(:actions)
         end

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

@@ -18,8 +18,7 @@ module LanguageServer
         end
 
         #
-        # One or more signatures. If no signatures are available the signature help
-        # request should return `null`.
+        # One or more signatures.
         #
         # @return [SignatureInformation[]]
         def signatures
@@ -37,7 +36,7 @@ module LanguageServer
         # In future version of the protocol this property might become
         # mandatory to better express this.
         #
-        # @return [number]
+        # @return [uinteger | nil]
         def active_signature
           attributes.fetch(:activeSignature)
         end
@@ -51,7 +50,7 @@ module LanguageServer
         # mandatory to better express the active parameter if the
         # active signature does have any.
         #
-        # @return [number]
+        # @return [uinteger | nil]
         def active_parameter
           attributes.fetch(:activeParameter)
         end