language_server-protocol 3.17.0.6 → 3.18.0.0.pre.1

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

@@ -0,0 +1,71 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # @since 3.18.0
+      #
+      class ClientSignatureInformationOptions
+        def initialize(documentation_format: nil, parameter_information: nil, active_parameter_support: nil, no_active_parameter_support: nil)
+          @attributes = {}
+
+          @attributes[:documentationFormat] = documentation_format unless documentation_format.nil?
+          @attributes[:parameterInformation] = parameter_information unless parameter_information.nil?
+          @attributes[:activeParameterSupport] = active_parameter_support unless active_parameter_support.nil?
+          @attributes[:noActiveParameterSupport] = no_active_parameter_support unless no_active_parameter_support.nil?
+
+          @attributes.freeze
+        end
+
+        #
+        # Client supports the following content formats for the documentation
+        # property. The order describes the preferred format of the client.
+        #
+        # @return [MarkupKind[]]
+        def documentation_format
+          attributes.fetch(:documentationFormat)
+        end
+
+        #
+        # Client capabilities specific to parameter information.
+        #
+        # @return [ClientSignatureParameterInformationOptions]
+        def parameter_information
+          attributes.fetch(:parameterInformation)
+        end
+
+        #
+        # The client supports the `activeParameter` property on `SignatureInformation`
+        # literal.
+        #
+        # @since 3.16.0
+        #
+        # @return [boolean]
+        def active_parameter_support
+          attributes.fetch(:activeParameterSupport)
+        end
+
+        #
+        # The client supports the `activeParameter` property on
+        # `SignatureHelp`/`SignatureInformation` being set to `null` to
+        # indicate that no parameter should be active.
+        #
+        # @since 3.18.0
+        #
+        # @return [boolean]
+        def no_active_parameter_support
+          attributes.fetch(:noActiveParameterSupport)
+        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/client_signature_parameter_information_options.rb

@@ -0,0 +1,39 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # @since 3.18.0
+      #
+      class ClientSignatureParameterInformationOptions
+        def initialize(label_offset_support: nil)
+          @attributes = {}
+
+          @attributes[:labelOffsetSupport] = label_offset_support unless label_offset_support.nil?
+
+          @attributes.freeze
+        end
+
+        #
+        # The client supports processing label offsets instead of a
+        # simple label string.
+        #
+        # @since 3.14.0
+        #
+        # @return [boolean]
+        def label_offset_support
+          attributes.fetch(:labelOffsetSupport)
+        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/client_symbol_kind_options.rb

@@ -0,0 +1,43 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # @since 3.18.0
+      #
+      class ClientSymbolKindOptions
+        def initialize(value_set: nil)
+          @attributes = {}
+
+          @attributes[:valueSet] = value_set unless value_set.nil?
+
+          @attributes.freeze
+        end
+
+        #
+        # The symbol kind values the client supports. When this
+        # property exists the client also guarantees that it will
+        # handle values outside its set gracefully and falls back
+        # to a default value when unknown.
+        #
+        # If this property is not present the client only supports
+        # the symbol kinds from `File` to `Array` as defined in
+        # the initial version of the protocol.
+        #
+        # @return [SymbolKind[]]
+        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/client_symbol_resolve_options.rb

@@ -0,0 +1,37 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # @since 3.18.0
+      #
+      class ClientSymbolResolveOptions
+        def initialize(properties:)
+          @attributes = {}
+
+          @attributes[:properties] = properties
+
+          @attributes.freeze
+        end
+
+        #
+        # The properties that a client can resolve lazily. Usually
+        # `location.range`
+        #
+        # @return [string[]]
+        def properties
+          attributes.fetch(:properties)
+        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/client_symbol_tag_options.rb

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

@@ -8,17 +8,18 @@ module LanguageServer
       # A CodeAction must set either `edit` and/or a `command`. If both are supplied, the `edit` is applied first, then the `command` is executed.
       #
       class CodeAction
-        def initialize(title:, kind: nil, diagnostics: nil, is_preferred: nil, disabled: nil, edit: nil, command: nil, data: nil)
+        def initialize(title:, kind: nil, diagnostics: nil, is_preferred: nil, disabled: nil, edit: nil, command: nil, data: nil, tags: nil)
           @attributes = {}
 
           @attributes[:title] = title
-          @attributes[:kind] = kind if kind
-          @attributes[:diagnostics] = diagnostics if diagnostics
-          @attributes[:isPreferred] = is_preferred if is_preferred
-          @attributes[:disabled] = disabled if disabled
-          @attributes[:edit] = edit if edit
-          @attributes[:command] = command if command
-          @attributes[:data] = data if data
+          @attributes[:kind] = kind unless kind.nil?
+          @attributes[:diagnostics] = diagnostics unless diagnostics.nil?
+          @attributes[:isPreferred] = is_preferred unless is_preferred.nil?
+          @attributes[:disabled] = disabled unless disabled.nil?
+          @attributes[:edit] = edit unless edit.nil?
+          @attributes[:command] = command unless command.nil?
+          @attributes[:data] = data unless data.nil?
+          @attributes[:tags] = tags unless tags.nil?
 
           @attributes.freeze
         end
@@ -80,7 +81,7 @@ module LanguageServer
         #
         # @since 3.16.0
         #
-        # @return [{ reason: string; }]
+        # @return [CodeActionDisabled]
         def disabled
           attributes.fetch(:disabled)
         end
@@ -114,6 +115,16 @@ module LanguageServer
           attributes.fetch(:data)
         end
 
+        #
+        # Tags for this code action.
+        #
+        # @since 3.18.0
+        #
+        # @return [CodeActionTag[]]
+        def tags
+          attributes.fetch(:tags)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -5,16 +5,18 @@ module LanguageServer
       # The Client Capabilities of a {@link CodeActionRequest}.
       #
       class CodeActionClientCapabilities
-        def initialize(dynamic_registration: nil, code_action_literal_support: nil, is_preferred_support: nil, disabled_support: nil, data_support: nil, resolve_support: nil, honors_change_annotations: nil)
+        def initialize(dynamic_registration: nil, code_action_literal_support: nil, is_preferred_support: nil, disabled_support: nil, data_support: nil, resolve_support: nil, honors_change_annotations: nil, documentation_support: nil, tag_support: nil)
           @attributes = {}
 
-          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
-          @attributes[:codeActionLiteralSupport] = code_action_literal_support if code_action_literal_support
-          @attributes[:isPreferredSupport] = is_preferred_support if is_preferred_support
-          @attributes[:disabledSupport] = disabled_support if disabled_support
-          @attributes[:dataSupport] = data_support if data_support
-          @attributes[:resolveSupport] = resolve_support if resolve_support
-          @attributes[:honorsChangeAnnotations] = honors_change_annotations if honors_change_annotations
+          @attributes[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
+          @attributes[:codeActionLiteralSupport] = code_action_literal_support unless code_action_literal_support.nil?
+          @attributes[:isPreferredSupport] = is_preferred_support unless is_preferred_support.nil?
+          @attributes[:disabledSupport] = disabled_support unless disabled_support.nil?
+          @attributes[:dataSupport] = data_support unless data_support.nil?
+          @attributes[:resolveSupport] = resolve_support unless resolve_support.nil?
+          @attributes[:honorsChangeAnnotations] = honors_change_annotations unless honors_change_annotations.nil?
+          @attributes[:documentationSupport] = documentation_support unless documentation_support.nil?
+          @attributes[:tagSupport] = tag_support unless tag_support.nil?
 
           @attributes.freeze
         end
@@ -34,7 +36,7 @@ module LanguageServer
         #
         # @since 3.8.0
         #
-        # @return [{ codeActionKind: { valueSet: CodeActionKind[]; }; }]
+        # @return [ClientCodeActionLiteralOptions]
         def code_action_literal_support
           attributes.fetch(:codeActionLiteralSupport)
         end
@@ -77,7 +79,7 @@ module LanguageServer
         #
         # @since 3.16.0
         #
-        # @return [{ properties: string[]; }]
+        # @return [ClientCodeActionResolveOptions]
         def resolve_support
           attributes.fetch(:resolveSupport)
         end
@@ -96,6 +98,28 @@ module LanguageServer
           attributes.fetch(:honorsChangeAnnotations)
         end
 
+        #
+        # Whether the client supports documentation for a class of
+        # code actions.
+        #
+        # @since 3.18.0
+        #
+        # @return [boolean]
+        def documentation_support
+          attributes.fetch(:documentationSupport)
+        end
+
+        #
+        # Client supports the tag property on a code action. Clients
+        # supporting tags have to handle unknown tags gracefully.
+        #
+        # @since 3.18.0
+        #
+        # @return [CodeActionTagOptions]
+        def tag_support
+          attributes.fetch(:tagSupport)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -10,8 +10,8 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:diagnostics] = diagnostics
-          @attributes[:only] = only if only
-          @attributes[:triggerKind] = trigger_kind if trigger_kind
+          @attributes[:only] = only unless only.nil?
+          @attributes[:triggerKind] = trigger_kind unless trigger_kind.nil?
 
           @attributes.freeze
         end

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

@@ -0,0 +1,40 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Captures why the code action is currently disabled.
+      #
+      # @since 3.18.0
+      #
+      class CodeActionDisabled
+        def initialize(reason:)
+          @attributes = {}
+
+          @attributes[:reason] = reason
+
+          @attributes.freeze
+        end
+
+        #
+        # Human readable description of why the code action is currently disabled.
+        #
+        # This is displayed in the code actions UI.
+        #
+        # @return [string]
+        def reason
+          attributes.fetch(:reason)
+        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_action_kind_documentation.rb

@@ -0,0 +1,53 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Documentation for a class of code actions.
+      #
+      # @since 3.18.0
+      #
+      class CodeActionKindDocumentation
+        def initialize(kind:, command:)
+          @attributes = {}
+
+          @attributes[:kind] = kind
+          @attributes[:command] = command
+
+          @attributes.freeze
+        end
+
+        #
+        # The kind of the code action being documented.
+        #
+        # If the kind is generic, such as `CodeActionKind.Refactor`, the documentation will be shown whenever any
+        # refactorings are returned. If the kind if more specific, such as `CodeActionKind.RefactorExtract`, the
+        # documentation will only be shown when extract refactoring code actions are returned.
+        #
+        # @return [CodeActionKind]
+        def kind
+          attributes.fetch(:kind)
+        end
+
+        #
+        # Command that is ued to display the documentation to the user.
+        #
+        # The title of this documentation code action is taken from {@linkcode Command.title}
+        #
+        # @return [Command]
+        def command
+          attributes.fetch(:command)
+        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_action_options.rb

@@ -5,12 +5,13 @@ module LanguageServer
       # Provider options for a {@link CodeActionRequest}.
       #
       class CodeActionOptions
-        def initialize(code_action_kinds: nil, resolve_provider: nil, work_done_progress: nil)
+        def initialize(code_action_kinds: nil, documentation: nil, resolve_provider: nil, work_done_progress: nil)
           @attributes = {}
 
-          @attributes[:codeActionKinds] = code_action_kinds if code_action_kinds
-          @attributes[:resolveProvider] = resolve_provider if resolve_provider
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @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
@@ -26,6 +27,27 @@ module LanguageServer
           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.

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

@@ -11,8 +11,8 @@ module LanguageServer
           @attributes[:textDocument] = text_document
           @attributes[:range] = range
           @attributes[:context] = context
-          @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/code_action_registration_options.rb

@@ -5,13 +5,14 @@ module LanguageServer
       # Registration options for a {@link CodeActionRequest}.
       #
       class CodeActionRegistrationOptions
-        def initialize(document_selector:, code_action_kinds: nil, resolve_provider: nil, work_done_progress: nil)
+        def initialize(document_selector:, code_action_kinds: nil, documentation: nil, resolve_provider: nil, work_done_progress: nil)
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @attributes[:codeActionKinds] = code_action_kinds if code_action_kinds
-          @attributes[:resolveProvider] = resolve_provider if resolve_provider
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @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
@@ -36,6 +37,27 @@ module LanguageServer
           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.

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_lens.rb

@@ -13,8 +13,8 @@ module LanguageServer
           @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
@@ -37,8 +37,7 @@ module LanguageServer
 
         #
         # A data entry field that is preserved on a code lens item between
-        # a {@link CodeLensRequest} and a [CodeLensResolveRequest]
-        # (#CodeLensResolveRequest)
+        # a {@link CodeLensRequest} and a {@link CodeLensResolveRequest}
         #
         # @return [LSPAny]
         def data

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

@@ -5,10 +5,11 @@ module LanguageServer
       # 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
@@ -21,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

@@ -8,8 +8,8 @@ module LanguageServer
         def initialize(resolve_provider: nil, work_done_progress: nil)
           @attributes = {}
 
-          @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_params.rb

@@ -9,8 +9,8 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:textDocument] = text_document
-          @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