language_server-protocol 3.16.0.3 → 3.17.0.0

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

@@ -17,7 +17,7 @@ module LanguageServer
         #
         # The client supports versioned document changes in `WorkspaceEdit`s
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def document_changes
           attributes.fetch(:documentChanges)
         end
@@ -26,7 +26,9 @@ module LanguageServer
         # The resource operations the client supports. Clients should at least
         # support 'create', 'rename' and 'delete' files and folders.
         #
-        # @return [ResourceOperationKind[]]
+        # @since 3.13.0
+        #
+        # @return [ResourceOperationKind[] | nil]
         def resource_operations
           attributes.fetch(:resourceOperations)
         end
@@ -35,7 +37,9 @@ module LanguageServer
         # The failure handling strategy of a client if applying the workspace edit
         # fails.
         #
-        # @return [FailureHandlingKind]
+        # @since 3.13.0
+        #
+        # @return [FailureHandlingKind | nil]
         def failure_handling
           attributes.fetch(:failureHandling)
         end
@@ -44,9 +48,12 @@ module LanguageServer
         # Whether the client normalizes line endings to the client specific
         # setting.
         # If set to `true` the client will normalize line ending characters
-        # in a workspace edit to the client specific new line character(s).
+        # in a workspace edit to the client-specified new line
+        # character.
         #
-        # @return [boolean]
+        # @since 3.16.0
+        #
+        # @return [boolean | nil]
         def normalizes_line_endings
           attributes.fetch(:normalizesLineEndings)
         end
@@ -55,7 +62,9 @@ module LanguageServer
         # Whether the client in general supports change annotations on text edits,
         # create file, rename file and delete file changes.
         #
-        # @return [{ groupsOnLabel?: boolean; }]
+        # @since 3.16.0
+        #
+        # @return [{ groupsOnLabel:boolean } | nil]
         def change_annotation_support
           attributes.fetch(:changeAnnotationSupport)
         end

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # A workspace folder inside a client.
+      #
       class WorkspaceFolder
         def initialize(uri:, name:)
           @attributes = {}
@@ -14,7 +17,7 @@ module LanguageServer
         #
         # The associated URI for this workspace folder.
         #
-        # @return [string]
+        # @return [URI]
         def uri
           attributes.fetch(:uri)
         end

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

@@ -0,0 +1,39 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class WorkspaceFoldersInitializeParams
+        def initialize(workspace_folders: nil)
+          @attributes = {}
+
+          @attributes[:workspaceFolders] = workspace_folders if workspace_folders
+
+          @attributes.freeze
+        end
+
+        #
+        # The workspace folders configured in the client when the server starts.
+        #
+        # This property is only available if the client supports workspace folders.
+        # It can be `null` if the client supports workspace folders but none are
+        # configured.
+        #
+        # @since 3.6.0
+        #
+        # @return [WorkspaceFolder[] | null]
+        def workspace_folders
+          attributes.fetch(:workspaceFolders)
+        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_folders_server_capabilities.rb

@@ -14,7 +14,7 @@ module LanguageServer
         #
         # The server has support for workspace folders
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def supported
           attributes.fetch(:supported)
         end
@@ -23,12 +23,12 @@ module LanguageServer
         # Whether the server wants to receive workspace folder
         # change notifications.
         #
-        # If a string is provided, the string is treated as an ID
+        # If a string is provided the string is treated as an ID
         # under which the notification is registered on the client
         # side. The ID can be used to unregister for these events
         # using the `client/unregisterCapability` request.
         #
-        # @return [string | boolean]
+        # @return [string | boolean | nil]
         def change_notifications
           attributes.fetch(:changeNotifications)
         end

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

@@ -0,0 +1,77 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A full document diagnostic report for a workspace diagnostic result.
+      #
+      # @since 3.17.0
+      #
+      class WorkspaceFullDocumentDiagnosticReport
+        def initialize(uri:, version:, kind:, result_id: nil, items:)
+          @attributes = {}
+
+          @attributes[:uri] = uri
+          @attributes[:version] = version
+          @attributes[:kind] = kind
+          @attributes[:resultId] = result_id if result_id
+          @attributes[:items] = items
+
+          @attributes.freeze
+        end
+
+        #
+        # The URI for which diagnostic information is reported.
+        #
+        # @return [DocumentUri]
+        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 [integer | null]
+        def version
+          attributes.fetch(:version)
+        end
+
+        #
+        # A full document diagnostic report.
+        #
+        # @return ["full"]
+        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 | nil]
+        def result_id
+          attributes.fetch(:resultId)
+        end
+
+        #
+        # The actual items.
+        #
+        # @return [Diagnostic[]]
+        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_symbol.rb

@@ -0,0 +1,95 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A special workspace symbol that supports locations without a range.
+      #
+      # See also SymbolInformation.
+      #
+      # @since 3.17.0
+      #
+      class WorkspaceSymbol
+        def initialize(location:, data: nil, name:, kind:, tags: nil, container_name: nil)
+          @attributes = {}
+
+          @attributes[:location] = location
+          @attributes[:data] = data if data
+          @attributes[:name] = name
+          @attributes[:kind] = kind
+          @attributes[:tags] = tags if tags
+          @attributes[:containerName] = container_name if container_name
+
+          @attributes.freeze
+        end
+
+        #
+        # The location of the symbol. Whether a server is allowed to
+        # return a location without a range depends on the client
+        # capability `workspace.symbol.resolveSupport`.
+        #
+        # See SymbolInformation#location for more details.
+        #
+        # @return [Location | { uri:DocumentUri }]
+        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 | nil]
+        def data
+          attributes.fetch(:data)
+        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[] | nil]
+        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 | nil]
+        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/workspace_symbol_client_capabilities.rb

@@ -1,13 +1,17 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Client capabilities for a [WorkspaceSymbolRequest](#WorkspaceSymbolRequest).
+      #
       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
@@ -15,16 +19,15 @@ module LanguageServer
         #
         # Symbol request supports dynamic registration.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end
 
         #
-        # Specific capabilities for the `SymbolKind` in the `workspace/symbol`
-        # request.
+        # Specific capabilities for the `SymbolKind` in the `workspace/symbol` request.
         #
-        # @return [{ valueSet?: any[]; }]
+        # @return [{ valueSet:SymbolKind[] } | nil]
         def symbol_kind
           attributes.fetch(:symbolKind)
         end
@@ -33,11 +36,25 @@ module LanguageServer
         # The client supports tags on `SymbolInformation`.
         # Clients supporting tags have to handle unknown tags gracefully.
         #
-        # @return [{ valueSet: 1[]; }]
+        # @since 3.16.0
+        #
+        # @return [{ valueSet:SymbolTag[] } | nil]
         def tag_support
           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.
+        #
+        # @since 3.17.0
+        #
+        # @return [{ properties:string[] } | nil]
+        def resolve_support
+          attributes.fetch(:resolveSupport)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -1,16 +1,31 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Server capabilities for a [WorkspaceSymbolRequest](#WorkspaceSymbolRequest).
+      #
       class WorkspaceSymbolOptions
-        def initialize(work_done_progress: nil)
+        def initialize(resolve_provider: nil, work_done_progress: nil)
           @attributes = {}
 
+          @attributes[:resolveProvider] = resolve_provider if resolve_provider
           @attributes[:workDoneProgress] = work_done_progress if work_done_progress
 
           @attributes.freeze
         end
 
-        # @return [boolean]
+        #
+        # The server provides support to resolve additional
+        # information for a workspace symbol.
+        #
+        # @since 3.17.0
+        #
+        # @return [boolean | nil]
+        def resolve_provider
+          attributes.fetch(:resolveProvider)
+        end
+
+        # @return [boolean | nil]
         def work_done_progress
           attributes.fetch(:workDoneProgress)
         end

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

@@ -2,45 +2,45 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # The parameters of a Workspace Symbol Request.
+      # The parameters of a [WorkspaceSymbolRequest](#WorkspaceSymbolRequest).
       #
       class WorkspaceSymbolParams
-        def initialize(work_done_token: nil, partial_result_token: nil, query:)
+        def initialize(query:, work_done_token: nil, partial_result_token: nil)
           @attributes = {}
 
+          @attributes[:query] = query
           @attributes[:workDoneToken] = work_done_token if work_done_token
           @attributes[:partialResultToken] = partial_result_token if partial_result_token
-          @attributes[:query] = query
 
           @attributes.freeze
         end
 
+        #
+        # A query string to filter symbols by. Clients may send an empty
+        # string here to request all symbols.
+        #
+        # @return [string]
+        def query
+          attributes.fetch(:query)
+        end
+
         #
         # 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
 
-        #
-        # A query string to filter symbols by. Clients may send an empty
-        # string here to request all symbols.
-        #
-        # @return [string]
-        def query
-          attributes.fetch(:query)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -1,16 +1,31 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Registration options for a [WorkspaceSymbolRequest](#WorkspaceSymbolRequest).
+      #
       class WorkspaceSymbolRegistrationOptions
-        def initialize(work_done_progress: nil)
+        def initialize(resolve_provider: nil, work_done_progress: nil)
           @attributes = {}
 
+          @attributes[:resolveProvider] = resolve_provider if resolve_provider
           @attributes[:workDoneProgress] = work_done_progress if work_done_progress
 
           @attributes.freeze
         end
 
-        # @return [boolean]
+        #
+        # The server provides support to resolve additional
+        # information for a workspace symbol.
+        #
+        # @since 3.17.0
+        #
+        # @return [boolean | nil]
+        def resolve_provider
+          attributes.fetch(:resolveProvider)
+        end
+
+        # @return [boolean | nil]
         def work_done_progress
           attributes.fetch(:workDoneProgress)
         end

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

@@ -0,0 +1,70 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # An unchanged document diagnostic report for a workspace diagnostic result.
+      #
+      # @since 3.17.0
+      #
+      class WorkspaceUnchangedDocumentDiagnosticReport
+        def initialize(uri:, version:, kind:, result_id:)
+          @attributes = {}
+
+          @attributes[:uri] = uri
+          @attributes[:version] = version
+          @attributes[:kind] = kind
+          @attributes[:resultId] = result_id
+
+          @attributes.freeze
+        end
+
+        #
+        # The URI for which diagnostic information is reported.
+        #
+        # @return [DocumentUri]
+        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 [integer | null]
+        def version
+          attributes.fetch(:version)
+        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