language_server-protocol 3.16.0.1 → 3.17.0.0

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

@@ -15,48 +15,46 @@ module LanguageServer
         end
 
         #
-        # Open and close notifications are sent to the server. If omitted open
-        # close notification should not be sent.
+        # Open and close notifications are sent to the server. If omitted open close notifications should not
+        # be sent.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def open_close
           attributes.fetch(:openClose)
         end
 
         #
-        # Change notifications are sent to the server. See
-        # TextDocumentSyncKind.None, TextDocumentSyncKind.Full and
-        # TextDocumentSyncKind.Incremental. If omitted it defaults to
-        # TextDocumentSyncKind.None.
+        # Change notifications are sent to the server. See TextDocumentSyncKind.None, TextDocumentSyncKind.Full
+        # and TextDocumentSyncKind.Incremental. If omitted it defaults to TextDocumentSyncKind.None.
         #
-        # @return [TextDocumentSyncKind]
+        # @return [TextDocumentSyncKind | nil]
         def change
           attributes.fetch(:change)
         end
 
         #
-        # If present will save notifications are sent to the server. If omitted
-        # the notification should not be sent.
+        # If present will save notifications are sent to the server. If omitted the notification should not be
+        # sent.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def will_save
           attributes.fetch(:willSave)
         end
 
         #
-        # If present will save wait until requests are sent to the server. If
-        # omitted the request should not be sent.
+        # If present will save wait until requests are sent to the server. If omitted the request should not be
+        # sent.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def will_save_wait_until
           attributes.fetch(:willSaveWaitUntil)
         end
 
         #
-        # If present save notifications are sent to the server. If omitted the
-        # notification should not be sent.
+        # If present save notifications are sent to the server. If omitted the notification should not be
+        # sent.
         #
-        # @return [boolean | SaveOptions]
+        # @return [boolean | SaveOptions | nil]
         def save
           attributes.fetch(:save)
         end

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # A text edit applicable to a text document.
+      #
       class TextEdit
         def initialize(range:, new_text:)
           @attributes = {}

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Since 3.6.0
+      #
       class TypeDefinitionClientCapabilities
         def initialize(dynamic_registration: nil, link_support: nil)
           @attributes = {}
@@ -12,11 +15,11 @@ module LanguageServer
         end
 
         #
-        # Whether implementation supports dynamic registration. If this is set to
-        # `true` the client supports the new `TypeDefinitionRegistrationOptions`
-        # 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 `TypeDefinitionRegistrationOptions` return value
+        # for the corresponding server capability as well.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end
@@ -24,7 +27,9 @@ module LanguageServer
         #
         # The client supports additional metadata in the form of definition links.
         #
-        # @return [boolean]
+        # Since 3.14.0
+        #
+        # @return [boolean | nil]
         def link_support
           attributes.fetch(:linkSupport)
         end

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

@@ -10,7 +10,7 @@ module LanguageServer
           @attributes.freeze
         end
 
-        # @return [boolean]
+        # @return [boolean | nil]
         def work_done_progress
           attributes.fetch(:workDoneProgress)
         end

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

@@ -32,16 +32,16 @@ module LanguageServer
         #
         # An optional token that a server can use to report work done progress.
         #
-        # @return [ProgressToken]
+        # @return [ProgressToken | nil]
         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.
+        # An optional token that a server can use to report partial results (e.g. streaming) to
+        # the client.
         #
-        # @return [ProgressToken]
+        # @return [ProgressToken | nil]
         def partial_result_token
           attributes.fetch(:partialResultToken)
         end

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

@@ -13,15 +13,15 @@ module LanguageServer
         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 | null]
         def document_selector
           attributes.fetch(:documentSelector)
         end
 
-        # @return [boolean]
+        # @return [boolean | nil]
         def work_done_progress
           attributes.fetch(:workDoneProgress)
         end
@@ -30,7 +30,7 @@ module LanguageServer
         # The id used to register the request. The id can be used to deregister
         # the request again. See also Registration#id.
         #
-        # @return [string]
+        # @return [string | nil]
         def id
           attributes.fetch(:id)
         end

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

@@ -0,0 +1,38 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # @since 3.17.0
+      #
+      class TypeHierarchyClientCapabilities
+        def initialize(dynamic_registration: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+
+          @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.
+        #
+        # @return [boolean | nil]
+        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/type_hierarchy_item.rb

@@ -0,0 +1,105 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # @since 3.17.0
+      #
+      class TypeHierarchyItem
+        def initialize(name:, kind:, tags: nil, detail: nil, uri:, range:, selection_range:, data: nil)
+          @attributes = {}
+
+          @attributes[:name] = name
+          @attributes[:kind] = kind
+          @attributes[:tags] = tags if tags
+          @attributes[:detail] = detail if detail
+          @attributes[:uri] = uri
+          @attributes[:range] = range
+          @attributes[:selectionRange] = selection_range
+          @attributes[:data] = data if data
+
+          @attributes.freeze
+        end
+
+        #
+        # The name of this item.
+        #
+        # @return [string]
+        def name
+          attributes.fetch(:name)
+        end
+
+        #
+        # The kind of this item.
+        #
+        # @return [SymbolKind]
+        def kind
+          attributes.fetch(:kind)
+        end
+
+        #
+        # Tags for this item.
+        #
+        # @return [SymbolTag[] | nil]
+        def tags
+          attributes.fetch(:tags)
+        end
+
+        #
+        # More detail for this item, e.g. the signature of a function.
+        #
+        # @return [string | nil]
+        def detail
+          attributes.fetch(:detail)
+        end
+
+        #
+        # The resource identifier of this item.
+        #
+        # @return [DocumentUri]
+        def uri
+          attributes.fetch(:uri)
+        end
+
+        #
+        # The range enclosing this symbol not including leading/trailing whitespace
+        # but everything else, e.g. comments and code.
+        #
+        # @return [Range]
+        def range
+          attributes.fetch(:range)
+        end
+
+        #
+        # The range that should be selected and revealed when this symbol is being
+        # picked, e.g. the name of a function. Must be contained by the
+        # [`range`](#TypeHierarchyItem.range).
+        #
+        # @return [Range]
+        def selection_range
+          attributes.fetch(:selectionRange)
+        end
+
+        #
+        # A data entry field that is preserved between a type hierarchy prepare and
+        # supertypes or subtypes requests. It could also be used to identify the
+        # type hierarchy in the server, helping improve the performance on
+        # resolving supertypes and subtypes.
+        #
+        # @return [LSPAny | nil]
+        def data
+          attributes.fetch(:data)
+        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/type_hierarchy_options.rb

@@ -0,0 +1,35 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Type hierarchy options used during static registration.
+      #
+      # @since 3.17.0
+      #
+      class TypeHierarchyOptions
+        def initialize(work_done_progress: nil)
+          @attributes = {}
+
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+
+          @attributes.freeze
+        end
+
+        # @return [boolean | nil]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        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/type_hierarchy_prepare_params.rb

@@ -0,0 +1,56 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # The parameter of a `textDocument/prepareTypeHierarchy` request.
+      #
+      # @since 3.17.0
+      #
+      class TypeHierarchyPrepareParams
+        def initialize(text_document:, position:, work_done_token: nil)
+          @attributes = {}
+
+          @attributes[:textDocument] = text_document
+          @attributes[:position] = position
+          @attributes[:workDoneToken] = work_done_token if work_done_token
+
+          @attributes.freeze
+        end
+
+        #
+        # The text document.
+        #
+        # @return [TextDocumentIdentifier]
+        def text_document
+          attributes.fetch(:textDocument)
+        end
+
+        #
+        # The position inside the text document.
+        #
+        # @return [Position]
+        def position
+          attributes.fetch(:position)
+        end
+
+        #
+        # An optional token that a server can use to report work done progress.
+        #
+        # @return [ProgressToken | nil]
+        def work_done_token
+          attributes.fetch(:workDoneToken)
+        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/type_hierarchy_registration_options.rb

@@ -0,0 +1,55 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Type hierarchy options used during static or dynamic registration.
+      #
+      # @since 3.17.0
+      #
+      class TypeHierarchyRegistrationOptions
+        def initialize(document_selector:, work_done_progress: nil, id: nil)
+          @attributes = {}
+
+          @attributes[:documentSelector] = document_selector
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:id] = id if id
+
+          @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 | null]
+        def document_selector
+          attributes.fetch(:documentSelector)
+        end
+
+        # @return [boolean | nil]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
+        #
+        # The id used to register the request. The id can be used to deregister
+        # the request again. See also Registration#id.
+        #
+        # @return [string | nil]
+        def id
+          attributes.fetch(:id)
+        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/type_hierarchy_subtypes_params.rb

@@ -0,0 +1,54 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # The parameter of a `typeHierarchy/subtypes` request.
+      #
+      # @since 3.17.0
+      #
+      class TypeHierarchySubtypesParams
+        def initialize(item:, work_done_token: nil, partial_result_token: nil)
+          @attributes = {}
+
+          @attributes[:item] = item
+          @attributes[:workDoneToken] = work_done_token if work_done_token
+          @attributes[:partialResultToken] = partial_result_token if partial_result_token
+
+          @attributes.freeze
+        end
+
+        # @return [TypeHierarchyItem]
+        def item
+          attributes.fetch(:item)
+        end
+
+        #
+        # An optional token that a server can use to report work done progress.
+        #
+        # @return [ProgressToken | nil]
+        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 | nil]
+        def partial_result_token
+          attributes.fetch(:partialResultToken)
+        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/type_hierarchy_supertypes_params.rb

@@ -0,0 +1,54 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # The parameter of a `typeHierarchy/supertypes` request.
+      #
+      # @since 3.17.0
+      #
+      class TypeHierarchySupertypesParams
+        def initialize(item:, work_done_token: nil, partial_result_token: nil)
+          @attributes = {}
+
+          @attributes[:item] = item
+          @attributes[:workDoneToken] = work_done_token if work_done_token
+          @attributes[:partialResultToken] = partial_result_token if partial_result_token
+
+          @attributes.freeze
+        end
+
+        # @return [TypeHierarchyItem]
+        def item
+          attributes.fetch(:item)
+        end
+
+        #
+        # An optional token that a server can use to report work done progress.
+        #
+        # @return [ProgressToken | nil]
+        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 | nil]
+        def partial_result_token
+          attributes.fetch(:partialResultToken)
+        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/unchanged_document_diagnostic_report.rb

@@ -0,0 +1,52 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A diagnostic report indicating that the last returned
+      # report is still accurate.
+      #
+      # @since 3.17.0
+      #
+      class UnchangedDocumentDiagnosticReport
+        def initialize(kind:, result_id:)
+          @attributes = {}
+
+          @attributes[:kind] = kind
+          @attributes[:resultId] = result_id
+
+          @attributes.freeze
+        end
+
+        #
+        # A document diagnostic report indicating
+        # no changes to the last result. A server can
+        # only return `unchanged` if result ids are
+        # provided.
+        #
+        # @return ["unchanged"]
+        def kind
+          attributes.fetch(:kind)
+        end
+
+        #
+        # A result id which will be sent on the next
+        # diagnostic request for the same document.
+        #
+        # @return [string]
+        def result_id
+          attributes.fetch(:resultId)
+        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/unregistration.rb

@@ -2,7 +2,7 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # General parameters to unregister a capability.
+      # General parameters to unregister a request or notification.
       #
       class Unregistration
         def initialize(id:, method:)
@@ -24,7 +24,7 @@ module LanguageServer
         end
 
         #
-        # The method / capability to unregister for.
+        # The method to unregister for.
         #
         # @return [string]
         def method

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

@@ -0,0 +1,47 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A versioned notebook document identifier.
+      #
+      # @since 3.17.0
+      #
+      class VersionedNotebookDocumentIdentifier
+        def initialize(version:, uri:)
+          @attributes = {}
+
+          @attributes[:version] = version
+          @attributes[:uri] = uri
+
+          @attributes.freeze
+        end
+
+        #
+        # The version number of this notebook document.
+        #
+        # @return [integer]
+        def version
+          attributes.fetch(:version)
+        end
+
+        #
+        # The notebook document's uri.
+        #
+        # @return [URI]
+        def uri
+          attributes.fetch(:uri)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end