language_server-protocol 3.16.0.2 → 3.17.0.1

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

@@ -2,13 +2,15 @@ module LanguageServer
   module Protocol
     module Interface
       class CompletionClientCapabilities
-        def initialize(dynamic_registration: nil, completion_item: nil, completion_item_kind: nil, context_support: nil)
+        def initialize(dynamic_registration: nil, completion_item: nil, completion_item_kind: nil, context_support: nil, insert_text_mode: nil, completion_list: nil)
           @attributes = {}
 
           @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
           @attributes[:completionItem] = completion_item if completion_item
           @attributes[:completionItemKind] = completion_item_kind if completion_item_kind
           @attributes[:contextSupport] = context_support if context_support
+          @attributes[:insertTextMode] = insert_text_mode if insert_text_mode
+          @attributes[:completionList] = completion_list if completion_list
 
           @attributes.freeze
         end
@@ -25,12 +27,12 @@ module LanguageServer
         # The client supports the following `CompletionItem` specific
         # capabilities.
         #
-        # @return [{ snippetSupport?: boolean; commitCharactersSupport?: boolean; documentationFormat?: MarkupKind[]; deprecatedSupport?: boolean; preselectSupport?: boolean; tagSupport?: { valueSet: 1[]; }; insertReplaceSupport?: boolean; resolveSupport?: { ...; }; insertTextModeSupport?: { ...; }; }]
+        # @return [{ snippetSupport?: boolean; commitCharactersSupport?: boolean; documentationFormat?: MarkupKind[]; deprecatedSupport?: boolean; preselectSupport?: boolean; tagSupport?: { valueSet: 1[]; }; insertReplaceSupport?: boolean; resolveSupport?: { ...; }; insertTextModeSupport?: { ...; }; labelDetailsSupport?: boolean; }]
         def completion_item
           attributes.fetch(:completionItem)
         end
 
-        # @return [{ valueSet?: any[]; }]
+        # @return [{ valueSet?: CompletionItemKind[]; }]
         def completion_item_kind
           attributes.fetch(:completionItemKind)
         end
@@ -44,6 +46,24 @@ module LanguageServer
           attributes.fetch(:contextSupport)
         end
 
+        #
+        # The client's default when the completion item doesn't provide a
+        # `insertTextMode` property.
+        #
+        # @return [InsertTextMode]
+        def insert_text_mode
+          attributes.fetch(:insertTextMode)
+        end
+
+        #
+        # The client supports the following `CompletionList` specific
+        # capabilities.
+        #
+        # @return [{ itemDefaults?: string[]; }]
+        def completion_list
+          attributes.fetch(:completionList)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -2,10 +2,11 @@ module LanguageServer
   module Protocol
     module Interface
       class CompletionItem
-        def initialize(label:, kind: nil, tags: nil, detail: nil, documentation: nil, deprecated: nil, preselect: nil, sort_text: nil, filter_text: nil, insert_text: nil, insert_text_format: nil, insert_text_mode: nil, text_edit: nil, additional_text_edits: nil, commit_characters: nil, command: nil, data: nil)
+        def initialize(label:, label_details: nil, kind: nil, tags: nil, detail: nil, documentation: nil, deprecated: nil, preselect: nil, sort_text: nil, filter_text: nil, insert_text: nil, insert_text_format: nil, insert_text_mode: nil, text_edit: nil, text_edit_text: nil, additional_text_edits: nil, commit_characters: nil, command: nil, data: nil)
           @attributes = {}
 
           @attributes[:label] = label
+          @attributes[:labelDetails] = label_details if label_details
           @attributes[:kind] = kind if kind
           @attributes[:tags] = tags if tags
           @attributes[:detail] = detail if detail
@@ -18,6 +19,7 @@ module LanguageServer
           @attributes[:insertTextFormat] = insert_text_format if insert_text_format
           @attributes[:insertTextMode] = insert_text_mode if insert_text_mode
           @attributes[:textEdit] = text_edit if text_edit
+          @attributes[:textEditText] = text_edit_text if text_edit_text
           @attributes[:additionalTextEdits] = additional_text_edits if additional_text_edits
           @attributes[:commitCharacters] = commit_characters if commit_characters
           @attributes[:command] = command if command
@@ -27,21 +29,33 @@ module LanguageServer
         end
 
         #
-        # The label of this completion item. By default
-        # also the text that is inserted when selecting
-        # this completion.
+        # The label of this completion item.
+        #
+        # The label property is also by default the text that
+        # is inserted when selecting this completion.
+        #
+        # If label details are provided the label itself should
+        # be an unqualified name of the completion item.
         #
         # @return [string]
         def label
           attributes.fetch(:label)
         end
 
+        #
+        # Additional details for the label
+        #
+        # @return [CompletionItemLabelDetails]
+        def label_details
+          attributes.fetch(:labelDetails)
+        end
+
         #
         # The kind of this completion item. Based of the kind
         # an icon is chosen by the editor. The standardized set
         # of available values is defined in `CompletionItemKind`.
         #
-        # @return [any]
+        # @return [CompletionItemKind]
         def kind
           attributes.fetch(:kind)
         end
@@ -134,6 +148,9 @@ module LanguageServer
         # `insertText` property and the `newText` property of a provided
         # `textEdit`. If omitted defaults to `InsertTextFormat.PlainText`.
         #
+        # Please note that the insertTextFormat doesn't apply to
+        # `additionalTextEdits`.
+        #
         # @return [InsertTextFormat]
         def insert_text_format
           attributes.fetch(:insertTextFormat)
@@ -160,9 +177,9 @@ module LanguageServer
         # item. One is to insert a completion text and the other is to replace an
         # existing text with a completion text. Since this can usually not be
         # predetermined by a server it can report both ranges. Clients need to
-        # signal support for `InsertReplaceEdits` via the
-        # `textDocument.completion.insertReplaceSupport` client capability
-        # property.
+        # signal support for `InsertReplaceEdit`s via the
+        # `textDocument.completion.completionItem.insertReplaceSupport` client
+        # capability property.
         #
         # *Note 1:* The text edit's range as well as both ranges from an insert
         # replace edit must be a [single line] and they must contain the position
@@ -176,6 +193,21 @@ module LanguageServer
           attributes.fetch(:textEdit)
         end
 
+        #
+        # The edit text used if the completion item is part of a CompletionList and
+        # CompletionList defines an item default for the text edit range.
+        #
+        # Clients will only honor this property if they opt into completion list
+        # item defaults using the capability `completionList.itemDefaults`.
+        #
+        # If not provided and a list's default range is provided the label
+        # property is used as a text.
+        #
+        # @return [string]
+        def text_edit_text
+          attributes.fetch(:textEditText)
+        end
+
         #
         # An optional array of additional text edits that are applied when
         # selecting this completion. Edits must not overlap (including the same
@@ -215,7 +247,7 @@ module LanguageServer
         # A data entry field that is preserved on a completion item between
         # a completion and a completion resolve request.
         #
-        # @return [any]
+        # @return [LSPAny]
         def data
           attributes.fetch(:data)
         end

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

@@ -0,0 +1,49 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Additional details for a completion item label.
+      #
+      class CompletionItemLabelDetails
+        def initialize(detail: nil, description: nil)
+          @attributes = {}
+
+          @attributes[:detail] = detail if detail
+          @attributes[:description] = description if description
+
+          @attributes.freeze
+        end
+
+        #
+        # An optional string which is rendered less prominently directly after
+        # {@link CompletionItem.label label}, without any spacing. Should be
+        # used for function signatures or type annotations.
+        #
+        # @return [string]
+        def detail
+          attributes.fetch(:detail)
+        end
+
+        #
+        # An optional string which is rendered less prominently after
+        # {@link CompletionItemLabelDetails.detail}. Should be used for fully qualified
+        # names or file path.
+        #
+        # @return [string]
+        def description
+          attributes.fetch(:description)
+        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/completion_list.rb

@@ -6,24 +6,46 @@ module LanguageServer
       # presented in the editor.
       #
       class CompletionList
-        def initialize(is_incomplete:, items:)
+        def initialize(is_incomplete:, item_defaults: nil, items:)
           @attributes = {}
 
           @attributes[:isIncomplete] = is_incomplete
+          @attributes[:itemDefaults] = item_defaults if item_defaults
           @attributes[:items] = items
 
           @attributes.freeze
         end
 
         #
-        # This list it not complete. Further typing should result in recomputing
+        # This list is not complete. Further typing should result in recomputing
         # this list.
         #
+        # Recomputed lists have all their items replaced (not appended) in the
+        # incomplete completion sessions.
+        #
         # @return [boolean]
         def is_incomplete
           attributes.fetch(:isIncomplete)
         end
 
+        #
+        # In many cases the items of an actual completion result share the same
+        # value for properties like `commitCharacters` or the range of a text
+        # edit. A completion list can therefore define item defaults which will
+        # be used if a completion item itself doesn't specify the value.
+        #
+        # If a completion list specifies a default value and a completion item
+        # also specifies a corresponding value the one from the item is used.
+        #
+        # Servers are only allowed to return default values if the client
+        # signals support for this via the `completionList.itemDefaults`
+        # capability.
+        #
+        # @return [{ commitCharacters?: string[]; editRange?: Range | { insert: Range; replace: Range; }; insertTextFormat?: InsertTextFormat; insertTextMode?: InsertTextMode; data?: LSPAny; }]
+        def item_defaults
+          attributes.fetch(:itemDefaults)
+        end
+
         #
         # The completion items.
         #

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

@@ -5,13 +5,14 @@ module LanguageServer
       # Completion options.
       #
       class CompletionOptions
-        def initialize(work_done_progress: nil, trigger_characters: nil, all_commit_characters: nil, resolve_provider: nil)
+        def initialize(work_done_progress: nil, trigger_characters: nil, all_commit_characters: nil, resolve_provider: nil, completion_item: nil)
           @attributes = {}
 
           @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.freeze
         end
@@ -61,6 +62,15 @@ module LanguageServer
           attributes.fetch(:resolveProvider)
         end
 
+        #
+        # The server supports the following `CompletionItem` specific
+        # capabilities.
+        #
+        # @return [{ labelDetailsSupport?: boolean; }]
+        def completion_item
+          attributes.fetch(:completionItem)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -2,7 +2,7 @@ module LanguageServer
   module Protocol
     module Interface
       class CompletionRegistrationOptions
-        def initialize(document_selector:, work_done_progress: nil, trigger_characters: nil, all_commit_characters: nil, resolve_provider: nil)
+        def initialize(document_selector:, work_done_progress: nil, trigger_characters: nil, all_commit_characters: nil, resolve_provider: nil, completion_item: nil)
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
@@ -10,6 +10,7 @@ module LanguageServer
           @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.freeze
         end
@@ -68,6 +69,15 @@ module LanguageServer
           attributes.fetch(:resolveProvider)
         end
 
+        #
+        # The server supports the following `CompletionItem` specific
+        # capabilities.
+        #
+        # @return [{ labelDetailsSupport?: boolean; }]
+        def completion_item
+          attributes.fetch(:completionItem)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -41,7 +41,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/delete_file.rb

@@ -41,7 +41,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/diagnostic_client_capabilities.rb

@@ -0,0 +1,49 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Client capabilities specific to diagnostic pull requests.
+      #
+      class DiagnosticClientCapabilities
+        def initialize(dynamic_registration: nil, related_document_support: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+          @attributes[:relatedDocumentSupport] = related_document_support if related_document_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
+
+        #
+        # Whether the clients supports related documents for document diagnostic
+        # pulls.
+        #
+        # @return [boolean]
+        def related_document_support
+          attributes.fetch(:relatedDocumentSupport)
+        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/diagnostic_options.rb

@@ -0,0 +1,64 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Diagnostic options.
+      #
+      class DiagnosticOptions
+        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.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]
+        def identifier
+          attributes.fetch(:identifier)
+        end
+
+        #
+        # Whether the language has inter file dependencies meaning that
+        # editing code in one file can result in a different diagnostic
+        # set in another file. Inter file dependencies are common for
+        # most programming languages and typically uncommon for linters.
+        #
+        # @return [boolean]
+        def inter_file_dependencies
+          attributes.fetch(:interFileDependencies)
+        end
+
+        #
+        # The server provides support for workspace diagnostics as well.
+        #
+        # @return [boolean]
+        def workspace_diagnostics
+          attributes.fetch(:workspaceDiagnostics)
+        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/diagnostic_registration_options.rb

@@ -0,0 +1,84 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Diagnostic registration options.
+      #
+      class DiagnosticRegistrationOptions
+        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[: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.
+        #
+        # @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]
+        def identifier
+          attributes.fetch(:identifier)
+        end
+
+        #
+        # Whether the language has inter file dependencies meaning that
+        # editing code in one file can result in a different diagnostic
+        # set in another file. Inter file dependencies are common for
+        # most programming languages and typically uncommon for linters.
+        #
+        # @return [boolean]
+        def inter_file_dependencies
+          attributes.fetch(:interFileDependencies)
+        end
+
+        #
+        # The server provides support for workspace diagnostics as well.
+        #
+        # @return [boolean]
+        def workspace_diagnostics
+          attributes.fetch(:workspaceDiagnostics)
+        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/diagnostic_server_cancellation_data.rb

@@ -0,0 +1,33 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Cancellation data returned from a diagnostic request.
+      #
+      class DiagnosticServerCancellationData
+        def initialize(retrigger_request:)
+          @attributes = {}
+
+          @attributes[:retriggerRequest] = retrigger_request
+
+          @attributes.freeze
+        end
+
+        # @return [boolean]
+        def retrigger_request
+          attributes.fetch(:retriggerRequest)
+        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/diagnostic_workspace_client_capabilities.rb

@@ -0,0 +1,42 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Workspace client capabilities specific to diagnostic pull requests.
+      #
+      class DiagnosticWorkspaceClientCapabilities
+        def initialize(refresh_support: nil)
+          @attributes = {}
+
+          @attributes[:refreshSupport] = refresh_support if refresh_support
+
+          @attributes.freeze
+        end
+
+        #
+        # Whether the client implementation supports a refresh request sent from
+        # 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.
+        #
+        # @return [boolean]
+        def refresh_support
+          attributes.fetch(:refreshSupport)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

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

@@ -13,7 +13,7 @@ module LanguageServer
         #
         # The actual changed settings
         #
-        # @return [any]
+        # @return [LSPAny]
         def settings
           attributes.fetch(:settings)
         end