language_server-protocol 3.17.0.5 → 3.17.0.6

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

@@ -0,0 +1,38 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # @since 3.17.0
+      #
+      class TypeHierarchyClientCapabilities
+        def initialize(dynamic_registration: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+
+          @attributes.freeze
+        end
+
+        #
+        # Whether implementation supports dynamic registration. If this is set to `true`
+        # the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
+        # return value for the corresponding server capability as well.
+        #
+        # @return [boolean]
+        def dynamic_registration
+          attributes.fetch(:dynamicRegistration)
+        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_item.rb

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # @since 3.17.0
+      #
       class TypeHierarchyItem
         def initialize(name:, kind:, tags: nil, detail: nil, uri:, range:, selection_range:, data: nil)
           @attributes = {}
@@ -36,7 +39,7 @@ module LanguageServer
         #
         # Tags for this item.
         #
-        # @return [1[]]
+        # @return [SymbolTag[]]
         def tags
           attributes.fetch(:tags)
         end
@@ -52,7 +55,7 @@ module LanguageServer
         #
         # The resource identifier of this item.
         #
-        # @return [string]
+        # @return [DocumentUri]
         def uri
           attributes.fetch(:uri)
         end
@@ -69,7 +72,7 @@ module LanguageServer
         #
         # 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).
+        # {@link TypeHierarchyItem.range `range`}.
         #
         # @return [Range]
         def selection_range

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

@@ -1,6 +1,11 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Type hierarchy options used during static registration.
+      #
+      # @since 3.17.0
+      #
       class TypeHierarchyOptions
         def initialize(work_done_progress: nil)
           @attributes = {}

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

@@ -1,6 +1,11 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The parameter of a `textDocument/prepareTypeHierarchy` request.
+      #
+      # @since 3.17.0
+      #
       class TypeHierarchyPrepareParams
         def initialize(text_document:, position:, work_done_token: nil)
           @attributes = {}

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

@@ -1,6 +1,11 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Type hierarchy options used during static or dynamic registration.
+      #
+      # @since 3.17.0
+      #
       class TypeHierarchyRegistrationOptions
         def initialize(document_selector:, work_done_progress: nil, id: nil)
           @attributes = {}
@@ -13,10 +18,10 @@ module LanguageServer
         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.
+        # 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]
+        # @return [DocumentSelector | nil]
         def document_selector
           attributes.fetch(:documentSelector)
         end

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

@@ -1,17 +1,27 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The parameter of a `typeHierarchy/subtypes` request.
+      #
+      # @since 3.17.0
+      #
       class TypeHierarchySubtypesParams
-        def initialize(work_done_token: nil, partial_result_token: nil, item:)
+        def initialize(item:, work_done_token: nil, partial_result_token: nil)
           @attributes = {}
 
+          @attributes[:item] = item
           @attributes[:workDoneToken] = work_done_token if work_done_token
           @attributes[:partialResultToken] = partial_result_token if partial_result_token
-          @attributes[:item] = item
 
           @attributes.freeze
         end
 
+        # @return [TypeHierarchyItem]
+        def item
+          attributes.fetch(:item)
+        end
+
         #
         # An optional token that a server can use to report work done progress.
         #
@@ -21,19 +31,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
 
-        # @return [TypeHierarchyItem]
-        def item
-          attributes.fetch(:item)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -1,17 +1,27 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The parameter of a `typeHierarchy/supertypes` request.
+      #
+      # @since 3.17.0
+      #
       class TypeHierarchySupertypesParams
-        def initialize(work_done_token: nil, partial_result_token: nil, item:)
+        def initialize(item:, work_done_token: nil, partial_result_token: nil)
           @attributes = {}
 
+          @attributes[:item] = item
           @attributes[:workDoneToken] = work_done_token if work_done_token
           @attributes[:partialResultToken] = partial_result_token if partial_result_token
-          @attributes[:item] = item
 
           @attributes.freeze
         end
 
+        # @return [TypeHierarchyItem]
+        def item
+          attributes.fetch(:item)
+        end
+
         #
         # An optional token that a server can use to report work done progress.
         #
@@ -21,19 +31,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
 
-        # @return [TypeHierarchyItem]
-        def item
-          attributes.fetch(:item)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -5,6 +5,8 @@ module LanguageServer
       # A diagnostic report indicating that the last returned
       # report is still accurate.
       #
+      # @since 3.17.0
+      #
       class UnchangedDocumentDiagnosticReport
         def initialize(kind:, result_id:)
           @attributes = {}
@@ -21,7 +23,7 @@ module LanguageServer
         # only return `unchanged` if result ids are
         # provided.
         #
-        # @return [any]
+        # @return ["unchanged"]
         def kind
           attributes.fetch(:kind)
         end

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

@@ -2,7 +2,7 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # General parameters to unregister a capability.
+      # General parameters to unregister a request or notification.
       #
       class Unregistration
         def initialize(id:, method:)
@@ -24,7 +24,7 @@ module LanguageServer
         end
 
         #
-        # The method / capability to unregister for.
+        # The method to unregister for.
         #
         # @return [string]
         def method

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

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # A versioned notebook document identifier.
       #
+      # @since 3.17.0
+      #
       class VersionedNotebookDocumentIdentifier
         def initialize(version:, uri:)
           @attributes = {}
@@ -17,15 +19,15 @@ module LanguageServer
         #
         # The version number of this notebook document.
         #
-        # @return [number]
+        # @return [integer]
         def version
           attributes.fetch(:version)
         end
 
         #
-        # The notebook document's URI.
+        # The notebook document's uri.
         #
-        # @return [string]
+        # @return [URI]
         def uri
           attributes.fetch(:uri)
         end

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

@@ -1,33 +1,33 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # A text document identifier to denote a specific version of a text document.
+      #
       class VersionedTextDocumentIdentifier
-        def initialize(uri:, version:)
+        def initialize(version:, uri:)
           @attributes = {}
 
-          @attributes[:uri] = uri
           @attributes[:version] = version
+          @attributes[:uri] = uri
 
           @attributes.freeze
         end
 
         #
-        # The text document's URI.
+        # The version number of this document.
         #
-        # @return [string]
-        def uri
-          attributes.fetch(:uri)
+        # @return [integer]
+        def version
+          attributes.fetch(:version)
         end
 
         #
-        # The version number of this document.
-        #
-        # The version number of a document will increase after each change,
-        # including undo/redo. The number doesn't need to be consecutive.
+        # The text document's uri.
         #
-        # @return [number]
-        def version
-          attributes.fetch(:version)
+        # @return [DocumentUri]
+        def uri
+          attributes.fetch(:uri)
         end
 
         attr_reader :attributes

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

@@ -2,7 +2,7 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # The parameters send in a will save text document notification.
+      # The parameters sent in a will save text document notification.
       #
       class WillSaveTextDocumentParams
         def initialize(text_document:, reason:)

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

@@ -0,0 +1,63 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class WindowClientCapabilities
+        def initialize(work_done_progress: nil, show_message: nil, show_document: nil)
+          @attributes = {}
+
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:showMessage] = show_message if show_message
+          @attributes[:showDocument] = show_document if show_document
+
+          @attributes.freeze
+        end
+
+        #
+        # It indicates whether the client supports server initiated
+        # progress using the `window/workDoneProgress/create` request.
+        #
+        # The capability also controls Whether client supports handling
+        # of progress notifications. If set servers are allowed to report a
+        # `workDoneProgress` property in the request specific server
+        # capabilities.
+        #
+        # @since 3.15.0
+        #
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
+        #
+        # Capabilities specific to the showMessage request.
+        #
+        # @since 3.16.0
+        #
+        # @return [ShowMessageRequestClientCapabilities]
+        def show_message
+          attributes.fetch(:showMessage)
+        end
+
+        #
+        # Capabilities specific to the showDocument request.
+        #
+        # @since 3.16.0
+        #
+        # @return [ShowDocumentClientCapabilities]
+        def show_document
+          attributes.fetch(:showDocument)
+        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/work_done_progress_begin.rb

@@ -32,8 +32,8 @@ module LanguageServer
 
         #
         # Controls if a cancel button should show to allow the user to cancel the
-        # long running operation. Clients that don't support cancellation are
-        # allowed to ignore the setting.
+        # long running operation. Clients that don't support cancellation are allowed
+        # to ignore the setting.
         #
         # @return [boolean]
         def cancellable
@@ -58,9 +58,9 @@ module LanguageServer
         # to ignore the `percentage` value in subsequent in report notifications.
         #
         # The value should be steadily rising. Clients are free to ignore values
-        # that are not following this rule. The value range is [0, 100]
+        # that are not following this rule. The value range is [0, 100].
         #
-        # @return [number]
+        # @return [uinteger]
         def percentage
           attributes.fetch(:percentage)
         end

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

@@ -19,11 +19,10 @@ module LanguageServer
         end
 
         #
-        # Controls enablement state of a cancel button. This property is only valid
-        # if a cancel button got requested in the `WorkDoneProgressBegin` payload.
+        # Controls enablement state of a cancel button.
         #
-        # Clients that don't support cancellation or don't support control the
-        # button's enablement state are allowed to ignore the setting.
+        # Clients that don't support cancellation or don't support controlling the button's
+        # enablement state are allowed to ignore the property.
         #
         # @return [boolean]
         def cancellable
@@ -50,7 +49,7 @@ module LanguageServer
         # The value should be steadily rising. Clients are free to ignore values
         # that are not following this rule. The value range is [0, 100]
         #
-        # @return [number]
+        # @return [uinteger]
         def percentage
           attributes.fetch(:percentage)
         end

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

@@ -0,0 +1,176 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Workspace specific client capabilities.
+      #
+      class WorkspaceClientCapabilities
+        def initialize(apply_edit: nil, workspace_edit: nil, did_change_configuration: nil, did_change_watched_files: nil, symbol: nil, execute_command: nil, workspace_folders: nil, configuration: nil, semantic_tokens: nil, code_lens: nil, file_operations: nil, inline_value: nil, inlay_hint: nil, diagnostics: nil)
+          @attributes = {}
+
+          @attributes[:applyEdit] = apply_edit if apply_edit
+          @attributes[:workspaceEdit] = workspace_edit if workspace_edit
+          @attributes[:didChangeConfiguration] = did_change_configuration if did_change_configuration
+          @attributes[:didChangeWatchedFiles] = did_change_watched_files if did_change_watched_files
+          @attributes[:symbol] = symbol if symbol
+          @attributes[:executeCommand] = execute_command if execute_command
+          @attributes[:workspaceFolders] = workspace_folders if workspace_folders
+          @attributes[:configuration] = configuration if configuration
+          @attributes[:semanticTokens] = semantic_tokens if semantic_tokens
+          @attributes[:codeLens] = code_lens if code_lens
+          @attributes[:fileOperations] = file_operations if file_operations
+          @attributes[:inlineValue] = inline_value if inline_value
+          @attributes[:inlayHint] = inlay_hint if inlay_hint
+          @attributes[:diagnostics] = diagnostics if diagnostics
+
+          @attributes.freeze
+        end
+
+        #
+        # The client supports applying batch edits
+        # to the workspace by supporting the request
+        # 'workspace/applyEdit'
+        #
+        # @return [boolean]
+        def apply_edit
+          attributes.fetch(:applyEdit)
+        end
+
+        #
+        # Capabilities specific to `WorkspaceEdit`s.
+        #
+        # @return [WorkspaceEditClientCapabilities]
+        def workspace_edit
+          attributes.fetch(:workspaceEdit)
+        end
+
+        #
+        # Capabilities specific to the `workspace/didChangeConfiguration` notification.
+        #
+        # @return [DidChangeConfigurationClientCapabilities]
+        def did_change_configuration
+          attributes.fetch(:didChangeConfiguration)
+        end
+
+        #
+        # Capabilities specific to the `workspace/didChangeWatchedFiles` notification.
+        #
+        # @return [DidChangeWatchedFilesClientCapabilities]
+        def did_change_watched_files
+          attributes.fetch(:didChangeWatchedFiles)
+        end
+
+        #
+        # Capabilities specific to the `workspace/symbol` request.
+        #
+        # @return [WorkspaceSymbolClientCapabilities]
+        def symbol
+          attributes.fetch(:symbol)
+        end
+
+        #
+        # Capabilities specific to the `workspace/executeCommand` request.
+        #
+        # @return [ExecuteCommandClientCapabilities]
+        def execute_command
+          attributes.fetch(:executeCommand)
+        end
+
+        #
+        # The client has support for workspace folders.
+        #
+        # @since 3.6.0
+        #
+        # @return [boolean]
+        def workspace_folders
+          attributes.fetch(:workspaceFolders)
+        end
+
+        #
+        # The client supports `workspace/configuration` requests.
+        #
+        # @since 3.6.0
+        #
+        # @return [boolean]
+        def configuration
+          attributes.fetch(:configuration)
+        end
+
+        #
+        # Capabilities specific to the semantic token requests scoped to the
+        # workspace.
+        #
+        # @since 3.16.0.
+        #
+        # @return [SemanticTokensWorkspaceClientCapabilities]
+        def semantic_tokens
+          attributes.fetch(:semanticTokens)
+        end
+
+        #
+        # Capabilities specific to the code lens requests scoped to the
+        # workspace.
+        #
+        # @since 3.16.0.
+        #
+        # @return [CodeLensWorkspaceClientCapabilities]
+        def code_lens
+          attributes.fetch(:codeLens)
+        end
+
+        #
+        # The client has support for file notifications/requests for user operations on files.
+        #
+        # Since 3.16.0
+        #
+        # @return [FileOperationClientCapabilities]
+        def file_operations
+          attributes.fetch(:fileOperations)
+        end
+
+        #
+        # Capabilities specific to the inline values requests scoped to the
+        # workspace.
+        #
+        # @since 3.17.0.
+        #
+        # @return [InlineValueWorkspaceClientCapabilities]
+        def inline_value
+          attributes.fetch(:inlineValue)
+        end
+
+        #
+        # Capabilities specific to the inlay hint requests scoped to the
+        # workspace.
+        #
+        # @since 3.17.0.
+        #
+        # @return [InlayHintWorkspaceClientCapabilities]
+        def inlay_hint
+          attributes.fetch(:inlayHint)
+        end
+
+        #
+        # Capabilities specific to the diagnostic requests scoped to the
+        # workspace.
+        #
+        # @since 3.17.0.
+        #
+        # @return [DiagnosticWorkspaceClientCapabilities]
+        def diagnostics
+          attributes.fetch(:diagnostics)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end