language_server-protocol 3.14.0.1 → 3.16.0.0

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

@@ -0,0 +1,33 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class CodeLensClientCapabilities
+        def initialize(dynamic_registration: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+
+          @attributes.freeze
+        end
+
+        #
+        # Whether code lens supports dynamic registration.
+        #
+        # @return [boolean]
+        def dynamic_registration
+          attributes.fetch(:dynamicRegistration)
+        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/code_lens_options.rb

@@ -1,13 +1,11 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Code Lens options.
-      #
-      class CodeLensOptions
-        def initialize(resolve_provider: nil)
+      class CodeLensOptions < WorkDoneProgressOptions
+        def initialize(work_done_progress: nil, resolve_provider: nil)
           @attributes = {}
 
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
           @attributes[:resolveProvider] = resolve_provider if resolve_provider
 
           @attributes.freeze

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

@@ -1,10 +1,11 @@
 module LanguageServer
   module Protocol
     module Interface
-      class CodeLensParams
-        def initialize(text_document:)
+      class CodeLensParams < PartialResultParams
+        def initialize(partial_result_token: nil, text_document:)
           @attributes = {}
 
+          @attributes[:partialResultToken] = partial_result_token if partial_result_token
           @attributes[:textDocument] = text_document
 
           @attributes.freeze

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

@@ -1,23 +1,16 @@
 module LanguageServer
   module Protocol
     module Interface
-      class CodeLensRegistrationOptions < TextDocumentRegistrationOptions
-        def initialize(document_selector:, resolve_provider: nil)
+      class CodeLensRegistrationOptions < CodeLensOptions
+        def initialize(work_done_progress: nil, resolve_provider: nil)
           @attributes = {}
 
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
           @attributes[:resolveProvider] = resolve_provider if resolve_provider
 
           @attributes.freeze
         end
 
-        #
-        # Code lens has a resolve provider as well.
-        #
-        # @return [boolean]
-        def resolve_provider
-          attributes.fetch(:resolveProvider)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -0,0 +1,39 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class CodeLensWorkspaceClientCapabilities
+        def initialize(refresh_support: nil)
+          @attributes = {}
+
+          @attributes[:refreshSupport] = refresh_support if refresh_support
+
+          @attributes.freeze
+        end
+
+        #
+        # Whether the client implementation supports a refresh request sent from the
+        # server to the client.
+        #
+        # Note that this event is global and will force the client to refresh all
+        # code lenses currently shown. It should be used with absolute care and is
+        # useful for situation where a server for example detect a project wide
+        # change that requires such a calculation.
+        #
+        # @return [boolean]
+        def refresh_support
+          attributes.fetch(:refreshSupport)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

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

@@ -14,8 +14,8 @@ module LanguageServer
 
         #
         # The label of this color presentation. It will be shown on the color
-        # picker header. By default this is also the text that is inserted when selecting
-        # this color presentation.
+        # picker header. By default this is also the text that is inserted when
+        # selecting this color presentation.
         #
         # @return [string]
         def label
@@ -24,8 +24,8 @@ module LanguageServer
 
         #
         # An [edit](#TextEdit) which is applied to a document when selecting
-        # this presentation for the color.  When `falsy` the [label](#ColorPresentation.label)
-        # is used.
+        # this presentation for the color.  When `falsy` the
+        # [label](#ColorPresentation.label) is used.
         #
         # @return [TextEdit]
         def text_edit
@@ -33,8 +33,9 @@ module LanguageServer
         end
 
         #
-        # An optional array of additional [text edits](#TextEdit) that are applied when
-        # selecting this color presentation. Edits must not overlap with the main [edit](#ColorPresentation.textEdit) nor with themselves.
+        # An optional array of additional [text edits](#TextEdit) that are applied
+        # when selecting this color presentation. Edits must not overlap with the
+        # main [edit](#ColorPresentation.textEdit) nor with themselves.
         #
         # @return [TextEdit[]]
         def additional_text_edits

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

@@ -1,10 +1,11 @@
 module LanguageServer
   module Protocol
     module Interface
-      class ColorPresentationParams
-        def initialize(text_document:, color:, range:)
+      class ColorPresentationParams < PartialResultParams
+        def initialize(partial_result_token: nil, text_document:, color:, range:)
           @attributes = {}
 
+          @attributes[:partialResultToken] = partial_result_token if partial_result_token
           @attributes[:textDocument] = text_document
           @attributes[:color] = color
           @attributes[:range] = range

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

@@ -0,0 +1,59 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class CompletionClientCapabilities
+        def initialize(dynamic_registration: nil, completion_item: nil, completion_item_kind: nil, context_support: 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.freeze
+        end
+
+        #
+        # Whether completion supports dynamic registration.
+        #
+        # @return [boolean]
+        def dynamic_registration
+          attributes.fetch(:dynamicRegistration)
+        end
+
+        #
+        # 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?: { ...; }; }]
+        def completion_item
+          attributes.fetch(:completionItem)
+        end
+
+        # @return [{ valueSet?: any[]; }]
+        def completion_item_kind
+          attributes.fetch(:completionItemKind)
+        end
+
+        #
+        # The client supports to send additional context information for a
+        # `textDocument/completion` request.
+        #
+        # @return [boolean]
+        def context_support
+          attributes.fetch(:contextSupport)
+        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_context.rb

@@ -2,7 +2,8 @@ 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)
@@ -23,8 +24,9 @@ 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

@@ -2,11 +2,12 @@ module LanguageServer
   module Protocol
     module Interface
       class CompletionItem
-        def initialize(label:, kind: nil, detail: nil, documentation: nil, deprecated: nil, preselect: nil, sort_text: nil, filter_text: nil, insert_text: nil, insert_text_format: nil, text_edit: nil, additional_text_edits: nil, commit_characters: nil, command: nil, data: nil)
+        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)
           @attributes = {}
 
           @attributes[:label] = label
           @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
@@ -15,6 +16,7 @@ module LanguageServer
           @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[:additionalTextEdits] = additional_text_edits if additional_text_edits
           @attributes[:commitCharacters] = commit_characters if commit_characters
@@ -36,13 +38,22 @@ module LanguageServer
 
         #
         # The kind of this completion item. Based of the kind
-        # an icon is chosen by the editor.
+        # an icon is chosen by the editor. The standardized set
+        # of available values is defined in `CompletionItemKind`.
         #
-        # @return [number]
+        # @return [any]
         def kind
           attributes.fetch(:kind)
         end
 
+        #
+        # Tags for this completion item.
+        #
+        # @return [1[]]
+        def tags
+          attributes.fetch(:tags)
+        end
+
         #
         # A human-readable string with additional information
         # about this item, like type or symbol information.
@@ -82,7 +93,8 @@ module LanguageServer
 
         #
         # A string that should be used when comparing this item
-        # with other items. When `falsy` the label is used.
+        # with other items. When `falsy` the label is used
+        # as the sort text for this item.
         #
         # @return [string]
         def sort_text
@@ -91,7 +103,8 @@ module LanguageServer
 
         #
         # A string that should be used when filtering a set of
-        # completion items. When `falsy` the label is used.
+        # completion items. When `falsy` the label is used as the
+        # filter text for this item.
         #
         # @return [string]
         def filter_text
@@ -100,14 +113,16 @@ module LanguageServer
 
         #
         # A string that should be inserted into a document when selecting
-        # this completion. When `falsy` the label is used.
+        # this completion. When `falsy` the label is used as the insert text
+        # for this item.
         #
         # The `insertText` is subject to interpretation by the client side.
         # Some tools might not take the string literally. For example
-        # VS Code when code complete is requested in this example `con<cursor position>`
-        # and a completion item with an `insertText` of `console` is provided it
-        # will only insert `sole`. Therefore it is recommended to use `textEdit` instead
-        # since it avoids additional client side interpretation.
+        # VS Code when code complete is requested in this example
+        # `con<cursor position>` and a completion item with an `insertText` of
+        # `console` is provided it will only insert `sole`. Therefore it is
+        # recommended to use `textEdit` instead since it avoids additional client
+        # side interpretation.
         #
         # @return [string]
         def insert_text
@@ -115,8 +130,9 @@ module LanguageServer
         end
 
         #
-        # The format of the insert text. The format applies to both the `insertText` property
-        # and the `newText` property of a provided `textEdit`.
+        # The format of the insert text. The format applies to both the
+        # `insertText` property and the `newText` property of a provided
+        # `textEdit`. If omitted defaults to `InsertTextFormat.PlainText`.
         #
         # @return [InsertTextFormat]
         def insert_text_format
@@ -124,25 +140,50 @@ module LanguageServer
         end
 
         #
-        # An edit which is applied to a document when selecting this completion. When an edit is provided the value of
-        # `insertText` is ignored.
+        # How whitespace and indentation is handled during completion
+        # item insertion. If not provided the client's default value depends on
+        # the `textDocument.completion.insertTextMode` client capability.
+        #
+        # @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.
+        #
+        # 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 `InsertReplaceEdits` via the
+        # `textDocument.completion.insertReplaceSupport` client capability
+        # property.
         #
-        # *Note:* The range of the edit must be a single line range and it must contain the position at which completion
-        # has been requested.
+        # *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
+        # at which completion has been requested.
+        # *Note 2:* If an `InsertReplaceEdit` is returned the edit's insert range
+        # must be a prefix of the edit's replace range, that means it must be
+        # contained and starting at the same position.
         #
-        # @return [TextEdit]
+        # @return [TextEdit | InsertReplaceEdit]
         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.
+        # selecting this completion. Edits must not overlap (including the same
+        # insert position) with the main 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
@@ -150,9 +191,10 @@ 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
@@ -160,9 +202,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 command that is executed *after* inserting this completion.
+        # *Note* that additional modifications to the current document should be
+        # described with the additionalTextEdits-property.
         #
         # @return [Command]
         def command
@@ -170,7 +212,7 @@ module LanguageServer
         end
 
         #
-        # An data entry field that is preserved on a completion item between
+        # A data entry field that is preserved on a completion item between
         # a completion and a completion resolve request.
         #
         # @return [any]