language_server-protocol 3.17.0.5 → 3.18.0.0.pre.1

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

@@ -1,52 +1,79 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Registration options for a {@link CodeActionRequest}.
+      #
       class CodeActionRegistrationOptions
-        def initialize(document_selector:, work_done_progress: nil, code_action_kinds: nil, resolve_provider: nil)
+        def initialize(document_selector:, code_action_kinds: nil, documentation: nil, resolve_provider: nil, work_done_progress: 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[:codeActionKinds] = code_action_kinds unless code_action_kinds.nil?
+          @attributes[:documentation] = documentation unless documentation.nil?
+          @attributes[:resolveProvider] = resolve_provider unless resolve_provider.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
-
         #
         # 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.
+        # The list of kinds may be generic, such as `CodeActionKind.Refactor`, or the server
+        # may list out every specific kind they provide.
         #
-        # @return [string[]]
+        # @return [CodeActionKind[]]
         def code_action_kinds
           attributes.fetch(:codeActionKinds)
         end
 
+        #
+        # Static documentation for a class of code actions.
+        #
+        # Documentation from the provider should be shown in the code actions menu if either:
+        #
+        # - Code actions of `kind` are requested by the editor. In this case, the editor will show the documentation that
+        #   most closely matches the requested code action kind. For example, if a provider has documentation for
+        #   both `Refactor` and `RefactorExtract`, when the user requests code actions for `RefactorExtract`,
+        #   the editor will use the documentation for `RefactorExtract` instead of the documentation for `Refactor`.
+        #
+        # - Any code actions of `kind` are returned by the provider.
+        #
+        # At most one documentation entry should be shown per provider.
+        #
+        # @since 3.18.0
+        #
+        # @return [CodeActionKindDocumentation[]]
+        def documentation
+          attributes.fetch(:documentation)
+        end
+
         #
         # The server provides support to resolve additional
         # information for a code action.
         #
+        # @since 3.16.0
+        #
         # @return [boolean]
         def resolve_provider
           attributes.fetch(:resolveProvider)
         end
 
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -0,0 +1,36 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # @since 3.18.0
+      #
+      class CodeActionTagOptions
+        def initialize(value_set:)
+          @attributes = {}
+
+          @attributes[:valueSet] = value_set
+
+          @attributes.freeze
+        end
+
+        #
+        # The tags supported by the client.
+        #
+        # @return [CodeActionTag[]]
+        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/code_description.rb

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # Structure to capture a description for an error code.
       #
+      # @since 3.16.0
+      #
       class CodeDescription
         def initialize(href:)
           @attributes = {}
@@ -16,7 +18,7 @@ module LanguageServer
         #
         # An URI to open with more information about the diagnostic error.
         #
-        # @return [string]
+        # @return [URI]
         def href
           attributes.fetch(:href)
         end

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

@@ -2,27 +2,25 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # A code lens represents a command that should be shown along with
+      # A code lens represents a {@link Command 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)
           @attributes = {}
 
           @attributes[:range] = range
-          @attributes[:command] = command if command
-          @attributes[:data] = data if data
+          @attributes[:command] = command unless command.nil?
+          @attributes[:data] = data unless data.nil?
 
           @attributes.freeze
         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
@@ -39,7 +37,7 @@ module LanguageServer
 
         #
         # A data entry field that is preserved on a code lens item between
-        # a code lens and a code lens resolve request.
+        # a {@link CodeLensRequest} and a {@link CodeLensResolveRequest}
         #
         # @return [LSPAny]
         def data

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

@@ -1,11 +1,15 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The client capabilities  of a {@link CodeLensRequest}.
+      #
       class CodeLensClientCapabilities
-        def initialize(dynamic_registration: nil)
+        def initialize(dynamic_registration: nil, resolve_support: nil)
           @attributes = {}
 
-          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+          @attributes[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
+          @attributes[:resolveSupport] = resolve_support unless resolve_support.nil?
 
           @attributes.freeze
         end
@@ -18,6 +22,17 @@ module LanguageServer
           attributes.fetch(:dynamicRegistration)
         end
 
+        #
+        # Whether the client supports resolving additional code lens
+        # properties via a separate `codeLens/resolve` request.
+        #
+        # @since 3.18.0
+        #
+        # @return [ClientCodeLensResolveOptions]
+        def resolve_support
+          attributes.fetch(:resolveSupport)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -1,21 +1,19 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Code Lens provider options of a {@link CodeLensRequest}.
+      #
       class CodeLensOptions
-        def initialize(work_done_progress: nil, resolve_provider: nil)
+        def initialize(resolve_provider: nil, work_done_progress: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
-          @attributes[:resolveProvider] = resolve_provider if resolve_provider
+          @attributes[:resolveProvider] = resolve_provider unless resolve_provider.nil?
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @attributes.freeze
         end
 
-        # @return [boolean]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         #
         # Code lens has a resolve provider as well.
         #
@@ -24,6 +22,11 @@ module LanguageServer
           attributes.fetch(:resolveProvider)
         end
 
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -1,17 +1,28 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The parameters of a {@link CodeLensRequest}.
+      #
       class CodeLensParams
-        def initialize(work_done_token: nil, partial_result_token: nil, text_document:)
+        def initialize(text_document:, work_done_token: nil, partial_result_token: nil)
           @attributes = {}
 
-          @attributes[:workDoneToken] = work_done_token if work_done_token
-          @attributes[:partialResultToken] = partial_result_token if partial_result_token
           @attributes[:textDocument] = text_document
+          @attributes[:workDoneToken] = work_done_token unless work_done_token.nil?
+          @attributes[:partialResultToken] = partial_result_token unless partial_result_token.nil?
 
           @attributes.freeze
         end
 
+        #
+        # The document to request code lens for.
+        #
+        # @return [TextDocumentIdentifier]
+        def text_document
+          attributes.fetch(:textDocument)
+        end
+
         #
         # An optional token that a server can use to report work done progress.
         #
@@ -21,22 +32,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 document to request code lens for.
-        #
-        # @return [TextDocumentIdentifier]
-        def text_document
-          attributes.fetch(:textDocument)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -1,31 +1,29 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Registration options for a {@link CodeLensRequest}.
+      #
       class CodeLensRegistrationOptions
-        def initialize(document_selector:, work_done_progress: nil, resolve_provider: nil)
+        def initialize(document_selector:, resolve_provider: nil, work_done_progress: nil)
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
-          @attributes[:resolveProvider] = resolve_provider if resolve_provider
+          @attributes[:resolveProvider] = resolve_provider unless resolve_provider.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
-
         #
         # Code lens has a resolve provider as well.
         #
@@ -34,6 +32,11 @@ module LanguageServer
           attributes.fetch(:resolveProvider)
         end
 
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -1,11 +1,14 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # @since 3.16.0
+      #
       class CodeLensWorkspaceClientCapabilities
         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.rb

@@ -19,7 +19,7 @@ module LanguageServer
         #
         # The red component of this color in the range [0-1].
         #
-        # @return [number]
+        # @return [decimal]
         def red
           attributes.fetch(:red)
         end
@@ -27,7 +27,7 @@ module LanguageServer
         #
         # The green component of this color in the range [0-1].
         #
-        # @return [number]
+        # @return [decimal]
         def green
           attributes.fetch(:green)
         end
@@ -35,7 +35,7 @@ module LanguageServer
         #
         # The blue component of this color in the range [0-1].
         #
-        # @return [number]
+        # @return [decimal]
         def blue
           attributes.fetch(:blue)
         end
@@ -43,7 +43,7 @@ module LanguageServer
         #
         # The alpha component of this color in the range [0-1].
         #
-        # @return [number]
+        # @return [decimal]
         def alpha
           attributes.fetch(:alpha)
         end

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Represents a color range from a document.
+      #
       class ColorInformation
         def initialize(range:, color:)
           @attributes = {}

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

@@ -6,16 +6,16 @@ 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
 
         #
         # 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
@@ -23,9 +23,9 @@ module LanguageServer
         end
 
         #
-        # An [edit](#TextEdit) which is applied to a document when selecting
-        # this presentation for the color. When omitted the
-        # [label](#ColorPresentation.label) is used.
+        # An {@link TextEdit edit} which is applied to a document when selecting
+        # this presentation for the color.  When `falsy` the {@link ColorPresentation.label label}
+        # is used.
         #
         # @return [TextEdit]
         def text_edit
@@ -33,9 +33,8 @@ 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 {@link TextEdit text edits} that are applied when
+        # selecting this color presentation. Edits must not overlap with the main {@link ColorPresentation.textEdit edit} nor with themselves.
         #
         # @return [TextEdit[]]
         def additional_text_edits

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

@@ -1,36 +1,22 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Parameters for a {@link ColorPresentationRequest}.
+      #
       class ColorPresentationParams
-        def initialize(work_done_token: nil, partial_result_token: nil, text_document:, color:, range:)
+        def initialize(text_document:, color:, range:, work_done_token: nil, partial_result_token: nil)
           @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
+          @attributes[:workDoneToken] = work_done_token unless work_done_token.nil?
+          @attributes[:partialResultToken] = partial_result_token unless partial_result_token.nil?
 
           @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.
         #
@@ -40,7 +26,7 @@ module LanguageServer
         end
 
         #
-        # The color information to request presentations for.
+        # The color to request presentations for.
         #
         # @return [Color]
         def color
@@ -55,6 +41,23 @@ module LanguageServer
           attributes.fetch(:range)
         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
+
         attr_reader :attributes
 
         def to_hash

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

@@ -1,13 +1,20 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Represents a reference to a command. Provides a title which
+      # will be used to represent a command in the UI and, optionally,
+      # an array of arguments which will be passed to the command handler
+      # 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
@@ -20,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.
         #