language_server-protocol 3.17.0.6 → 3.18.0.0.pre.1

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

@@ -9,8 +9,8 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @attributes[:resolveProvider] = resolve_provider if resolve_provider
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:resolveProvider] = resolve_provider unless resolve_provider.nil?
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @attributes.freeze
         end

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

@@ -8,7 +8,7 @@ module LanguageServer
         def initialize(refresh_support: nil)
           @attributes = {}
 
-          @attributes[:refreshSupport] = refresh_support if refresh_support
+          @attributes[:refreshSupport] = refresh_support unless refresh_support.nil?
 
           @attributes.freeze
         end

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

@@ -6,8 +6,8 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:label] = label
-          @attributes[:textEdit] = text_edit if text_edit
-          @attributes[:additionalTextEdits] = additional_text_edits if additional_text_edits
+          @attributes[:textEdit] = text_edit unless text_edit.nil?
+          @attributes[:additionalTextEdits] = additional_text_edits unless additional_text_edits.nil?
 
           @attributes.freeze
         end

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

@@ -11,8 +11,8 @@ module LanguageServer
           @attributes[:textDocument] = text_document
           @attributes[:color] = color
           @attributes[:range] = range
-          @attributes[:workDoneToken] = work_done_token if work_done_token
-          @attributes[:partialResultToken] = partial_result_token if partial_result_token
+          @attributes[:workDoneToken] = work_done_token unless work_done_token.nil?
+          @attributes[:partialResultToken] = partial_result_token unless partial_result_token.nil?
 
           @attributes.freeze
         end

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

@@ -8,12 +8,13 @@ module LanguageServer
       # function when invoked.
       #
       class Command
-        def initialize(title:, command:, arguments: nil)
+        def initialize(title:, tooltip: nil, command:, arguments: nil)
           @attributes = {}
 
           @attributes[:title] = title
+          @attributes[:tooltip] = tooltip unless tooltip.nil?
           @attributes[:command] = command
-          @attributes[:arguments] = arguments if arguments
+          @attributes[:arguments] = arguments unless arguments.nil?
 
           @attributes.freeze
         end
@@ -26,6 +27,16 @@ module LanguageServer
           attributes.fetch(:title)
         end
 
+        #
+        # An optional tooltip.
+        #
+        # @since 3.18.0
+        #
+        # @return [string]
+        def tooltip
+          attributes.fetch(:tooltip)
+        end
+
         #
         # The identifier of the actual command handler.
         #

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

@@ -8,12 +8,12 @@ module LanguageServer
         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[:insertTextMode] = insert_text_mode if insert_text_mode
-          @attributes[:contextSupport] = context_support if context_support
-          @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
@@ -30,12 +30,15 @@ module LanguageServer
         # The client supports the following `CompletionItem` specific
         # capabilities.
         #
-        # @return [{ snippetSupport?: boolean; commitCharactersSupport?: boolean; documentationFormat?: MarkupKind[]; deprecatedSupport?: boolean; preselectSupport?: boolean; tagSupport?: { valueSet: CompletionItemTag[]; }; insertReplaceSupport?: boolean; resolveSupport?: { properties: string[]; }; insertTextModeSupport?: { valueSet: InsertTextMode[]; }; 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
@@ -67,7 +70,7 @@ module LanguageServer
         #
         # @since 3.17.0
         #
-        # @return [{ itemDefaults?: string[]; }]
+        # @return [CompletionListCapabilities]
         def completion_list
           attributes.fetch(:completionList)
         end

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

@@ -9,7 +9,7 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:triggerKind] = trigger_kind
-          @attributes[:triggerCharacter] = trigger_character if trigger_character
+          @attributes[:triggerCharacter] = trigger_character unless trigger_character.nil?
 
           @attributes.freeze
         end

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

@@ -10,24 +10,24 @@ module LanguageServer
           @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

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

@@ -10,8 +10,8 @@ module LanguageServer
         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

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

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

@@ -6,11 +6,12 @@ module LanguageServer
       # in the editor.
       #
       class CompletionList
-        def initialize(is_incomplete:, item_defaults: nil, items:)
+        def initialize(is_incomplete:, item_defaults: nil, apply_kind: nil, items:)
           @attributes = {}
 
           @attributes[:isIncomplete] = is_incomplete
-          @attributes[:itemDefaults] = item_defaults if item_defaults
+          @attributes[:itemDefaults] = item_defaults unless item_defaults.nil?
+          @attributes[:applyKind] = apply_kind unless apply_kind.nil?
           @attributes[:items] = items
 
           @attributes.freeze
@@ -34,7 +35,9 @@ module LanguageServer
         # 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.
+        # 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`
@@ -42,11 +45,35 @@ module LanguageServer
         #
         # @since 3.17.0
         #
-        # @return [{ commitCharacters?: string[]; editRange?: Range | { insert: Range; replace: Range; }; insertTextFormat?: InsertTextFormat; insertTextMode?: InsertTextMode; data?: LSPAny; }]
+        # @return [CompletionItemDefaults]
         def item_defaults
           attributes.fetch(:itemDefaults)
         end
 
+        #
+        # 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
+        #
+        # @return [CompletionItemApplyKinds]
+        def apply_kind
+          attributes.fetch(:applyKind)
+        end
+
         #
         # The completion items.
         #

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

@@ -0,0 +1,65 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # The client supports the following `CompletionList` specific
+      # capabilities.
+      #
+      # @since 3.17.0
+      #
+      class CompletionListCapabilities
+        def initialize(item_defaults: nil, apply_kind_support: nil)
+          @attributes = {}
+
+          @attributes[:itemDefaults] = item_defaults unless item_defaults.nil?
+          @attributes[:applyKindSupport] = apply_kind_support unless apply_kind_support.nil?
+
+          @attributes.freeze
+        end
+
+        #
+        # The client supports the following itemDefaults on
+        # a completion list.
+        #
+        # The value lists the supported property names of the
+        # `CompletionList.itemDefaults` object. If omitted
+        # no properties are supported.
+        #
+        # @since 3.17.0
+        #
+        # @return [string[]]
+        def item_defaults
+          attributes.fetch(:itemDefaults)
+        end
+
+        #
+        # Specifies whether the client supports `CompletionList.applyKind` to
+        # indicate how supported values from `completionList.itemDefaults`
+        # and `completion` will be combined.
+        #
+        # If a client supports `applyKind` it must support it for all fields
+        # that it supports that are listed in `CompletionList.applyKind`. This
+        # means when clients add support for new/future fields in completion
+        # items the MUST also support merge for them if those fields are
+        # defined in `CompletionList.applyKind`.
+        #
+        # @since 3.18.0
+        #
+        # @return [boolean]
+        def apply_kind_support
+          attributes.fetch(:applyKindSupport)
+        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_options.rb

@@ -8,11 +8,11 @@ module LanguageServer
         def initialize(trigger_characters: nil, all_commit_characters: nil, resolve_provider: nil, completion_item: nil, work_done_progress: nil)
           @attributes = {}
 
-          @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[:triggerCharacters] = trigger_characters unless trigger_characters.nil?
+          @attributes[:allCommitCharacters] = all_commit_characters unless all_commit_characters.nil?
+          @attributes[:resolveProvider] = resolve_provider unless resolve_provider.nil?
+          @attributes[:completionItem] = completion_item unless completion_item.nil?
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @attributes.freeze
         end
@@ -62,7 +62,7 @@ module LanguageServer
         #
         # @since 3.17.0
         #
-        # @return [{ labelDetailsSupport?: boolean; }]
+        # @return [ServerCompletionItemOptions]
         def completion_item
           attributes.fetch(:completionItem)
         end

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

@@ -8,11 +8,11 @@ module LanguageServer
         def initialize(context: nil, text_document:, position:, work_done_token: nil, partial_result_token: nil)
           @attributes = {}
 
-          @attributes[:context] = context if context
+          @attributes[:context] = context unless context.nil?
           @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[:workDoneToken] = work_done_token unless work_done_token.nil?
+          @attributes[:partialResultToken] = partial_result_token unless partial_result_token.nil?
 
           @attributes.freeze
         end

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

@@ -9,11 +9,11 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @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[:triggerCharacters] = trigger_characters unless trigger_characters.nil?
+          @attributes[:allCommitCharacters] = all_commit_characters unless all_commit_characters.nil?
+          @attributes[:resolveProvider] = resolve_provider unless resolve_provider.nil?
+          @attributes[:completionItem] = completion_item unless completion_item.nil?
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @attributes.freeze
         end
@@ -72,7 +72,7 @@ module LanguageServer
         #
         # @since 3.17.0
         #
-        # @return [{ labelDetailsSupport?: boolean; }]
+        # @return [ServerCompletionItemOptions]
         def completion_item
           attributes.fetch(:completionItem)
         end

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

@@ -5,8 +5,8 @@ module LanguageServer
         def initialize(scope_uri: nil, section: nil)
           @attributes = {}
 
-          @attributes[:scopeUri] = scope_uri if scope_uri
-          @attributes[:section] = section if section
+          @attributes[:scopeUri] = scope_uri unless scope_uri.nil?
+          @attributes[:section] = section unless section.nil?
 
           @attributes.freeze
         end
@@ -14,7 +14,7 @@ module LanguageServer
         #
         # The scope to get the configuration section for.
         #
-        # @return [string]
+        # @return [URI]
         def scope_uri
           attributes.fetch(:scopeUri)
         end

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

@@ -10,8 +10,8 @@ module LanguageServer
 
           @attributes[:kind] = kind
           @attributes[:uri] = uri
-          @attributes[:options] = options if options
-          @attributes[:annotationId] = annotation_id if annotation_id
+          @attributes[:options] = options unless options.nil?
+          @attributes[:annotationId] = annotation_id unless annotation_id.nil?
 
           @attributes.freeze
         end

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

@@ -8,8 +8,8 @@ module LanguageServer
         def initialize(overwrite: nil, ignore_if_exists: nil)
           @attributes = {}
 
-          @attributes[:overwrite] = overwrite if overwrite
-          @attributes[:ignoreIfExists] = ignore_if_exists if ignore_if_exists
+          @attributes[:overwrite] = overwrite unless overwrite.nil?
+          @attributes[:ignoreIfExists] = ignore_if_exists unless ignore_if_exists.nil?
 
           @attributes.freeze
         end