language_server-protocol 3.16.0.2 → 3.17.0.1

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

@@ -0,0 +1,75 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A full document diagnostic report for a workspace diagnostic result.
+      #
+      class WorkspaceFullDocumentDiagnosticReport
+        def initialize(kind:, result_id: nil, items:, uri:, version:)
+          @attributes = {}
+
+          @attributes[:kind] = kind
+          @attributes[:resultId] = result_id if result_id
+          @attributes[:items] = items
+          @attributes[:uri] = uri
+          @attributes[:version] = version
+
+          @attributes.freeze
+        end
+
+        #
+        # A full document diagnostic report.
+        #
+        # @return [any]
+        def kind
+          attributes.fetch(:kind)
+        end
+
+        #
+        # An optional result id. If provided it will
+        # be sent on the next diagnostic request for the
+        # same document.
+        #
+        # @return [string]
+        def result_id
+          attributes.fetch(:resultId)
+        end
+
+        #
+        # The actual items.
+        #
+        # @return [Diagnostic[]]
+        def items
+          attributes.fetch(:items)
+        end
+
+        #
+        # The URI for which diagnostic information is reported.
+        #
+        # @return [string]
+        def uri
+          attributes.fetch(:uri)
+        end
+
+        #
+        # The version number for which the diagnostics are reported.
+        # If the document is not marked as open `null` can be provided.
+        #
+        # @return [number]
+        def version
+          attributes.fetch(:version)
+        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_symbol.rb

@@ -0,0 +1,89 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A special workspace symbol that supports locations without a range
+      #
+      class WorkspaceSymbol
+        def initialize(name:, kind:, tags: nil, container_name: nil, location:, data: nil)
+          @attributes = {}
+
+          @attributes[:name] = name
+          @attributes[:kind] = kind
+          @attributes[:tags] = tags if tags
+          @attributes[:containerName] = container_name if container_name
+          @attributes[:location] = location
+          @attributes[:data] = data if data
+
+          @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 completion item.
+        #
+        # @return [1[]]
+        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
+
+        #
+        # The location of this symbol. Whether a server is allowed to
+        # return a location without a range depends on the client
+        # capability `workspace.symbol.resolveSupport`.
+        #
+        # See also `SymbolInformation.location`.
+        #
+        # @return [Location | { uri: string; }]
+        def location
+          attributes.fetch(:location)
+        end
+
+        #
+        # A data entry field that is preserved on a workspace symbol between a
+        # workspace symbol request and a workspace symbol resolve request.
+        #
+        # @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/workspace_symbol_client_capabilities.rb

@@ -2,12 +2,13 @@ module LanguageServer
   module Protocol
     module Interface
       class WorkspaceSymbolClientCapabilities
-        def initialize(dynamic_registration: nil, symbol_kind: nil, tag_support: nil)
+        def initialize(dynamic_registration: nil, symbol_kind: nil, tag_support: nil, resolve_support: nil)
           @attributes = {}
 
           @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
           @attributes[:symbolKind] = symbol_kind if symbol_kind
           @attributes[:tagSupport] = tag_support if tag_support
+          @attributes[:resolveSupport] = resolve_support if resolve_support
 
           @attributes.freeze
         end
@@ -24,13 +25,13 @@ module LanguageServer
         # Specific capabilities for the `SymbolKind` in the `workspace/symbol`
         # request.
         #
-        # @return [{ valueSet?: any[]; }]
+        # @return [{ valueSet?: SymbolKind[]; }]
         def symbol_kind
           attributes.fetch(:symbolKind)
         end
 
         #
-        # The client supports tags on `SymbolInformation`.
+        # The client supports tags on `SymbolInformation` and `WorkspaceSymbol`.
         # Clients supporting tags have to handle unknown tags gracefully.
         #
         # @return [{ valueSet: 1[]; }]
@@ -38,6 +39,16 @@ module LanguageServer
           attributes.fetch(:tagSupport)
         end
 
+        #
+        # The client support partial workspace symbols. The client will send the
+        # request `workspaceSymbol/resolve` to the server to resolve additional
+        # properties.
+        #
+        # @return [{ properties: string[]; }]
+        def resolve_support
+          attributes.fetch(:resolveSupport)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -2,10 +2,11 @@ module LanguageServer
   module Protocol
     module Interface
       class WorkspaceSymbolOptions
-        def initialize(work_done_progress: nil)
+        def initialize(work_done_progress: nil, resolve_provider: nil)
           @attributes = {}
 
           @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:resolveProvider] = resolve_provider if resolve_provider
 
           @attributes.freeze
         end
@@ -15,6 +16,15 @@ module LanguageServer
           attributes.fetch(:workDoneProgress)
         end
 
+        #
+        # The server provides support to resolve additional
+        # information for a workspace symbol.
+        #
+        # @return [boolean]
+        def resolve_provider
+          attributes.fetch(:resolveProvider)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -2,10 +2,11 @@ module LanguageServer
   module Protocol
     module Interface
       class WorkspaceSymbolRegistrationOptions
-        def initialize(work_done_progress: nil)
+        def initialize(work_done_progress: nil, resolve_provider: nil)
           @attributes = {}
 
           @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:resolveProvider] = resolve_provider if resolve_provider
 
           @attributes.freeze
         end
@@ -15,6 +16,15 @@ module LanguageServer
           attributes.fetch(:workDoneProgress)
         end
 
+        #
+        # The server provides support to resolve additional
+        # information for a workspace symbol.
+        #
+        # @return [boolean]
+        def resolve_provider
+          attributes.fetch(:resolveProvider)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -0,0 +1,68 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # An unchanged document diagnostic report for a workspace diagnostic result.
+      #
+      class WorkspaceUnchangedDocumentDiagnosticReport
+        def initialize(kind:, result_id:, uri:, version:)
+          @attributes = {}
+
+          @attributes[:kind] = kind
+          @attributes[:resultId] = result_id
+          @attributes[:uri] = uri
+          @attributes[:version] = version
+
+          @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
+
+        #
+        # The URI for which diagnostic information is reported.
+        #
+        # @return [string]
+        def uri
+          attributes.fetch(:uri)
+        end
+
+        #
+        # The version number for which the diagnostics are reported.
+        # If the document is not marked as open `null` can be provided.
+        #
+        # @return [number]
+        def version
+          attributes.fetch(:version)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end