language_server-protocol 3.16.0.2 → 3.17.0.1

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

@@ -5,7 +5,7 @@ module LanguageServer
       # Text document specific client capabilities.
       #
       class TextDocumentClientCapabilities
-        def initialize(synchronization: nil, completion: nil, hover: nil, signature_help: nil, declaration: nil, definition: nil, type_definition: nil, implementation: nil, references: nil, document_highlight: nil, document_symbol: nil, code_action: nil, code_lens: nil, document_link: nil, color_provider: nil, formatting: nil, range_formatting: nil, on_type_formatting: nil, rename: nil, publish_diagnostics: nil, folding_range: nil, selection_range: nil, linked_editing_range: nil, call_hierarchy: nil, semantic_tokens: nil, moniker: nil)
+        def initialize(synchronization: nil, completion: nil, hover: nil, signature_help: nil, declaration: nil, definition: nil, type_definition: nil, implementation: nil, references: nil, document_highlight: nil, document_symbol: nil, code_action: nil, code_lens: nil, document_link: nil, color_provider: nil, formatting: nil, range_formatting: nil, on_type_formatting: nil, rename: nil, publish_diagnostics: nil, folding_range: nil, selection_range: nil, linked_editing_range: nil, call_hierarchy: nil, semantic_tokens: nil, moniker: nil, type_hierarchy: nil, inline_value: nil, inlay_hint: nil, diagnostic: nil)
           @attributes = {}
 
           @attributes[:synchronization] = synchronization if synchronization
@@ -34,6 +34,10 @@ module LanguageServer
           @attributes[:callHierarchy] = call_hierarchy if call_hierarchy
           @attributes[:semanticTokens] = semantic_tokens if semantic_tokens
           @attributes[:moniker] = moniker if moniker
+          @attributes[:typeHierarchy] = type_hierarchy if type_hierarchy
+          @attributes[:inlineValue] = inline_value if inline_value
+          @attributes[:inlayHint] = inlay_hint if inlay_hint
+          @attributes[:diagnostic] = diagnostic if diagnostic
 
           @attributes.freeze
         end
@@ -246,6 +250,38 @@ module LanguageServer
           attributes.fetch(:moniker)
         end
 
+        #
+        # Capabilities specific to the various type hierarchy requests.
+        #
+        # @return [TypeHierarchyClientCapabilities]
+        def type_hierarchy
+          attributes.fetch(:typeHierarchy)
+        end
+
+        #
+        # Capabilities specific to the `textDocument/inlineValue` request.
+        #
+        # @return [InlineValueClientCapabilities]
+        def inline_value
+          attributes.fetch(:inlineValue)
+        end
+
+        #
+        # Capabilities specific to the `textDocument/inlayHint` request.
+        #
+        # @return [InlayHintClientCapabilities]
+        def inlay_hint
+          attributes.fetch(:inlayHint)
+        end
+
+        #
+        # Capabilities specific to the diagnostic pull model.
+        #
+        # @return [DiagnosticClientCapabilities]
+        def diagnostic
+          attributes.fetch(:diagnostic)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -2,8 +2,8 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # An event describing a change to a text document. If range and rangeLength are
-      # omitted the new text is considered to be the full content of the document.
+      # An event describing a change to a text document. If only a text is provided
+      # it is considered to be the full content of the document.
       #
       class TextDocumentContentChangeEvent
         def initialize(range: nil, range_length: nil, text:)

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

@@ -16,6 +16,8 @@ module LanguageServer
 
         #
         # Open and close notifications are sent to the server. If omitted open
+        # close notifications should not be sent.
+        # Open and close notifications are sent to the server. If omitted open
         # close notification should not be sent.
         #
         # @return [boolean]

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

@@ -0,0 +1,102 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      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 [1[]]
+        def tags
+          attributes.fetch(:tags)
+        end
+
+        #
+        # More detail for this item, e.g. the signature of a function.
+        #
+        # @return [string]
+        def detail
+          attributes.fetch(:detail)
+        end
+
+        #
+        # The resource identifier of this item.
+        #
+        # @return [string]
+        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]
+        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,30 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class TypeHierarchyOptions
+        def initialize(work_done_progress: nil)
+          @attributes = {}
+
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+
+          @attributes.freeze
+        end
+
+        # @return [boolean]
+        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,51 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      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]
+        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,50 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      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]
+        def document_selector
+          attributes.fetch(:documentSelector)
+        end
+
+        # @return [boolean]
+        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]
+        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,49 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class TypeHierarchySubtypesParams
+        def initialize(work_done_token: nil, partial_result_token: nil, item:)
+          @attributes = {}
+
+          @attributes[:workDoneToken] = work_done_token if work_done_token
+          @attributes[:partialResultToken] = partial_result_token if partial_result_token
+          @attributes[:item] = item
+
+          @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
+
+        # @return [TypeHierarchyItem]
+        def item
+          attributes.fetch(:item)
+        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,49 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class TypeHierarchySupertypesParams
+        def initialize(work_done_token: nil, partial_result_token: nil, item:)
+          @attributes = {}
+
+          @attributes[:workDoneToken] = work_done_token if work_done_token
+          @attributes[:partialResultToken] = partial_result_token if partial_result_token
+          @attributes[:item] = item
+
+          @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
+
+        # @return [TypeHierarchyItem]
+        def item
+          attributes.fetch(:item)
+        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,50 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A diagnostic report indicating that the last returned
+      # report is still accurate.
+      #
+      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 [any]
+        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/{markdown_client_capabilities.rb → versioned_notebook_document_identifier.rb}

@@ -2,32 +2,32 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # Client capabilities specific to the used markdown parser.
+      # A versioned notebook document identifier.
       #
-      class MarkdownClientCapabilities
-        def initialize(parser:, version: nil)
+      class VersionedNotebookDocumentIdentifier
+        def initialize(version:, uri:)
           @attributes = {}
 
-          @attributes[:parser] = parser
-          @attributes[:version] = version if version
+          @attributes[:version] = version
+          @attributes[:uri] = uri
 
           @attributes.freeze
         end
 
         #
-        # The name of the parser.
+        # The version number of this notebook document.
         #
-        # @return [string]
-        def parser
-          attributes.fetch(:parser)
+        # @return [number]
+        def version
+          attributes.fetch(:version)
         end
 
         #
-        # The version of the parser.
+        # The notebook document's URI.
         #
         # @return [string]
-        def version
-          attributes.fetch(:version)
+        def uri
+          attributes.fetch(:uri)
         end
 
         attr_reader :attributes

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

@@ -20,7 +20,7 @@ module LanguageServer
 
         #
         # Controls enablement state of a cancel button. This property is only valid
-        # if a cancel button got requested in the `WorkDoneProgressStart` payload.
+        # if a cancel button got requested in the `WorkDoneProgressBegin` payload.
         #
         # Clients that don't support cancellation or don't support control the
         # button's enablement state are allowed to ignore the setting.

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

@@ -0,0 +1,65 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Parameters of the workspace diagnostic request.
+      #
+      class WorkspaceDiagnosticParams
+        def initialize(work_done_token: nil, partial_result_token: nil, identifier: nil, previous_result_ids:)
+          @attributes = {}
+
+          @attributes[:workDoneToken] = work_done_token if work_done_token
+          @attributes[:partialResultToken] = partial_result_token if partial_result_token
+          @attributes[:identifier] = identifier if identifier
+          @attributes[:previousResultIds] = previous_result_ids
+
+          @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 additional identifier provided during registration.
+        #
+        # @return [string]
+        def identifier
+          attributes.fetch(:identifier)
+        end
+
+        #
+        # The currently known diagnostic reports with their
+        # previous result ids.
+        #
+        # @return [PreviousResultId[]]
+        def previous_result_ids
+          attributes.fetch(:previousResultIds)
+        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/workspace_diagnostic_report.rb

@@ -0,0 +1,33 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A workspace diagnostic report.
+      #
+      class WorkspaceDiagnosticReport
+        def initialize(items:)
+          @attributes = {}
+
+          @attributes[:items] = items
+
+          @attributes.freeze
+        end
+
+        # @return [WorkspaceDocumentDiagnosticReport[]]
+        def items
+          attributes.fetch(:items)
+        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/workspace_diagnostic_report_partial_result.rb

@@ -0,0 +1,33 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A partial result for a workspace diagnostic report.
+      #
+      class WorkspaceDiagnosticReportPartialResult
+        def initialize(items:)
+          @attributes = {}
+
+          @attributes[:items] = items
+
+          @attributes.freeze
+        end
+
+        # @return [WorkspaceDocumentDiagnosticReport[]]
+        def items
+          attributes.fetch(:items)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end