language_server-protocol 3.14.0.2 → 3.16.0.1

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

@@ -5,9 +5,11 @@ module LanguageServer
       # Params for the CodeActionRequest
       #
       class CodeActionParams
-        def initialize(text_document:, range:, context:)
+        def initialize(work_done_token: nil, partial_result_token: nil, text_document:, range:, context:)
           @attributes = {}
 
+          @attributes[:workDoneToken] = work_done_token if work_done_token
+          @attributes[:partialResultToken] = partial_result_token if partial_result_token
           @attributes[:textDocument] = text_document
           @attributes[:range] = range
           @attributes[:context] = context
@@ -15,6 +17,23 @@ module LanguageServer
           @attributes.freeze
         end
 
+        #
+        # An optional token that a server can use to report work done progress.
+        #
+        # @return [ProgressToken]
+        def work_done_token
+          attributes.fetch(:workDoneToken)
+        end
+
+        #
+        # An optional token that a server can use to report partial results (e.g.
+        # streaming) to the client.
+        #
+        # @return [ProgressToken]
+        def partial_result_token
+          attributes.fetch(:partialResultToken)
+        end
+
         #
         # The document in which the command was invoked.
         #

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

@@ -1,15 +1,52 @@
 module LanguageServer
   module Protocol
     module Interface
-      class CodeActionRegistrationOptions < CodeActionOptions
-        def initialize(code_action_kinds: nil)
+      class CodeActionRegistrationOptions
+        def initialize(document_selector:, work_done_progress: nil, code_action_kinds: nil, resolve_provider: nil)
           @attributes = {}
 
+          @attributes[:documentSelector] = document_selector
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
           @attributes[:codeActionKinds] = code_action_kinds if code_action_kinds
+          @attributes[:resolveProvider] = resolve_provider if resolve_provider
 
           @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.
+        #
+        # @return [DocumentSelector]
+        def document_selector
+          attributes.fetch(:documentSelector)
+        end
+
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
+        #
+        # CodeActionKinds that this server may return.
+        #
+        # The list of kinds may be generic, such as `CodeActionKind.Refactor`,
+        # or the server may list out every specific kind they provide.
+        #
+        # @return [string[]]
+        def code_action_kinds
+          attributes.fetch(:codeActionKinds)
+        end
+
+        #
+        # The server provides support to resolve additional
+        # information for a code action.
+        #
+        # @return [boolean]
+        def resolve_provider
+          attributes.fetch(:resolveProvider)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -0,0 +1,36 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Structure to capture a description for an error code.
+      #
+      class CodeDescription
+        def initialize(href:)
+          @attributes = {}
+
+          @attributes[:href] = href
+
+          @attributes.freeze
+        end
+
+        #
+        # An URI to open with more information about the diagnostic error.
+        #
+        # @return [string]
+        def href
+          attributes.fetch(:href)
+        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.rb

@@ -5,8 +5,9 @@ module LanguageServer
       # A code lens represents a command that should be shown along with
       # source text, like the number of references, a way to run tests, etc.
       #
-      # A code lens is _unresolved_ when no command is associated to it. For performance
-      # reasons the creation of a code lens and resolving should be done in two stages.
+      # A code lens is _unresolved_ when no command is associated to it. For
+      # performance reasons the creation of a code lens and resolving should be done
+      # in two stages.
       #
       class CodeLens
         def initialize(range:, command: nil, data: nil)
@@ -20,7 +21,8 @@ module LanguageServer
         end
 
         #
-        # The range in which this code lens is valid. Should only span a single line.
+        # The range in which this code lens is valid. Should only span a single
+        # line.
         #
         # @return [Range]
         def range

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,18 +1,21 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Code Lens options.
-      #
       class CodeLensOptions
-        def initialize(resolve_provider: nil)
+        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
 
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         #
         # Code lens has a resolve provider as well.
         #

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

@@ -2,14 +2,33 @@ module LanguageServer
   module Protocol
     module Interface
       class CodeLensParams
-        def initialize(text_document:)
+        def initialize(work_done_token: nil, partial_result_token: nil, text_document:)
           @attributes = {}
 
+          @attributes[:workDoneToken] = work_done_token if work_done_token
+          @attributes[:partialResultToken] = partial_result_token if partial_result_token
           @attributes[:textDocument] = text_document
 
           @attributes.freeze
         end
 
+        #
+        # An optional token that a server can use to report work done progress.
+        #
+        # @return [ProgressToken]
+        def work_done_token
+          attributes.fetch(:workDoneToken)
+        end
+
+        #
+        # An optional token that a server can use to report partial results (e.g.
+        # streaming) to the client.
+        #
+        # @return [ProgressToken]
+        def partial_result_token
+          attributes.fetch(:partialResultToken)
+        end
+
         #
         # The document to request code lens for.
         #

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

@@ -1,16 +1,31 @@
 module LanguageServer
   module Protocol
     module Interface
-      class CodeLensRegistrationOptions < TextDocumentRegistrationOptions
-        def initialize(document_selector:, resolve_provider: nil)
+      class CodeLensRegistrationOptions
+        def initialize(document_selector:, work_done_progress: nil, resolve_provider: nil)
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
           @attributes[:resolveProvider] = resolve_provider if resolve_provider
 
           @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.
+        #
+        # @return [DocumentSelector]
+        def document_selector
+          attributes.fetch(:documentSelector)
+        end
+
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         #
         # Code lens has a resolve provider as well.
         #

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

@@ -2,9 +2,11 @@ module LanguageServer
   module Protocol
     module Interface
       class ColorPresentationParams
-        def initialize(text_document:, color:, range:)
+        def initialize(work_done_token: nil, partial_result_token: nil, text_document:, color:, range:)
           @attributes = {}
 
+          @attributes[:workDoneToken] = work_done_token if work_done_token
+          @attributes[:partialResultToken] = partial_result_token if partial_result_token
           @attributes[:textDocument] = text_document
           @attributes[:color] = color
           @attributes[:range] = range
@@ -12,6 +14,23 @@ module LanguageServer
           @attributes.freeze
         end
 
+        #
+        # An optional token that a server can use to report work done progress.
+        #
+        # @return [ProgressToken]
+        def work_done_token
+          attributes.fetch(:workDoneToken)
+        end
+
+        #
+        # An optional token that a server can use to report partial results (e.g.
+        # streaming) to the client.
+        #
+        # @return [ProgressToken]
+        def partial_result_token
+          attributes.fetch(:partialResultToken)
+        end
+
         #
         # The text document.
         #

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