language_server-protocol 3.17.0.6 → 3.18.0.0.pre.1

data/lib/language_server/protocol/constant/position_encoding_kind.rb

@@ -2,30 +2,30 @@ module LanguageServer
   module Protocol
     module Constant
       #
-      # A type indicating how positions are encoded,
-      # specifically what column offsets mean.
       # A set of predefined position encoding kinds.
       #
+      # @since 3.17.0
+      #
       module PositionEncodingKind
         #
-        # Character offsets count UTF-8 code units (e.g bytes).
+        # Character offsets count UTF-8 code units (e.g. bytes).
         #
-        UTF8 = 'utf-8'
+        UTF8 = "utf-8"
         #
         # Character offsets count UTF-16 code units.
         #
         # This is the default and must always be supported
         # by servers
         #
-        UTF16 = 'utf-16'
+        UTF16 = "utf-16"
         #
         # Character offsets count UTF-32 code units.
         #
-        # Implementation note: these are the same as Unicode code points,
+        # Implementation note: these are the same as Unicode codepoints,
         # so this `PositionEncodingKind` may also be used for an
         # encoding-agnostic representation of character offsets.
         #
-        UTF32 = 'utf-32'
+        UTF32 = "utf-32"
       end
     end
   end

data/lib/language_server/protocol/constant/prepare_support_default_behavior.rb

@@ -4,7 +4,7 @@ module LanguageServer
       module PrepareSupportDefaultBehavior
         #
         # The client's default behavior is to select the identifier
-        # according to the language's syntax rule.
+        # according the to language's syntax rule.
         #
         IDENTIFIER = 1
       end

data/lib/language_server/protocol/constant/resource_operation_kind.rb

@@ -1,22 +1,19 @@
 module LanguageServer
   module Protocol
     module Constant
-      #
-      # The kind of resource operations supported by the client.
-      #
       module ResourceOperationKind
         #
         # Supports creating new files and folders.
         #
-        CREATE = 'create'
+        CREATE = "create"
         #
         # Supports renaming existing files and folders.
         #
-        RENAME = 'rename'
+        RENAME = "rename"
         #
         # Supports deleting existing files and folders.
         #
-        DELETE = 'delete'
+        DELETE = "delete"
       end
     end
   end

data/lib/language_server/protocol/constant/semantic_token_modifiers.rb

@@ -1,17 +1,24 @@
 module LanguageServer
   module Protocol
     module Constant
+      #
+      # A set of predefined token modifiers. This set is not fixed
+      # an clients can specify additional token types via the
+      # corresponding client capabilities.
+      #
+      # @since 3.16.0
+      #
       module SemanticTokenModifiers
-        DECLARATION = 'declaration'
-        DEFINITION = 'definition'
-        READONLY = 'readonly'
-        STATIC = 'static'
-        DEPRECATED = 'deprecated'
-        ABSTRACT = 'abstract'
-        ASYNC = 'async'
-        MODIFICATION = 'modification'
-        DOCUMENTATION = 'documentation'
-        DEFAULT_LIBRARY = 'defaultLibrary'
+        DECLARATION = "declaration"
+        DEFINITION = "definition"
+        READONLY = "readonly"
+        STATIC = "static"
+        DEPRECATED = "deprecated"
+        ABSTRACT = "abstract"
+        ASYNC = "async"
+        MODIFICATION = "modification"
+        DOCUMENTATION = "documentation"
+        DEFAULT_LIBRARY = "defaultLibrary"
       end
     end
   end

data/lib/language_server/protocol/constant/semantic_token_types.rb

@@ -1,34 +1,48 @@
 module LanguageServer
   module Protocol
     module Constant
+      #
+      # A set of predefined token types. This set is not fixed
+      # an clients can specify additional token types via the
+      # corresponding client capabilities.
+      #
+      # @since 3.16.0
+      #
       module SemanticTokenTypes
-        NAMESPACE = 'namespace'
+        NAMESPACE = "namespace"
         #
-        # Represents a generic type. Acts as a fallback for types which
-        # can't be mapped to a specific type like class or enum.
+        # Represents a generic type. Acts as a fallback for types which can't be mapped to
+        # a specific type like class or enum.
         #
-        TYPE = 'type'
-        CLASS = 'class'
-        ENUM = 'enum'
-        INTERFACE = 'interface'
-        STRUCT = 'struct'
-        TYPE_PARAMETER = 'typeParameter'
-        PARAMETER = 'parameter'
-        VARIABLE = 'variable'
-        PROPERTY = 'property'
-        ENUM_MEMBER = 'enumMember'
-        EVENT = 'event'
-        FUNCTION = 'function'
-        METHOD = 'method'
-        MACRO = 'macro'
-        KEYWORD = 'keyword'
-        MODIFIER = 'modifier'
-        COMMENT = 'comment'
-        STRING = 'string'
-        NUMBER = 'number'
-        REGEXP = 'regexp'
-        OPERATOR = 'operator'
-        DECORATOR = 'decorator'
+        TYPE = "type"
+        CLASS = "class"
+        ENUM = "enum"
+        INTERFACE = "interface"
+        STRUCT = "struct"
+        TYPE_PARAMETER = "typeParameter"
+        PARAMETER = "parameter"
+        VARIABLE = "variable"
+        PROPERTY = "property"
+        ENUM_MEMBER = "enumMember"
+        EVENT = "event"
+        FUNCTION = "function"
+        METHOD = "method"
+        MACRO = "macro"
+        KEYWORD = "keyword"
+        MODIFIER = "modifier"
+        COMMENT = "comment"
+        STRING = "string"
+        NUMBER = "number"
+        REGEXP = "regexp"
+        OPERATOR = "operator"
+        #
+        # @since 3.17.0
+        #
+        DECORATOR = "decorator"
+        #
+        # @since 3.18.0
+        #
+        LABEL = "label"
       end
     end
   end

data/lib/language_server/protocol/constant/signature_help_trigger_kind.rb

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # How a signature help was triggered.
       #
+      # @since 3.15.0
+      #
       module SignatureHelpTriggerKind
         #
         # Signature help was invoked manually by the user or by a command.
@@ -14,8 +16,7 @@ module LanguageServer
         #
         TRIGGER_CHARACTER = 2
         #
-        # Signature help was triggered by the cursor moving or by the document
-        # content changing.
+        # Signature help was triggered by the cursor moving or by the document content changing.
         #
         CONTENT_CHANGE = 3
       end

data/lib/language_server/protocol/constant/symbol_tag.rb

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # Symbol tags are extra annotations that tweak the rendering of a symbol.
       #
+      # @since 3.16
+      #
       module SymbolTag
         #
         # Render a symbol as obsolete, usually using a strike-out.

data/lib/language_server/protocol/constant/text_document_save_reason.rb

@@ -6,8 +6,8 @@ module LanguageServer
       #
       module TextDocumentSaveReason
         #
-        # Manually triggered, e.g. by the user pressing save, by starting
-        # debugging, or by an API call.
+        # Manually triggered, e.g. by the user pressing save, by starting debugging,
+        # or by an API call.
         #
         MANUAL = 1
         #

data/lib/language_server/protocol/constant/text_document_sync_kind.rb

@@ -2,8 +2,8 @@ module LanguageServer
   module Protocol
     module Constant
       #
-      # Defines how the host (editor) should sync document changes to the language
-      # server.
+      # Defines how the host (editor) should sync
+      # document changes to the language server.
       #
       module TextDocumentSyncKind
         #
@@ -18,7 +18,7 @@ module LanguageServer
         #
         # Documents are synced by sending the full content on open.
         # After that only incremental updates to the document are
-        # sent.
+        # send.
         #
         INCREMENTAL = 2
       end

data/lib/language_server/protocol/constant/token_format.rb

@@ -2,7 +2,7 @@ module LanguageServer
   module Protocol
     module Constant
       module TokenFormat
-        RELATIVE = 'relative'
+        RELATIVE = "relative"
       end
     end
   end

data/lib/language_server/protocol/constant/{trace_values.rb → trace_value.rb}

@@ -1,7 +1,7 @@
 module LanguageServer
   module Protocol
     module Constant
-      module TraceValues
+      module TraceValue
         #
         # Turn tracing off.
         #

data/lib/language_server/protocol/constant/uniqueness_level.rb

@@ -4,27 +4,29 @@ module LanguageServer
       #
       # Moniker uniqueness level to define scope of the moniker.
       #
+      # @since 3.16.0
+      #
       module UniquenessLevel
         #
         # The moniker is only unique inside a document
         #
-        DOCUMENT = 'document'
+        DOCUMENT = "document"
         #
         # The moniker is unique inside a project for which a dump got created
         #
-        PROJECT = 'project'
+        PROJECT = "project"
         #
         # The moniker is unique inside the group to which a project belongs
         #
-        GROUP = 'group'
+        GROUP = "group"
         #
         # The moniker is unique inside the moniker scheme.
         #
-        SCHEME = 'scheme'
+        SCHEME = "scheme"
         #
         # The moniker is globally unique
         #
-        GLOBAL = 'global'
+        GLOBAL = "global"
       end
     end
   end

data/lib/language_server/protocol/constant.rb

@@ -1,7 +1,9 @@
 module LanguageServer
   module Protocol
     module Constant
+      autoload :ApplyKind, "language_server/protocol/constant/apply_kind"
       autoload :CodeActionKind, "language_server/protocol/constant/code_action_kind"
+      autoload :CodeActionTag, "language_server/protocol/constant/code_action_tag"
       autoload :CodeActionTriggerKind, "language_server/protocol/constant/code_action_trigger_kind"
       autoload :CompletionItemKind, "language_server/protocol/constant/completion_item_kind"
       autoload :CompletionItemTag, "language_server/protocol/constant/completion_item_tag"
@@ -15,11 +17,12 @@ module LanguageServer
       autoload :FileChangeType, "language_server/protocol/constant/file_change_type"
       autoload :FileOperationPatternKind, "language_server/protocol/constant/file_operation_pattern_kind"
       autoload :FoldingRangeKind, "language_server/protocol/constant/folding_range_kind"
-      autoload :InitializeErrorCodes, "language_server/protocol/constant/initialize_error_codes"
       autoload :InlayHintKind, "language_server/protocol/constant/inlay_hint_kind"
+      autoload :InlineCompletionTriggerKind, "language_server/protocol/constant/inline_completion_trigger_kind"
       autoload :InsertTextFormat, "language_server/protocol/constant/insert_text_format"
       autoload :InsertTextMode, "language_server/protocol/constant/insert_text_mode"
       autoload :LSPErrorCodes, "language_server/protocol/constant/lsp_error_codes"
+      autoload :LanguageKind, "language_server/protocol/constant/language_kind"
       autoload :MarkupKind, "language_server/protocol/constant/markup_kind"
       autoload :MessageType, "language_server/protocol/constant/message_type"
       autoload :MonikerKind, "language_server/protocol/constant/moniker_kind"
@@ -35,11 +38,13 @@ module LanguageServer
       autoload :TextDocumentSaveReason, "language_server/protocol/constant/text_document_save_reason"
       autoload :TextDocumentSyncKind, "language_server/protocol/constant/text_document_sync_kind"
       autoload :TokenFormat, "language_server/protocol/constant/token_format"
-      autoload :TraceValues, "language_server/protocol/constant/trace_values"
+      autoload :TraceValue, "language_server/protocol/constant/trace_value"
       autoload :UniquenessLevel, "language_server/protocol/constant/uniqueness_level"
       autoload :WatchKind, "language_server/protocol/constant/watch_kind"
 
+      require_relative "constant/apply_kind"
       require_relative "constant/code_action_kind"
+      require_relative "constant/code_action_tag"
       require_relative "constant/code_action_trigger_kind"
       require_relative "constant/completion_item_kind"
       require_relative "constant/completion_item_tag"
@@ -53,11 +58,12 @@ module LanguageServer
       require_relative "constant/file_change_type"
       require_relative "constant/file_operation_pattern_kind"
       require_relative "constant/folding_range_kind"
-      require_relative "constant/initialize_error_codes"
       require_relative "constant/inlay_hint_kind"
+      require_relative "constant/inline_completion_trigger_kind"
       require_relative "constant/insert_text_format"
       require_relative "constant/insert_text_mode"
       require_relative "constant/lsp_error_codes"
+      require_relative "constant/language_kind"
       require_relative "constant/markup_kind"
       require_relative "constant/message_type"
       require_relative "constant/moniker_kind"
@@ -73,7 +79,7 @@ module LanguageServer
       require_relative "constant/text_document_save_reason"
       require_relative "constant/text_document_sync_kind"
       require_relative "constant/token_format"
-      require_relative "constant/trace_values"
+      require_relative "constant/trace_value"
       require_relative "constant/uniqueness_level"
       require_relative "constant/watch_kind"
     end

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

@@ -5,11 +5,12 @@ module LanguageServer
       # The parameters passed via an apply workspace edit request.
       #
       class ApplyWorkspaceEditParams
-        def initialize(label: nil, edit:)
+        def initialize(label: nil, edit:, metadata: nil)
           @attributes = {}
 
-          @attributes[:label] = label if label
+          @attributes[:label] = label unless label.nil?
           @attributes[:edit] = edit
+          @attributes[:metadata] = metadata unless metadata.nil?
 
           @attributes.freeze
         end
@@ -32,6 +33,16 @@ module LanguageServer
           attributes.fetch(:edit)
         end
 
+        #
+        # Additional data about the edit.
+        #
+        # @since 3.18.0
+        #
+        # @return [WorkspaceEditMetadata]
+        def metadata
+          attributes.fetch(:metadata)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -11,8 +11,8 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:applied] = applied
-          @attributes[:failureReason] = failure_reason if failure_reason
-          @attributes[:failedChange] = failed_change if failed_change
+          @attributes[:failureReason] = failure_reason unless failure_reason.nil?
+          @attributes[:failedChange] = failed_change unless failed_change.nil?
 
           @attributes.freeze
         end

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

@@ -10,8 +10,8 @@ module LanguageServer
 
           @attributes[:name] = name
           @attributes[:kind] = kind
-          @attributes[:tags] = tags if tags
-          @attributes[:containerName] = container_name if container_name
+          @attributes[:tags] = tags unless tags.nil?
+          @attributes[:containerName] = container_name unless container_name.nil?
 
           @attributes.freeze
         end

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

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

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

@@ -11,8 +11,8 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:item] = item
-          @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/call_hierarchy_item.rb

@@ -13,12 +13,12 @@ module LanguageServer
 
           @attributes[:name] = name
           @attributes[:kind] = kind
-          @attributes[:tags] = tags if tags
-          @attributes[:detail] = detail if detail
+          @attributes[:tags] = tags unless tags.nil?
+          @attributes[:detail] = detail unless detail.nil?
           @attributes[:uri] = uri
           @attributes[:range] = range
           @attributes[:selectionRange] = selection_range
-          @attributes[:data] = data if data
+          @attributes[:data] = data unless data.nil?
 
           @attributes.freeze
         end

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

@@ -10,7 +10,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/call_hierarchy_outgoing_calls_params.rb

@@ -11,8 +11,8 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:item] = item
-          @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/call_hierarchy_prepare_params.rb

@@ -12,7 +12,7 @@ module LanguageServer
 
           @attributes[:textDocument] = text_document
           @attributes[:position] = position
-          @attributes[:workDoneToken] = work_done_token if work_done_token
+          @attributes[:workDoneToken] = work_done_token unless work_done_token.nil?
 
           @attributes.freeze
         end

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

@@ -11,8 +11,8 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
-          @attributes[:id] = id if id
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
+          @attributes[:id] = id unless id.nil?
 
           @attributes.freeze
         end

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

@@ -11,8 +11,8 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:label] = label
-          @attributes[:needsConfirmation] = needs_confirmation if needs_confirmation
-          @attributes[:description] = description if description
+          @attributes[:needsConfirmation] = needs_confirmation unless needs_confirmation.nil?
+          @attributes[:description] = description unless description.nil?
 
           @attributes.freeze
         end

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

@@ -0,0 +1,38 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # @since 3.18.0
+      #
+      class ChangeAnnotationsSupportOptions
+        def initialize(groups_on_label: nil)
+          @attributes = {}
+
+          @attributes[:groupsOnLabel] = groups_on_label unless groups_on_label.nil?
+
+          @attributes.freeze
+        end
+
+        #
+        # Whether the client groups edits with equal labels into tree nodes,
+        # for instance all edits labelled with "Changes in Strings" would
+        # be a tree node.
+        #
+        # @return [boolean]
+        def groups_on_label
+          attributes.fetch(:groupsOnLabel)
+        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_capabilities.rb

@@ -8,12 +8,12 @@ module LanguageServer
         def initialize(workspace: nil, text_document: nil, notebook_document: nil, window: nil, general: nil, experimental: nil)
           @attributes = {}
 
-          @attributes[:workspace] = workspace if workspace
-          @attributes[:textDocument] = text_document if text_document
-          @attributes[:notebookDocument] = notebook_document if notebook_document
-          @attributes[:window] = window if window
-          @attributes[:general] = general if general
-          @attributes[:experimental] = experimental if experimental
+          @attributes[:workspace] = workspace unless workspace.nil?
+          @attributes[:textDocument] = text_document unless text_document.nil?
+          @attributes[:notebookDocument] = notebook_document unless notebook_document.nil?
+          @attributes[:window] = window unless window.nil?
+          @attributes[:general] = general unless general.nil?
+          @attributes[:experimental] = experimental unless experimental.nil?
 
           @attributes.freeze
         end

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

@@ -0,0 +1,39 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # @since 3.18.0
+      #
+      class ClientCodeActionKindOptions
+        def initialize(value_set:)
+          @attributes = {}
+
+          @attributes[:valueSet] = value_set
+
+          @attributes.freeze
+        end
+
+        #
+        # The code action 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.
+        #
+        # @return [CodeActionKind[]]
+        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_code_action_literal_options.rb

@@ -0,0 +1,37 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # @since 3.18.0
+      #
+      class ClientCodeActionLiteralOptions
+        def initialize(code_action_kind:)
+          @attributes = {}
+
+          @attributes[:codeActionKind] = code_action_kind
+
+          @attributes.freeze
+        end
+
+        #
+        # The code action kind is support with the following value
+        # set.
+        #
+        # @return [ClientCodeActionKindOptions]
+        def code_action_kind
+          attributes.fetch(:codeActionKind)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end