language_server-protocol 3.17.0.5 → 3.18.0.0.pre.1

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

@@ -1,16 +1,19 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Completion client capabilities
+      #
       class CompletionClientCapabilities
-        def initialize(dynamic_registration: nil, completion_item: nil, completion_item_kind: nil, context_support: nil, insert_text_mode: nil, completion_list: nil)
+        def initialize(dynamic_registration: nil, completion_item: nil, completion_item_kind: nil, insert_text_mode: nil, context_support: 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[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
+          @attributes[:completionItem] = completion_item unless completion_item.nil?
+          @attributes[:completionItemKind] = completion_item_kind unless completion_item_kind.nil?
+          @attributes[:insertTextMode] = insert_text_mode unless insert_text_mode.nil?
+          @attributes[:contextSupport] = context_support unless context_support.nil?
+          @attributes[:completionList] = completion_list unless completion_list.nil?
 
           @attributes.freeze
         end
@@ -27,16 +30,31 @@ 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?: { ...; }; labelDetailsSupport?: boolean; }]
+        # @return [ClientCompletionItemOptions]
         def completion_item
           attributes.fetch(:completionItem)
         end
 
-        # @return [{ valueSet?: CompletionItemKind[]; }]
+        #
+        # The client supports the following completion item kinds.
+        #
+        # @return [ClientCompletionItemOptionsKind]
         def completion_item_kind
           attributes.fetch(:completionItemKind)
         end
 
+        #
+        # Defines how the client handles whitespace and indentation
+        # when accepting a completion item that uses multi line
+        # text in either `insertText` or `textEdit`.
+        #
+        # @since 3.17.0
+        #
+        # @return [InsertTextMode]
+        def insert_text_mode
+          attributes.fetch(:insertTextMode)
+        end
+
         #
         # The client supports to send additional context information for a
         # `textDocument/completion` request.
@@ -46,20 +64,13 @@ 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[]; }]
+        # @since 3.17.0
+        #
+        # @return [CompletionListCapabilities]
         def completion_list
           attributes.fetch(:completionList)
         end

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

@@ -2,15 +2,14 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # Contains additional information about the context in which a completion
-      # request is triggered.
+      # Contains additional information about the context in which a completion request is triggered.
       #
       class CompletionContext
         def initialize(trigger_kind:, trigger_character: nil)
           @attributes = {}
 
           @attributes[:triggerKind] = trigger_kind
-          @attributes[:triggerCharacter] = trigger_character if trigger_character
+          @attributes[:triggerCharacter] = trigger_character unless trigger_character.nil?
 
           @attributes.freeze
         end
@@ -24,9 +23,8 @@ module LanguageServer
         end
 
         #
-        # The trigger character (a single character) that has trigger code
-        # complete. Is undefined if
-        # `triggerKind !== CompletionTriggerKind.TriggerCharacter`
+        # The trigger character (a single character) that has trigger code complete.
+        # Is undefined if `triggerKind !== CompletionTriggerKind.TriggerCharacter`
         #
         # @return [string]
         def trigger_character

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

@@ -1,29 +1,33 @@
 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:, 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
-          @attributes[:documentation] = documentation if documentation
-          @attributes[:deprecated] = deprecated if deprecated
-          @attributes[:preselect] = preselect if preselect
-          @attributes[:sortText] = sort_text if sort_text
-          @attributes[:filterText] = filter_text if filter_text
-          @attributes[:insertText] = insert_text if insert_text
-          @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
-          @attributes[:data] = data if data
+          @attributes[:labelDetails] = label_details unless label_details.nil?
+          @attributes[:kind] = kind unless kind.nil?
+          @attributes[:tags] = tags unless tags.nil?
+          @attributes[:detail] = detail unless detail.nil?
+          @attributes[:documentation] = documentation unless documentation.nil?
+          @attributes[:deprecated] = deprecated unless deprecated.nil?
+          @attributes[:preselect] = preselect unless preselect.nil?
+          @attributes[:sortText] = sort_text unless sort_text.nil?
+          @attributes[:filterText] = filter_text unless filter_text.nil?
+          @attributes[:insertText] = insert_text unless insert_text.nil?
+          @attributes[:insertTextFormat] = insert_text_format unless insert_text_format.nil?
+          @attributes[:insertTextMode] = insert_text_mode unless insert_text_mode.nil?
+          @attributes[:textEdit] = text_edit unless text_edit.nil?
+          @attributes[:textEditText] = text_edit_text unless text_edit_text.nil?
+          @attributes[:additionalTextEdits] = additional_text_edits unless additional_text_edits.nil?
+          @attributes[:commitCharacters] = commit_characters unless commit_characters.nil?
+          @attributes[:command] = command unless command.nil?
+          @attributes[:data] = data unless data.nil?
 
           @attributes.freeze
         end
@@ -45,6 +49,8 @@ module LanguageServer
         #
         # Additional details for the label
         #
+        # @since 3.17.0
+        #
         # @return [CompletionItemLabelDetails]
         def label_details
           attributes.fetch(:labelDetails)
@@ -52,8 +58,7 @@ module LanguageServer
 
         #
         # 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 [CompletionItemKind]
         def kind
@@ -63,7 +68,9 @@ module LanguageServer
         #
         # Tags for this completion item.
         #
-        # @return [1[]]
+        # @since 3.15.0
+        #
+        # @return [CompletionItemTag[]]
         def tags
           attributes.fetch(:tags)
         end
@@ -87,6 +94,7 @@ module LanguageServer
 
         #
         # Indicates if this item is deprecated.
+        # @deprecated Use `tags` instead.
         #
         # @return [boolean]
         def deprecated
@@ -107,8 +115,8 @@ module LanguageServer
 
         #
         # A string that should be used when comparing this item
-        # with other items. When omitted the label is used
-        # as the sort text for this item.
+        # with other items. When `falsy` the {@link CompletionItem.label label}
+        # is used.
         #
         # @return [string]
         def sort_text
@@ -117,8 +125,8 @@ module LanguageServer
 
         #
         # A string that should be used when filtering a set of
-        # completion items. When omitted the label is used as the
-        # filter text for this item.
+        # completion items. When `falsy` the {@link CompletionItem.label label}
+        # is used.
         #
         # @return [string]
         def filter_text
@@ -127,8 +135,8 @@ module LanguageServer
 
         #
         # A string that should be inserted into a document when selecting
-        # this completion. When omitted the label is used as the insert text
-        # for this item.
+        # this completion. When `falsy` the {@link CompletionItem.label label}
+        # is used.
         #
         # The `insertText` is subject to interpretation by the client side.
         # Some tools might not take the string literally. For example
@@ -158,28 +166,28 @@ module LanguageServer
 
         #
         # 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.
         #
+        # @since 3.16.0
+        #
         # @return [InsertTextMode]
         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 {@link TextEdit edit} which is applied to a document when selecting
+        # this completion. When an edit is provided the value of
+        # {@link CompletionItem.insertText 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
         # 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 `InsertReplaceEdit`s via the
-        # `textDocument.completion.completionItem.insertReplaceSupport` client
-        # capability property.
+        # signal support for `InsertReplaceEdits` via the
+        # `textDocument.completion.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
@@ -188,6 +196,8 @@ module LanguageServer
         # must be a prefix of the edit's replace range, that means it must be
         # contained and starting at the same position.
         #
+        # @since 3.16.0 additional type `InsertReplaceEdit`
+        #
         # @return [TextEdit | InsertReplaceEdit]
         def text_edit
           attributes.fetch(:textEdit)
@@ -203,19 +213,21 @@ module LanguageServer
         # 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]
         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
-        # insert position) with the main edit nor with themselves.
+        # An optional array of additional {@link TextEdit text edits} that are applied when
+        # selecting this completion. Edits must not overlap (including the same insert position)
+        # with the main {@link CompletionItem.textEdit edit} 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[]]
         def additional_text_edits
@@ -223,10 +235,9 @@ module LanguageServer
         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[]]
         def commit_characters
@@ -234,9 +245,9 @@ module LanguageServer
         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 {@link Command command} that is executed *after* inserting this completion. *Note* that
+        # additional modifications to the current document should be described with the
+        # {@link CompletionItem.additionalTextEdits additionalTextEdits}-property.
         #
         # @return [Command]
         def command
@@ -244,8 +255,8 @@ module LanguageServer
         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
+        # {@link CompletionRequest} and a {@link CompletionResolveRequest}.
         #
         # @return [LSPAny]
         def data

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

@@ -0,0 +1,96 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Specifies how fields from a completion item should be combined with those
+      # from `completionList.itemDefaults`.
+      #
+      # If unspecified, all fields will be treated as ApplyKind.Replace.
+      #
+      # If a field's value is ApplyKind.Replace, the value from a completion item (if
+      # provided and not `null`) will always be used instead of the value from
+      # `completionItem.itemDefaults`.
+      #
+      # If a field's value is ApplyKind.Merge, the values will be merged using the rules
+      # defined against each field below.
+      #
+      # Servers are only allowed to return `applyKind` if the client
+      # signals support for this via the `completionList.applyKindSupport`
+      # capability.
+      #
+      # @since 3.18.0
+      #
+      class CompletionItemApplyKinds
+        def initialize(commit_characters: nil, data: nil)
+          @attributes = {}
+
+          @attributes[:commitCharacters] = commit_characters unless commit_characters.nil?
+          @attributes[:data] = data unless data.nil?
+
+          @attributes.freeze
+        end
+
+        #
+        # Specifies whether commitCharacters on a completion will replace or be
+        # merged with those in `completionList.itemDefaults.commitCharacters`.
+        #
+        # If ApplyKind.Replace, the commit characters from the completion item will
+        # always be used unless not provided, in which case those from
+        # `completionList.itemDefaults.commitCharacters` will be used. An
+        # empty list can be used if a completion item does not have any commit
+        # characters and also should not use those from
+        # `completionList.itemDefaults.commitCharacters`.
+        #
+        # If ApplyKind.Merge the commitCharacters for the completion will be the
+        # union of all values in both `completionList.itemDefaults.commitCharacters`
+        # and the completion's own `commitCharacters`.
+        #
+        # @since 3.18.0
+        #
+        # @return [ApplyKind]
+        def commit_characters
+          attributes.fetch(:commitCharacters)
+        end
+
+        #
+        # Specifies whether the `data` field on a completion will replace or
+        # be merged with data from `completionList.itemDefaults.data`.
+        #
+        # If ApplyKind.Replace, the data from the completion item will be used if
+        # provided (and not `null`), otherwise
+        # `completionList.itemDefaults.data` will be used. An empty object can
+        # be used if a completion item does not have any data but also should
+        # not use the value from `completionList.itemDefaults.data`.
+        #
+        # If ApplyKind.Merge, a shallow merge will be performed between
+        # `completionList.itemDefaults.data` and the completion's own data
+        # using the following rules:
+        #
+        # - If a completion's `data` field is not provided (or `null`), the
+        #   entire `data` field from `completionList.itemDefaults.data` will be
+        #   used as-is.
+        # - If a completion's `data` field is provided, each field will
+        #   overwrite the field of the same name in
+        #   `completionList.itemDefaults.data` but no merging of nested fields
+        #   within that value will occur.
+        #
+        # @since 3.18.0
+        #
+        # @return [ApplyKind]
+        def data
+          attributes.fetch(:data)
+        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_item_defaults.rb

@@ -0,0 +1,96 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # 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 rules for combining these are
+      # defined by `applyKinds` (if the client supports it), defaulting to
+      # ApplyKind.Replace.
+      #
+      # Servers are only allowed to return default values if the client
+      # signals support for this via the `completionList.itemDefaults`
+      # capability.
+      #
+      # @since 3.17.0
+      #
+      class CompletionItemDefaults
+        def initialize(commit_characters: nil, edit_range: nil, insert_text_format: nil, insert_text_mode: nil, data: nil)
+          @attributes = {}
+
+          @attributes[:commitCharacters] = commit_characters unless commit_characters.nil?
+          @attributes[:editRange] = edit_range unless edit_range.nil?
+          @attributes[:insertTextFormat] = insert_text_format unless insert_text_format.nil?
+          @attributes[:insertTextMode] = insert_text_mode unless insert_text_mode.nil?
+          @attributes[:data] = data unless data.nil?
+
+          @attributes.freeze
+        end
+
+        #
+        # A default commit character set.
+        #
+        # @since 3.17.0
+        #
+        # @return [string[]]
+        def commit_characters
+          attributes.fetch(:commitCharacters)
+        end
+
+        #
+        # A default edit range.
+        #
+        # @since 3.17.0
+        #
+        # @return [Range | EditRangeWithInsertReplace]
+        def edit_range
+          attributes.fetch(:editRange)
+        end
+
+        #
+        # A default insert text format.
+        #
+        # @since 3.17.0
+        #
+        # @return [InsertTextFormat]
+        def insert_text_format
+          attributes.fetch(:insertTextFormat)
+        end
+
+        #
+        # A default insert text mode.
+        #
+        # @since 3.17.0
+        #
+        # @return [InsertTextMode]
+        def insert_text_mode
+          attributes.fetch(:insertTextMode)
+        end
+
+        #
+        # A default data value.
+        #
+        # @since 3.17.0
+        #
+        # @return [LSPAny]
+        def data
+          attributes.fetch(:data)
+        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_item_label_details.rb

@@ -4,20 +4,21 @@ module LanguageServer
       #
       # 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[:detail] = detail unless detail.nil?
+          @attributes[:description] = description unless description.nil?
 
           @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.
+        # 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]
         def detail
@@ -25,9 +26,8 @@ module LanguageServer
         end
 
         #
-        # An optional string which is rendered less prominently after
-        # {@link CompletionItemLabelDetails.detail}. Should be used for fully qualified
-        # names or file path.
+        # An optional string which is rendered less prominently after {@link CompletionItem.detail}. Should be used
+        # for fully qualified names and file paths.
         #
         # @return [string]
         def description

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

@@ -0,0 +1,36 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # @since 3.18.0
+      #
+      class CompletionItemTagOptions
+        def initialize(value_set:)
+          @attributes = {}
+
+          @attributes[:valueSet] = value_set
+
+          @attributes.freeze
+        end
+
+        #
+        # The tags supported by the client.
+        #
+        # @return [CompletionItemTag[]]
+        def value_set
+          attributes.fetch(:valueSet)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end