language_server-protocol 3.17.0.0 → 3.17.0.2

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

@@ -1,20 +1,6 @@
 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 = {}
@@ -29,37 +15,40 @@ module LanguageServer
         #
         # Holds changes to existing resources.
         #
-        # @return [DocumentUri => TextEdit[] | nil]
+        # @return [{}]
         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 | CreateFile | RenameFile | DeleteFile[] | nil]
+        # @return [TextDocumentEdit[] | (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`.
         #
-        # @since 3.16.0
-        #
-        # @return [ChangeAnnotationIdentifier => ChangeAnnotation | nil]
+        # @return [{ [id: string]: ChangeAnnotation; }]
         def change_annotations
           attributes.fetch(:changeAnnotations)
         end

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 | nil]
+        # @return [boolean]
         def document_changes
           attributes.fetch(:documentChanges)
         end
@@ -26,9 +26,7 @@ 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[] | nil]
+        # @return [ResourceOperationKind[]]
         def resource_operations
           attributes.fetch(:resourceOperations)
         end
@@ -37,9 +35,7 @@ module LanguageServer
         # The failure handling strategy of a client if applying the workspace edit
         # fails.
         #
-        # @since 3.13.0
-        #
-        # @return [FailureHandlingKind | nil]
+        # @return [FailureHandlingKind]
         def failure_handling
           attributes.fetch(:failureHandling)
         end
@@ -48,12 +44,9 @@ 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-specified new line
-        # character.
+        # in a workspace edit to the client specific new line character(s).
         #
-        # @since 3.16.0
-        #
-        # @return [boolean | nil]
+        # @return [boolean]
         def normalizes_line_endings
           attributes.fetch(:normalizesLineEndings)
         end
@@ -62,9 +55,7 @@ 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 } | nil]
+        # @return [{ groupsOnLabel?: boolean; }]
         def change_annotation_support
           attributes.fetch(:changeAnnotationSupport)
         end

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

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

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

@@ -4,42 +4,23 @@ module LanguageServer
       #
       # 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:)
+        def initialize(kind:, result_id: nil, items:, uri:, version:)
           @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 | null]
-        def version
-          attributes.fetch(:version)
-        end
-
         #
         # A full document diagnostic report.
         #
-        # @return ["full"]
+        # @return [any]
         def kind
           attributes.fetch(:kind)
         end
@@ -49,7 +30,7 @@ module LanguageServer
         # be sent on the next diagnostic request for the
         # same document.
         #
-        # @return [string | nil]
+        # @return [string]
         def result_id
           attributes.fetch(:resultId)
         end
@@ -62,6 +43,23 @@ 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,47 +2,22 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # A special workspace symbol that supports locations without a range.
-      #
-      # See also SymbolInformation.
-      #
-      # @since 3.17.0
+      # A special workspace symbol that supports locations without a range
       #
       class WorkspaceSymbol
-        def initialize(location:, data: nil, name:, kind:, tags: nil, container_name: nil)
+        def initialize(name:, kind:, tags: nil, container_name: nil, location:, data: 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 | nil]
-        def data
-          attributes.fetch(:data)
-        end
-
         #
         # The name of this symbol.
         #
@@ -60,11 +35,9 @@ module LanguageServer
         end
 
         #
-        # Tags for this symbol.
-        #
-        # @since 3.16.0
+        # Tags for this completion item.
         #
-        # @return [SymbolTag[] | nil]
+        # @return [1[]]
         def tags
           attributes.fetch(:tags)
         end
@@ -75,11 +48,32 @@ module LanguageServer
         # if necessary). It can't be used to re-infer a hierarchy for the document
         # symbols.
         #
-        # @return [string | nil]
+        # @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

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

@@ -1,9 +1,6 @@
 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, resolve_support: nil)
           @attributes = {}
@@ -19,26 +16,25 @@ module LanguageServer
         #
         # Symbol request supports dynamic registration.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         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:SymbolKind[] } | nil]
+        # @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.
         #
-        # @since 3.16.0
-        #
-        # @return [{ valueSet:SymbolTag[] } | nil]
+        # @return [{ valueSet: 1[]; }]
         def tag_support
           attributes.fetch(:tagSupport)
         end
@@ -48,9 +44,7 @@ module LanguageServer
         # request `workspaceSymbol/resolve` to the server to resolve additional
         # properties.
         #
-        # @since 3.17.0
-        #
-        # @return [{ properties:string[] } | nil]
+        # @return [{ properties: string[]; }]
         def resolve_support
           attributes.fetch(:resolveSupport)
         end

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

@@ -1,35 +1,30 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Server capabilities for a [WorkspaceSymbolRequest](#WorkspaceSymbolRequest).
-      #
       class WorkspaceSymbolOptions
-        def initialize(resolve_provider: nil, work_done_progress: nil)
+        def initialize(work_done_progress: nil, resolve_provider: nil)
           @attributes = {}
 
-          @attributes[:resolveProvider] = resolve_provider if resolve_provider
           @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:resolveProvider] = resolve_provider if resolve_provider
 
           @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 | nil]
+        # @return [boolean]
         def resolve_provider
           attributes.fetch(:resolveProvider)
         end
 
-        # @return [boolean | nil]
-        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,45 +2,45 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # The parameters of a [WorkspaceSymbolRequest](#WorkspaceSymbolRequest).
+      # The parameters of a Workspace Symbol Request.
       #
       class WorkspaceSymbolParams
-        def initialize(query:, work_done_token: nil, partial_result_token: nil)
+        def initialize(work_done_token: nil, partial_result_token: nil, query:)
           @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 | nil]
+        # @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.
+        # An optional token that a server can use to report partial results (e.g.
+        # streaming) to the client.
         #
-        # @return [ProgressToken | nil]
+        # @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

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

@@ -1,35 +1,30 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Registration options for a [WorkspaceSymbolRequest](#WorkspaceSymbolRequest).
-      #
       class WorkspaceSymbolRegistrationOptions
-        def initialize(resolve_provider: nil, work_done_progress: nil)
+        def initialize(work_done_progress: nil, resolve_provider: nil)
           @attributes = {}
 
-          @attributes[:resolveProvider] = resolve_provider if resolve_provider
           @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:resolveProvider] = resolve_provider if resolve_provider
 
           @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 | nil]
+        # @return [boolean]
         def resolve_provider
           attributes.fetch(:resolveProvider)
         end
 
-        # @return [boolean | nil]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -4,44 +4,25 @@ module LanguageServer
       #
       # An unchanged document diagnostic report for a workspace diagnostic result.
       #
-      # @since 3.17.0
-      #
       class WorkspaceUnchangedDocumentDiagnosticReport
-        def initialize(uri:, version:, kind:, result_id:)
+        def initialize(kind:, result_id:, uri:, version:)
           @attributes = {}
 
-          @attributes[:uri] = uri
-          @attributes[:version] = version
           @attributes[:kind] = kind
           @attributes[:resultId] = result_id
+          @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 | 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"]
+        # @return [any]
         def kind
           attributes.fetch(:kind)
         end
@@ -55,6 +36,23 @@ module LanguageServer
           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