language_server-protocol 3.16.0.3 → 3.17.0.0

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 | nil]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
+        #
+        # Capabilities specific to the showMessage request.
+        #
+        # @since 3.16.0
+        #
+        # @return [ShowMessageRequestClientCapabilities | nil]
+        def show_message
+          attributes.fetch(:showMessage)
+        end
+
+        #
+        # Capabilities specific to the showDocument request.
+        #
+        # @since 3.16.0
+        #
+        # @return [ShowDocumentClientCapabilities | nil]
+        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,10 +32,10 @@ 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]
+        # @return [boolean | nil]
         def cancellable
           attributes.fetch(:cancellable)
         end
@@ -47,7 +47,7 @@ module LanguageServer
         # Examples: "3/25 files", "project/src/module2", "node_modules/some_dep".
         # If unset, the previous progress message (if any) is still valid.
         #
-        # @return [string]
+        # @return [string | nil]
         def message
           attributes.fetch(:message)
         end
@@ -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 | nil]
         def percentage
           attributes.fetch(:percentage)
         end

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

@@ -20,7 +20,7 @@ module LanguageServer
         # Optional, a final message indicating to for example indicate the outcome
         # of the operation.
         #
-        # @return [string]
+        # @return [string | nil]
         def message
           attributes.fetch(:message)
         end

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

@@ -10,7 +10,7 @@ module LanguageServer
           @attributes.freeze
         end
 
-        # @return [boolean]
+        # @return [boolean | nil]
         def work_done_progress
           attributes.fetch(:workDoneProgress)
         end

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

@@ -13,7 +13,7 @@ module LanguageServer
         #
         # 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

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

@@ -19,13 +19,12 @@ module LanguageServer
         end
 
         #
-        # Controls enablement state of a cancel button. This property is only valid
-        # if a cancel button got requested in the `WorkDoneProgressStart` 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]
+        # @return [boolean | nil]
         def cancellable
           attributes.fetch(:cancellable)
         end
@@ -37,7 +36,7 @@ module LanguageServer
         # Examples: "3/25 files", "project/src/module2", "node_modules/some_dep".
         # If unset, the previous progress message (if any) is still valid.
         #
-        # @return [string]
+        # @return [string | nil]
         def message
           attributes.fetch(:message)
         end
@@ -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 | nil]
         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 | nil]
+        def apply_edit
+          attributes.fetch(:applyEdit)
+        end
+
+        #
+        # Capabilities specific to `WorkspaceEdit`s.
+        #
+        # @return [WorkspaceEditClientCapabilities | nil]
+        def workspace_edit
+          attributes.fetch(:workspaceEdit)
+        end
+
+        #
+        # Capabilities specific to the `workspace/didChangeConfiguration` notification.
+        #
+        # @return [DidChangeConfigurationClientCapabilities | nil]
+        def did_change_configuration
+          attributes.fetch(:didChangeConfiguration)
+        end
+
+        #
+        # Capabilities specific to the `workspace/didChangeWatchedFiles` notification.
+        #
+        # @return [DidChangeWatchedFilesClientCapabilities | nil]
+        def did_change_watched_files
+          attributes.fetch(:didChangeWatchedFiles)
+        end
+
+        #
+        # Capabilities specific to the `workspace/symbol` request.
+        #
+        # @return [WorkspaceSymbolClientCapabilities | nil]
+        def symbol
+          attributes.fetch(:symbol)
+        end
+
+        #
+        # Capabilities specific to the `workspace/executeCommand` request.
+        #
+        # @return [ExecuteCommandClientCapabilities | nil]
+        def execute_command
+          attributes.fetch(:executeCommand)
+        end
+
+        #
+        # The client has support for workspace folders.
+        #
+        # @since 3.6.0
+        #
+        # @return [boolean | nil]
+        def workspace_folders
+          attributes.fetch(:workspaceFolders)
+        end
+
+        #
+        # The client supports `workspace/configuration` requests.
+        #
+        # @since 3.6.0
+        #
+        # @return [boolean | nil]
+        def configuration
+          attributes.fetch(:configuration)
+        end
+
+        #
+        # Capabilities specific to the semantic token requests scoped to the
+        # workspace.
+        #
+        # @since 3.16.0.
+        #
+        # @return [SemanticTokensWorkspaceClientCapabilities | nil]
+        def semantic_tokens
+          attributes.fetch(:semanticTokens)
+        end
+
+        #
+        # Capabilities specific to the code lens requests scoped to the
+        # workspace.
+        #
+        # @since 3.16.0.
+        #
+        # @return [CodeLensWorkspaceClientCapabilities | nil]
+        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 | nil]
+        def file_operations
+          attributes.fetch(:fileOperations)
+        end
+
+        #
+        # Capabilities specific to the inline values requests scoped to the
+        # workspace.
+        #
+        # @since 3.17.0.
+        #
+        # @return [InlineValueWorkspaceClientCapabilities | nil]
+        def inline_value
+          attributes.fetch(:inlineValue)
+        end
+
+        #
+        # Capabilities specific to the inlay hint requests scoped to the
+        # workspace.
+        #
+        # @since 3.17.0.
+        #
+        # @return [InlayHintWorkspaceClientCapabilities | nil]
+        def inlay_hint
+          attributes.fetch(:inlayHint)
+        end
+
+        #
+        # Capabilities specific to the diagnostic requests scoped to the
+        # workspace.
+        #
+        # @since 3.17.0.
+        #
+        # @return [DiagnosticWorkspaceClientCapabilities | nil]
+        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

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

@@ -0,0 +1,67 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Parameters of the workspace diagnostic request.
+      #
+      # @since 3.17.0
+      #
+      class WorkspaceDiagnosticParams
+        def initialize(identifier: nil, previous_result_ids:, work_done_token: nil, partial_result_token: nil)
+          @attributes = {}
+
+          @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
+
+        #
+        # The additional identifier provided during registration.
+        #
+        # @return [string | nil]
+        def identifier
+          attributes.fetch(:identifier)
+        end
+
+        #
+        # The currently known diagnostic reports with their
+        # previous result ids.
+        #
+        # @return [PreviousResultId[]]
+        def previous_result_ids
+          attributes.fetch(:previousResultIds)
+        end
+
+        #
+        # An optional token that a server can use to report work done progress.
+        #
+        # @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.
+        #
+        # @return [ProgressToken | nil]
+        def partial_result_token
+          attributes.fetch(:partialResultToken)
+        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_diagnostic_report.rb

@@ -0,0 +1,35 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A workspace diagnostic report.
+      #
+      # @since 3.17.0
+      #
+      class WorkspaceDiagnosticReport
+        def initialize(items:)
+          @attributes = {}
+
+          @attributes[:items] = items
+
+          @attributes.freeze
+        end
+
+        # @return [WorkspaceDocumentDiagnosticReport[]]
+        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_diagnostic_report_partial_result.rb

@@ -0,0 +1,35 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A partial result for a workspace diagnostic report.
+      #
+      # @since 3.17.0
+      #
+      class WorkspaceDiagnosticReportPartialResult
+        def initialize(items:)
+          @attributes = {}
+
+          @attributes[:items] = items
+
+          @attributes.freeze
+        end
+
+        # @return [WorkspaceDocumentDiagnosticReport[]]
+        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_document_diagnostic_report.rb

@@ -0,0 +1,77 @@
+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:)
+          @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_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[] | nil]
         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[] | nil]
         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 | nil]
         def change_annotations
           attributes.fetch(:changeAnnotations)
         end