language_server-protocol 3.16.0.1 → 3.17.0.0

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

@@ -1,11 +1,16 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # A completion item represents a text snippet that is
+      # proposed to complete text that is being typed.
+      #
       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 +23,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 +33,34 @@ 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
+        #
+        # @since 3.17.0
+        #
+        # @return [CompletionItemLabelDetails | nil]
+        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`.
+        # an icon is chosen by the editor.
         #
-        # @return [any]
+        # @return [CompletionItemKind | nil]
         def kind
           attributes.fetch(:kind)
         end
@@ -49,7 +68,9 @@ module LanguageServer
         #
         # Tags for this completion item.
         #
-        # @return [1[]]
+        # @since 3.15.0
+        #
+        # @return [CompletionItemTag[] | nil]
         def tags
           attributes.fetch(:tags)
         end
@@ -58,7 +79,7 @@ module LanguageServer
         # A human-readable string with additional information
         # about this item, like type or symbol information.
         #
-        # @return [string]
+        # @return [string | nil]
         def detail
           attributes.fetch(:detail)
         end
@@ -66,15 +87,16 @@ module LanguageServer
         #
         # A human-readable string that represents a doc-comment.
         #
-        # @return [string | MarkupContent]
+        # @return [string | MarkupContent | nil]
         def documentation
           attributes.fetch(:documentation)
         end
 
         #
         # Indicates if this item is deprecated.
+        # @deprecated Use `tags` instead.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def deprecated
           attributes.fetch(:deprecated)
         end
@@ -86,35 +108,35 @@ module LanguageServer
         # tool / client decides which item that is. The rule is that the *first*
         # item of those that match best is selected.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def preselect
           attributes.fetch(:preselect)
         end
 
         #
         # A string that should be used when comparing this item
-        # with other items. When `falsy` the label is used
-        # as the sort text for this item.
+        # with other items. When `falsy` the [label](#CompletionItem.label)
+        # is used.
         #
-        # @return [string]
+        # @return [string | nil]
         def sort_text
           attributes.fetch(:sortText)
         end
 
         #
         # A string that should be used when filtering a set of
-        # completion items. When `falsy` the label is used as the
-        # filter text for this item.
+        # completion items. When `falsy` the [label](#CompletionItem.label)
+        # is used.
         #
-        # @return [string]
+        # @return [string | nil]
         def filter_text
           attributes.fetch(:filterText)
         end
 
         #
         # A string that should be inserted into a document when selecting
-        # this completion. When `falsy` the label is used as the insert text
-        # for this item.
+        # this completion. When `falsy` the [label](#CompletionItem.label)
+        # is used.
         #
         # The `insertText` is subject to interpretation by the client side.
         # Some tools might not take the string literally. For example
@@ -124,7 +146,7 @@ module LanguageServer
         # recommended to use `textEdit` instead since it avoids additional client
         # side interpretation.
         #
-        # @return [string]
+        # @return [string | nil]
         def insert_text
           attributes.fetch(:insertText)
         end
@@ -134,27 +156,30 @@ module LanguageServer
         # `insertText` property and the `newText` property of a provided
         # `textEdit`. If omitted defaults to `InsertTextFormat.PlainText`.
         #
-        # @return [InsertTextFormat]
+        # Please note that the insertTextFormat doesn't apply to
+        # `additionalTextEdits`.
+        #
+        # @return [InsertTextFormat | nil]
         def insert_text_format
           attributes.fetch(:insertTextFormat)
         end
 
         #
         # How whitespace and indentation is handled during completion
-        # item insertion. If not provided the client's default value depends on
+        # item insertion. If not provided the clients default value depends on
         # the `textDocument.completion.insertTextMode` client capability.
         #
-        # @return [InsertTextMode]
+        # @since 3.16.0
+        #
+        # @return [InsertTextMode | nil]
         def insert_text_mode
           attributes.fetch(:insertTextMode)
         end
 
         #
-        # An edit which is applied to a document when selecting this completion.
-        # When an edit is provided the value of `insertText` is ignored.
-        #
-        # *Note:* The range of the edit must be a single line range and it must
-        # contain the position at which completion has been requested.
+        # An [edit](#TextEdit) which is applied to a document when selecting
+        # this completion. When an edit is provided the value of
+        # [insertText](#CompletionItem.insertText) is ignored.
         #
         # Most editors support two different operations when accepting a completion
         # item. One is to insert a completion text and the other is to replace an
@@ -171,51 +196,69 @@ module LanguageServer
         # must be a prefix of the edit's replace range, that means it must be
         # contained and starting at the same position.
         #
-        # @return [TextEdit | InsertReplaceEdit]
+        # @since 3.16.0 additional type `InsertReplaceEdit`
+        #
+        # @return [TextEdit | InsertReplaceEdit | nil]
         def text_edit
           attributes.fetch(:textEdit)
         end
 
         #
-        # An optional array of additional text edits that are applied when
-        # selecting this completion. Edits must not overlap (including the same
-        # insert position) with the main edit nor with themselves.
+        # 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.
+        #
+        # @since 3.17.0
+        #
+        # @return [string | nil]
+        def text_edit_text
+          attributes.fetch(:textEditText)
+        end
+
+        #
+        # An optional array of additional [text edits](#TextEdit) that are applied when
+        # selecting this completion. Edits must not overlap (including the same insert position)
+        # with the main [edit](#CompletionItem.textEdit) nor with themselves.
         #
-        # Additional text edits should be used to change text unrelated to the
-        # current cursor position (for example adding an import statement at the
-        # top of the file if the completion item will insert an unqualified type).
+        # Additional text edits should be used to change text unrelated to the current cursor position
+        # (for example adding an import statement at the top of the file if the completion item will
+        # insert an unqualified type).
         #
-        # @return [TextEdit[]]
+        # @return [TextEdit[] | nil]
         def additional_text_edits
           attributes.fetch(:additionalTextEdits)
         end
 
         #
-        # An optional set of characters that when pressed while this completion is
-        # active will accept it first and then type that character. *Note* that all
-        # commit characters should have `length=1` and that superfluous characters
-        # will be ignored.
+        # An optional set of characters that when pressed while this completion is active will accept it first and
+        # then type that character. *Note* that all commit characters should have `length=1` and that superfluous
+        # characters will be ignored.
         #
-        # @return [string[]]
+        # @return [string[] | nil]
         def commit_characters
           attributes.fetch(:commitCharacters)
         end
 
         #
-        # An optional command that is executed *after* inserting this completion.
-        # *Note* that additional modifications to the current document should be
-        # described with the additionalTextEdits-property.
+        # An optional [command](#Command) that is executed *after* inserting this completion. *Note* that
+        # additional modifications to the current document should be described with the
+        # [additionalTextEdits](#CompletionItem.additionalTextEdits)-property.
         #
-        # @return [Command]
+        # @return [Command | nil]
         def command
           attributes.fetch(:command)
         end
 
         #
-        # A data entry field that is preserved on a completion item between
-        # a completion and a completion resolve request.
+        # A data entry field that is preserved on a completion item between a
+        # [CompletionRequest](#CompletionRequest) and a [CompletionResolveRequest](#CompletionResolveRequest).
         #
-        # @return [any]
+        # @return [LSPAny | nil]
         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.
+      #
+      # @since 3.17.0
+      #
+      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 and type annotations.
+        #
+        # @return [string | nil]
+        def detail
+          attributes.fetch(:detail)
+        end
+
+        #
+        # An optional string which is rendered less prominently after {@link CompletionItem.detail}. Should be used
+        # for fully qualified names and file paths.
+        #
+        # @return [string | nil]
+        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

@@ -2,28 +2,51 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # Represents a collection of [completion items](#CompletionItem) to be
-      # presented in the editor.
+      # Represents a collection of [completion items](#CompletionItem) to be 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.
+        # This list it not complete. Further typing results 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.
+        #
+        # @since 3.17.0
+        #
+        # @return [{ commitCharacters:string[], editRange:Range | { insert:Range, replace:Range }, insertTextFormat:InsertTextFormat, insertTextMode:InsertTextMode, data:LSPAny } | nil]
+        def item_defaults
+          attributes.fetch(:itemDefaults)
+        end
+
         #
         # The completion items.
         #

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

@@ -5,49 +5,44 @@ module LanguageServer
       # Completion options.
       #
       class CompletionOptions
-        def initialize(work_done_progress: nil, trigger_characters: nil, all_commit_characters: nil, resolve_provider: nil)
+        def initialize(trigger_characters: nil, all_commit_characters: nil, resolve_provider: nil, completion_item: nil, work_done_progress: 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[:workDoneProgress] = work_done_progress if work_done_progress
 
           @attributes.freeze
         end
 
-        # @return [boolean]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         #
-        # 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 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`.
+        # 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[]]
+        # @return [string[] | nil]
         def trigger_characters
           attributes.fetch(:triggerCharacters)
         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.
         #
-        # @return [string[]]
+        # @since 3.2.0
+        #
+        # @return [string[] | nil]
         def all_commit_characters
           attributes.fetch(:allCommitCharacters)
         end
@@ -56,11 +51,27 @@ module LanguageServer
         # The server provides support to resolve additional
         # information for a completion item.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def resolve_provider
           attributes.fetch(:resolveProvider)
         end
 
+        #
+        # The server supports the following `CompletionItem` specific
+        # capabilities.
+        #
+        # @since 3.17.0
+        #
+        # @return [{ labelDetailsSupport:boolean } | nil]
+        def completion_item
+          attributes.fetch(:completionItem)
+        end
+
+        # @return [boolean | nil]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -1,19 +1,31 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Completion parameters
+      #
       class CompletionParams
-        def initialize(text_document:, position:, work_done_token: nil, partial_result_token: nil, context: nil)
+        def initialize(context: nil, text_document:, position:, work_done_token: nil, partial_result_token: nil)
           @attributes = {}
 
+          @attributes[:context] = context if context
           @attributes[:textDocument] = text_document
           @attributes[:position] = position
           @attributes[:workDoneToken] = work_done_token if work_done_token
           @attributes[:partialResultToken] = partial_result_token if partial_result_token
-          @attributes[:context] = context if context
 
           @attributes.freeze
         end
 
+        #
+        # The completion context. This is only available it the client specifies
+        # to send this using the client capability `textDocument.completion.contextSupport === true`
+        #
+        # @return [CompletionContext | nil]
+        def context
+          attributes.fetch(:context)
+        end
+
         #
         # The text document.
         #
@@ -33,30 +45,20 @@ module LanguageServer
         #
         # An optional token that a server can use to report work done progress.
         #
-        # @return [ProgressToken]
+        # @return [ProgressToken | nil]
         def work_done_token
           attributes.fetch(:workDoneToken)
         end
 
         #
-        # An optional token that a server can use to report partial results (e.g.
-        # streaming) to the client.
+        # An optional token that a server can use to report partial results (e.g. streaming) to
+        # the client.
         #
-        # @return [ProgressToken]
+        # @return [ProgressToken | nil]
         def partial_result_token
           attributes.fetch(:partialResultToken)
         end
 
-        #
-        # The completion context. This is only available if the client specifies
-        # to send this using the client capability
-        # `completion.contextSupport === true`
-        #
-        # @return [CompletionContext]
-        def context
-          attributes.fetch(:context)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -1,60 +1,58 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Registration options for a [CompletionRequest](#CompletionRequest).
+      #
       class CompletionRegistrationOptions
-        def initialize(document_selector:, work_done_progress: nil, trigger_characters: nil, all_commit_characters: nil, resolve_provider: 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 | null]
         def document_selector
           attributes.fetch(:documentSelector)
         end
 
-        # @return [boolean]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         #
-        # 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 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`.
+        # 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[]]
+        # @return [string[] | nil]
         def trigger_characters
           attributes.fetch(:triggerCharacters)
         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.
         #
-        # @return [string[]]
+        # @since 3.2.0
+        #
+        # @return [string[] | nil]
         def all_commit_characters
           attributes.fetch(:allCommitCharacters)
         end
@@ -63,11 +61,27 @@ module LanguageServer
         # The server provides support to resolve additional
         # information for a completion item.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def resolve_provider
           attributes.fetch(:resolveProvider)
         end
 
+        #
+        # The server supports the following `CompletionItem` specific
+        # capabilities.
+        #
+        # @since 3.17.0
+        #
+        # @return [{ labelDetailsSupport:boolean } | nil]
+        def completion_item
+          attributes.fetch(:completionItem)
+        end
+
+        # @return [boolean | nil]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         attr_reader :attributes
 
         def to_hash