language_server-protocol 3.17.0.5 → 3.17.0.6

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

@@ -4,35 +4,20 @@ module LanguageServer
       #
       # Parameters of the workspace diagnostic request.
       #
+      # @since 3.17.0
+      #
       class WorkspaceDiagnosticParams
-        def initialize(work_done_token: nil, partial_result_token: nil, identifier: nil, previous_result_ids:)
+        def initialize(identifier: nil, previous_result_ids:, work_done_token: nil, partial_result_token: nil)
           @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[:workDoneToken] = work_done_token if work_done_token
+          @attributes[:partialResultToken] = partial_result_token if partial_result_token
 
           @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.
         #
@@ -50,6 +35,23 @@ module LanguageServer
           attributes.fetch(:previousResultIds)
         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
+
         attr_reader :attributes
 
         def to_hash

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

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # A workspace diagnostic report.
       #
+      # @since 3.17.0
+      #
       class WorkspaceDiagnosticReport
         def initialize(items:)
           @attributes = {}

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

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # A partial result for a workspace diagnostic report.
       #
+      # @since 3.17.0
+      #
       class WorkspaceDiagnosticReportPartialResult
         def initialize(items:)
           @attributes = {}

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

@@ -0,0 +1,89 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A workspace diagnostic document report.
+      #
+      # @since 3.17.0
+      #
+      class WorkspaceDocumentDiagnosticReport
+        def initialize(uri:, version:, kind:, result_id: nil, items: nil)
+          @attributes = {}
+
+          @attributes[:uri] = uri
+          @attributes[:version] = version
+          @attributes[:kind] = kind
+          @attributes[:resultId] = result_id if result_id
+          @attributes[:items] = items if 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 | nil]
+        def version
+          attributes.fetch(:version)
+        end
+
+        #
+        # A full document diagnostic report.
+        #
+        # --- OR ---
+        #
+        # A document diagnostic report indicating
+        # no changes to the last result. A server can
+        # only return `unchanged` if result ids are
+        # provided.
+        #
+        # @return ["full" | "unchanged"]
+        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.
+        #
+        # --- OR ---
+        #
+        # 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 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_edit.rb

@@ -1,6 +1,20 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # A workspace edit represents changes to many resources managed in the workspace. The edit
+      # should either provide `changes` or `documentChanges`. If documentChanges are present
+      # they are preferred over `changes` if the client can handle versioned document edits.
+      #
+      # Since version 3.13.0 a workspace edit can contain resource operations as well. If resource
+      # operations are present clients need to execute the operations in the order in which they
+      # are provided. So a workspace edit for example can consist of the following two changes:
+      # (1) a create file a.txt and (2) a text document edit which insert text into file a.txt.
+      #
+      # An invalid sequence (e.g. (1) delete file a.txt and (2) insert text into file a.txt) will
+      # cause failure of the operation. How the client recovers from the failure is described by
+      # the client capability: `workspace.workspaceEdit.failureHandling`
+      #
       class WorkspaceEdit
         def initialize(changes: nil, document_changes: nil, change_annotations: nil)
           @attributes = {}
@@ -15,40 +29,37 @@ module LanguageServer
         #
         # Holds changes to existing resources.
         #
-        # @return [{}]
+        # @return [DocumentUri => TextEdit[]]
         def changes
           attributes.fetch(:changes)
         end
 
         #
-        # Depending on the client capability
-        # `workspace.workspaceEdit.resourceOperations` document changes are either
-        # an array of `TextDocumentEdit`s to express changes to n different text
-        # documents where each text document edit addresses a specific version of
-        # a text document. Or it can contain above `TextDocumentEdit`s mixed with
-        # create, rename and delete file / folder operations.
+        # Depending on the client capability `workspace.workspaceEdit.resourceOperations` document changes
+        # are either an array of `TextDocumentEdit`s to express changes to n different text documents
+        # where each text document edit addresses a specific version of a text document. Or it can contain
+        # above `TextDocumentEdit`s mixed with create, rename and delete file / folder operations.
         #
         # Whether a client supports versioned document edits is expressed via
         # `workspace.workspaceEdit.documentChanges` client capability.
         #
-        # If a client neither supports `documentChanges` nor
-        # `workspace.workspaceEdit.resourceOperations` then only plain `TextEdit`s
-        # using the `changes` property are supported.
+        # If a client neither supports `documentChanges` nor `workspace.workspaceEdit.resourceOperations` then
+        # only plain `TextEdit`s using the `changes` property are supported.
         #
-        # @return [TextDocumentEdit[] | (TextDocumentEdit | CreateFile | RenameFile | DeleteFile)[]]
+        # @return [TextDocumentEdit | CreateFile | RenameFile | DeleteFile[]]
         def document_changes
           attributes.fetch(:documentChanges)
         end
 
         #
-        # A map of change annotations that can be referenced in
-        # `AnnotatedTextEdit`s or create, rename and delete file / folder
-        # operations.
+        # A map of change annotations that can be referenced in `AnnotatedTextEdit`s or create, rename and
+        # delete file / folder operations.
         #
-        # Whether clients honor this property depends on the client capability
-        # `workspace.changeAnnotationSupport`.
+        # Whether clients honor this property depends on the client capability `workspace.changeAnnotationSupport`.
         #
-        # @return [{ [id: string]: ChangeAnnotation; }]
+        # @since 3.16.0
+        #
+        # @return [ChangeAnnotationIdentifier => ChangeAnnotation]
         def change_annotations
           attributes.fetch(:changeAnnotations)
         end

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

@@ -26,6 +26,8 @@ module LanguageServer
         # The resource operations the client supports. Clients should at least
         # support 'create', 'rename' and 'delete' files and folders.
         #
+        # @since 3.13.0
+        #
         # @return [ResourceOperationKind[]]
         def resource_operations
           attributes.fetch(:resourceOperations)
@@ -35,6 +37,8 @@ module LanguageServer
         # The failure handling strategy of a client if applying the workspace edit
         # fails.
         #
+        # @since 3.13.0
+        #
         # @return [FailureHandlingKind]
         def failure_handling
           attributes.fetch(:failureHandling)
@@ -44,7 +48,10 @@ 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.
+        #
+        # @since 3.16.0
         #
         # @return [boolean]
         def normalizes_line_endings
@@ -55,6 +62,8 @@ module LanguageServer
         # Whether the client in general supports change annotations on text edits,
         # create file, rename file and delete file changes.
         #
+        # @since 3.16.0
+        #
         # @return [{ groupsOnLabel?: boolean; }]
         def change_annotation_support
           attributes.fetch(:changeAnnotationSupport)

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[]]
+        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

@@ -23,7 +23,7 @@ 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.

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

@@ -4,23 +4,42 @@ module LanguageServer
       #
       # A full document diagnostic report for a workspace diagnostic result.
       #
+      # @since 3.17.0
+      #
       class WorkspaceFullDocumentDiagnosticReport
-        def initialize(kind:, result_id: nil, items:, uri:, version:)
+        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[:uri] = uri
-          @attributes[:version] = version
 
           @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 | nil]
+        def version
+          attributes.fetch(:version)
+        end
+
         #
         # A full document diagnostic report.
         #
-        # @return [any]
+        # @return ["full"]
         def kind
           attributes.fetch(:kind)
         end
@@ -43,23 +62,6 @@ module LanguageServer
           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

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

@@ -2,22 +2,47 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # A special workspace symbol that supports locations without a range
+      # A special workspace symbol that supports locations without a range.
+      #
+      # See also SymbolInformation.
+      #
+      # @since 3.17.0
       #
       class WorkspaceSymbol
-        def initialize(name:, kind:, tags: nil, container_name: nil, location:, data: nil)
+        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[:location] = location
-          @attributes[:data] = data if data
 
           @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]
+        def data
+          attributes.fetch(:data)
+        end
+
         #
         # The name of this symbol.
         #
@@ -35,9 +60,11 @@ module LanguageServer
         end
 
         #
-        # Tags for this completion item.
+        # Tags for this symbol.
+        #
+        # @since 3.16.0
         #
-        # @return [1[]]
+        # @return [SymbolTag[]]
         def tags
           attributes.fetch(:tags)
         end
@@ -53,27 +80,6 @@ module LanguageServer
           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

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Client capabilities for a {@link WorkspaceSymbolRequest}.
+      #
       class WorkspaceSymbolClientCapabilities
         def initialize(dynamic_registration: nil, symbol_kind: nil, tag_support: nil, resolve_support: nil)
           @attributes = {}
@@ -22,8 +25,7 @@ module LanguageServer
         end
 
         #
-        # Specific capabilities for the `SymbolKind` in the `workspace/symbol`
-        # request.
+        # Specific capabilities for the `SymbolKind` in the `workspace/symbol` request.
         #
         # @return [{ valueSet?: SymbolKind[]; }]
         def symbol_kind
@@ -31,10 +33,12 @@ module LanguageServer
         end
 
         #
-        # The client supports tags on `SymbolInformation` and `WorkspaceSymbol`.
+        # 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[]; }]
         def tag_support
           attributes.fetch(:tagSupport)
         end
@@ -44,6 +48,8 @@ module LanguageServer
         # request `workspaceSymbol/resolve` to the server to resolve additional
         # properties.
         #
+        # @since 3.17.0
+        #
         # @return [{ properties: string[]; }]
         def resolve_support
           attributes.fetch(:resolveSupport)

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

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

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

@@ -2,19 +2,28 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # The parameters of a Workspace Symbol Request.
+      # The parameters of a {@link 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.
         #
@@ -24,23 +33,14 @@ module LanguageServer
         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]
         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