language_server-protocol 3.17.0.5 → 3.18.0.0.pre.1

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

@@ -4,20 +4,22 @@ module LanguageServer
       #
       # The moniker kind.
       #
+      # @since 3.16.0
+      #
       module MonikerKind
         #
         # The moniker represent a symbol that is imported into a project
         #
-        IMPORT = 'import'
+        IMPORT = "import"
         #
         # The moniker represents a symbol that is exported from a project
         #
-        EXPORT = 'export'
+        EXPORT = "export"
         #
         # The moniker represents a symbol that is local to a project (e.g. a local
         # variable of a function, a class not visible outside the project, ...)
         #
-        LOCAL = 'local'
+        LOCAL = "local"
       end
     end
   end

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

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # A notebook cell kind.
       #
+      # @since 3.17.0
+      #
       module NotebookCellKind
         #
         # A markup-cell is formatted source that is used for display.

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

@@ -0,0 +1,20 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      module TraceValue
+        #
+        # Turn tracing off.
+        #
+        OFF = "off"
+        #
+        # Trace messages only.
+        #
+        MESSAGES = "messages"
+        #
+        # Verbose message tracing.
+        #
+        VERBOSE = "verbose"
+      end
+    end
+  end
+end

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,10 +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"
@@ -34,10 +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 :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"
@@ -51,10 +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"
@@ -70,6 +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_value"
       require_relative "constant/uniqueness_level"
       require_relative "constant/watch_kind"
     end

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

@@ -4,17 +4,27 @@ module LanguageServer
       #
       # A special text edit with an additional change annotation.
       #
+      # @since 3.16.0.
+      #
       class AnnotatedTextEdit
-        def initialize(range:, new_text:, annotation_id:)
+        def initialize(annotation_id:, range:, new_text:)
           @attributes = {}
 
+          @attributes[:annotationId] = annotation_id
           @attributes[:range] = range
           @attributes[:newText] = new_text
-          @attributes[:annotationId] = annotation_id
 
           @attributes.freeze
         end
 
+        #
+        # The actual identifier of the change annotation
+        #
+        # @return [ChangeAnnotationIdentifier]
+        def annotation_id
+          attributes.fetch(:annotationId)
+        end
+
         #
         # The range of the text document to be manipulated. To insert
         # text into a document create a range where start === end.
@@ -33,14 +43,6 @@ module LanguageServer
           attributes.fetch(:newText)
         end
 
-        #
-        # The actual annotation identifier.
-        #
-        # @return [string]
-        def annotation_id
-          attributes.fetch(:annotationId)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -1,12 +1,16 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # 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
@@ -29,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

@@ -1,13 +1,18 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The result returned from the apply workspace edit request.
+      #
+      # @since 3.17 renamed from ApplyWorkspaceEditResponse
+      #
       class ApplyWorkspaceEditResult
         def initialize(applied:, failure_reason: nil, failed_change: nil)
           @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
@@ -31,12 +36,11 @@ module LanguageServer
         end
 
         #
-        # Depending on the client's failure handling strategy `failedChange`
-        # might contain the index of the change that failed. This property is
-        # only available if the client signals a `failureHandling` strategy
-        # in its client capabilities.
+        # Depending on the client's failure handling strategy `failedChange` might
+        # contain the index of the change that failed. This property is only available
+        # if the client signals a `failureHandlingStrategy` in its client capabilities.
         #
-        # @return [number]
+        # @return [uinteger]
         def failed_change
           attributes.fetch(:failedChange)
         end

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

@@ -0,0 +1,68 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A base for all symbol information.
+      #
+      class BaseSymbolInformation
+        def initialize(name:, kind:, tags: nil, container_name: nil)
+          @attributes = {}
+
+          @attributes[:name] = name
+          @attributes[:kind] = kind
+          @attributes[:tags] = tags unless tags.nil?
+          @attributes[:containerName] = container_name unless container_name.nil?
+
+          @attributes.freeze
+        end
+
+        #
+        # The name of this symbol.
+        #
+        # @return [string]
+        def name
+          attributes.fetch(:name)
+        end
+
+        #
+        # The kind of this symbol.
+        #
+        # @return [SymbolKind]
+        def kind
+          attributes.fetch(:kind)
+        end
+
+        #
+        # Tags for this symbol.
+        #
+        # @since 3.16.0
+        #
+        # @return [SymbolTag[]]
+        def tags
+          attributes.fetch(:tags)
+        end
+
+        #
+        # The name of the symbol containing this symbol. This information is for
+        # user interface purposes (e.g. to render a qualifier in the user interface
+        # if necessary). It can't be used to re-infer a hierarchy for the document
+        # symbols.
+        #
+        # @return [string]
+        def container_name
+          attributes.fetch(:containerName)
+        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/call_hierarchy_client_capabilities.rb

@@ -1,20 +1,22 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # @since 3.16.0
+      #
       class CallHierarchyClientCapabilities
         def initialize(dynamic_registration: nil)
           @attributes = {}
 
-          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+          @attributes[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
 
           @attributes.freeze
         end
 
         #
-        # Whether implementation supports dynamic registration. If this is set to
-        # `true` the client supports the new `(TextDocumentRegistrationOptions &
-        # StaticRegistrationOptions)` return value for the corresponding server
-        # capability as well.
+        # Whether implementation supports dynamic registration. If this is set to `true`
+        # the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
+        # return value for the corresponding server capability as well.
         #
         # @return [boolean]
         def dynamic_registration

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

@@ -1,6 +1,11 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Represents an incoming call, e.g. a caller of a method or constructor.
+      #
+      # @since 3.16.0
+      #
       class CallHierarchyIncomingCall
         def initialize(from:, from_ranges:)
           @attributes = {}
@@ -21,7 +26,7 @@ module LanguageServer
 
         #
         # The ranges at which the calls appear. This is relative to the caller
-        # denoted by [`this.from`](#CallHierarchyIncomingCall.from).
+        # denoted by {@link CallHierarchyIncomingCall.from `this.from`}.
         #
         # @return [Range[]]
         def from_ranges