language_server-protocol 3.17.0.5 → 3.18.0.0.pre.1

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

@@ -2,23 +2,23 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # Represents a collection of [completion items](#CompletionItem) to be
-      # presented in the editor.
+      # Represents a collection of {@link CompletionItem completion items} to be presented
+      # 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
         end
 
         #
-        # This list is 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.
@@ -35,17 +35,45 @@ 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`
         # capability.
         #
-        # @return [{ commitCharacters?: string[]; editRange?: Range | { insert: Range; replace: Range; }; insertTextFormat?: InsertTextFormat; insertTextMode?: InsertTextMode; data?: LSPAny; }]
+        # @since 3.17.0
+        #
+        # @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

@@ -5,35 +5,27 @@ module LanguageServer
       # Completion options.
       #
       class CompletionOptions
-        def initialize(work_done_progress: nil, trigger_characters: nil, all_commit_characters: nil, resolve_provider: nil, completion_item: 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[: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
 
-        # @return [boolean]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         #
-        # The additional characters, beyond the defaults provided by the client (typically
-        # [a-zA-Z]), that should automatically trigger a completion request. For example
-        # `.` in JavaScript represents the beginning of an object property or method and is
-        # thus a good candidate for triggering a completion request.
+        # 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 a 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`.
         #
         # @return [string[]]
         def trigger_characters
@@ -41,13 +33,14 @@ module LanguageServer
         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.
+        # @since 3.2.0
         #
         # @return [string[]]
         def all_commit_characters
@@ -67,11 +60,18 @@ module LanguageServer
         # The server supports the following `CompletionItem` specific
         # capabilities.
         #
-        # @return [{ labelDetailsSupport?: boolean; }]
+        # @since 3.17.0
+        #
+        # @return [ServerCompletionItemOptions]
         def completion_item
           attributes.fetch(:completionItem)
         end
 
+        # @return [boolean]
+        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 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[:context] = context if context
+          @attributes[:workDoneToken] = work_done_token unless work_done_token.nil?
+          @attributes[:partialResultToken] = partial_result_token unless partial_result_token.nil?
 
           @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]
+        def context
+          attributes.fetch(:context)
+        end
+
         #
         # The text document.
         #
@@ -39,24 +51,14 @@ module LanguageServer
         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]
         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,46 +1,41 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Registration options for a {@link CompletionRequest}.
+      #
       class CompletionRegistrationOptions
-        def initialize(document_selector:, work_done_progress: nil, trigger_characters: nil, all_commit_characters: nil, resolve_provider: nil, completion_item: 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[: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
 
         #
-        # 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 | nil]
         def document_selector
           attributes.fetch(:documentSelector)
         end
 
-        # @return [boolean]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         #
-        # The additional characters, beyond the defaults provided by the client (typically
-        # [a-zA-Z]), that should automatically trigger a completion request. For example
-        # `.` in JavaScript represents the beginning of an object property or method and is
-        # thus a good candidate for triggering a completion request.
+        # 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 a 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`.
         #
         # @return [string[]]
         def trigger_characters
@@ -48,13 +43,14 @@ module LanguageServer
         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.
+        # @since 3.2.0
         #
         # @return [string[]]
         def all_commit_characters
@@ -74,11 +70,18 @@ module LanguageServer
         # The server supports the following `CompletionItem` specific
         # capabilities.
         #
-        # @return [{ labelDetailsSupport?: boolean; }]
+        # @since 3.17.0
+        #
+        # @return [ServerCompletionItemOptions]
         def completion_item
           attributes.fetch(:completionItem)
         end
 
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         attr_reader :attributes
 
         def to_hash

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/configuration_params.rb

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The parameters of a configuration request.
+      #
       class ConfigurationParams
         def initialize(items:)
           @attributes = {}

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

@@ -2,7 +2,7 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # Create file operation
+      # Create file operation.
       #
       class CreateFile
         def initialize(kind:, uri:, options: nil, annotation_id: nil)
@@ -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
@@ -27,7 +27,7 @@ module LanguageServer
         #
         # The resource to create.
         #
-        # @return [string]
+        # @return [DocumentUri]
         def uri
           attributes.fetch(:uri)
         end
@@ -43,7 +43,9 @@ module LanguageServer
         #
         # An optional annotation identifier describing the operation.
         #
-        # @return [string]
+        # @since 3.16.0
+        #
+        # @return [ChangeAnnotationIdentifier]
         def annotation_id
           attributes.fetch(:annotationId)
         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

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

@@ -2,8 +2,10 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # The parameters sent in notifications/requests for user-initiated creation
-      # of files.
+      # The parameters sent in notifications/requests for user-initiated creation of
+      # files.
+      #
+      # @since 3.16.0
       #
       class CreateFilesParams
         def initialize(files:)

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

@@ -1,20 +1,23 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # @since 3.14.0
+      #
       class DeclarationClientCapabilities
         def initialize(dynamic_registration: nil, link_support: nil)
           @attributes = {}
 
-          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
-          @attributes[:linkSupport] = link_support if link_support
+          @attributes[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
+          @attributes[:linkSupport] = link_support unless link_support.nil?
 
           @attributes.freeze
         end
 
         #
-        # Whether declaration supports dynamic registration. If this is set to
-        # `true` the client supports the new `DeclarationRegistrationOptions`
-        # return value for the corresponding server capability as well.
+        # Whether declaration supports dynamic registration. If this is set to `true`
+        # the client supports the new `DeclarationRegistrationOptions` return value
+        # for the corresponding server capability as well.
         #
         # @return [boolean]
         def dynamic_registration

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

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

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

@@ -7,8 +7,8 @@ module LanguageServer
 
           @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
@@ -38,8 +38,8 @@ module LanguageServer
         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]
         def partial_result_token

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

@@ -5,9 +5,9 @@ module LanguageServer
         def initialize(work_done_progress: nil, document_selector:, id: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
           @attributes[:documentSelector] = document_selector
-          @attributes[:id] = id if id
+          @attributes[:id] = id unless id.nil?
 
           @attributes.freeze
         end
@@ -18,10 +18,10 @@ module LanguageServer
         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 | nil]
         def document_selector
           attributes.fetch(:documentSelector)
         end

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

@@ -1,12 +1,15 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Client Capabilities for a {@link DefinitionRequest}.
+      #
       class DefinitionClientCapabilities
         def initialize(dynamic_registration: nil, link_support: nil)
           @attributes = {}
 
-          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
-          @attributes[:linkSupport] = link_support if link_support
+          @attributes[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
+          @attributes[:linkSupport] = link_support unless link_support.nil?
 
           @attributes.freeze
         end
@@ -22,6 +25,8 @@ module LanguageServer
         #
         # The client supports additional metadata in the form of definition links.
         #
+        # @since 3.14.0
+        #
         # @return [boolean]
         def link_support
           attributes.fetch(:linkSupport)

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

@@ -1,11 +1,14 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Server Capabilities for a {@link DefinitionRequest}.
+      #
       class DefinitionOptions
         def initialize(work_done_progress: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @attributes.freeze
         end