language_server-protocol 3.17.0.5 → 3.18.0.0.pre.1

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

@@ -0,0 +1,198 @@
+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, folding_range: nil, text_document_content: nil)
+          @attributes = {}
+
+          @attributes[:applyEdit] = apply_edit unless apply_edit.nil?
+          @attributes[:workspaceEdit] = workspace_edit unless workspace_edit.nil?
+          @attributes[:didChangeConfiguration] = did_change_configuration unless did_change_configuration.nil?
+          @attributes[:didChangeWatchedFiles] = did_change_watched_files unless did_change_watched_files.nil?
+          @attributes[:symbol] = symbol unless symbol.nil?
+          @attributes[:executeCommand] = execute_command unless execute_command.nil?
+          @attributes[:workspaceFolders] = workspace_folders unless workspace_folders.nil?
+          @attributes[:configuration] = configuration unless configuration.nil?
+          @attributes[:semanticTokens] = semantic_tokens unless semantic_tokens.nil?
+          @attributes[:codeLens] = code_lens unless code_lens.nil?
+          @attributes[:fileOperations] = file_operations unless file_operations.nil?
+          @attributes[:inlineValue] = inline_value unless inline_value.nil?
+          @attributes[:inlayHint] = inlay_hint unless inlay_hint.nil?
+          @attributes[:diagnostics] = diagnostics unless diagnostics.nil?
+          @attributes[:foldingRange] = folding_range unless folding_range.nil?
+          @attributes[:textDocumentContent] = text_document_content unless text_document_content.nil?
+
+          @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
+
+        #
+        # Capabilities specific to the folding range requests scoped to the workspace.
+        #
+        # @since 3.18.0
+        #
+        # @return [FoldingRangeWorkspaceClientCapabilities]
+        def folding_range
+          attributes.fetch(:foldingRange)
+        end
+
+        #
+        # Capabilities specific to the `workspace/textDocumentContent` request.
+        #
+        # @since 3.18.0
+        #
+        # @return [TextDocumentContentClientCapabilities]
+        def text_document_content
+          attributes.fetch(:textDocumentContent)
+        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

@@ -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[:identifier] = identifier unless identifier.nil?
           @attributes[:previousResultIds] = previous_result_ids
+          @attributes[:workDoneToken] = work_done_token unless work_done_token.nil?
+          @attributes[:partialResultToken] = partial_result_token unless partial_result_token.nil?
 
           @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 unless result_id.nil?
+          @attributes[:items] = items unless items.nil?
+
+          @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,13 +1,27 @@
 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 = {}
 
-          @attributes[:changes] = changes if changes
-          @attributes[:documentChanges] = document_changes if document_changes
-          @attributes[:changeAnnotations] = change_annotations if change_annotations
+          @attributes[:changes] = changes unless changes.nil?
+          @attributes[:documentChanges] = document_changes unless document_changes.nil?
+          @attributes[:changeAnnotations] = change_annotations unless change_annotations.nil?
 
           @attributes.freeze
         end
@@ -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

@@ -2,14 +2,16 @@ module LanguageServer
   module Protocol
     module Interface
       class WorkspaceEditClientCapabilities
-        def initialize(document_changes: nil, resource_operations: nil, failure_handling: nil, normalizes_line_endings: nil, change_annotation_support: nil)
+        def initialize(document_changes: nil, resource_operations: nil, failure_handling: nil, normalizes_line_endings: nil, change_annotation_support: nil, metadata_support: nil, snippet_edit_support: nil)
           @attributes = {}
 
-          @attributes[:documentChanges] = document_changes if document_changes
-          @attributes[:resourceOperations] = resource_operations if resource_operations
-          @attributes[:failureHandling] = failure_handling if failure_handling
-          @attributes[:normalizesLineEndings] = normalizes_line_endings if normalizes_line_endings
-          @attributes[:changeAnnotationSupport] = change_annotation_support if change_annotation_support
+          @attributes[:documentChanges] = document_changes unless document_changes.nil?
+          @attributes[:resourceOperations] = resource_operations unless resource_operations.nil?
+          @attributes[:failureHandling] = failure_handling unless failure_handling.nil?
+          @attributes[:normalizesLineEndings] = normalizes_line_endings unless normalizes_line_endings.nil?
+          @attributes[:changeAnnotationSupport] = change_annotation_support unless change_annotation_support.nil?
+          @attributes[:metadataSupport] = metadata_support unless metadata_support.nil?
+          @attributes[:snippetEditSupport] = snippet_edit_support unless snippet_edit_support.nil?
 
           @attributes.freeze
         end
@@ -26,6 +28,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 +39,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 +50,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,11 +64,33 @@ 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 [ChangeAnnotationsSupportOptions]
         def change_annotation_support
           attributes.fetch(:changeAnnotationSupport)
         end
 
+        #
+        # Whether the client supports `WorkspaceEditMetadata` in `WorkspaceEdit`s.
+        #
+        # @since 3.18.0
+        #
+        # @return [boolean]
+        def metadata_support
+          attributes.fetch(:metadataSupport)
+        end
+
+        #
+        # Whether the client supports snippets as text edits.
+        #
+        # @since 3.18.0
+        #
+        # @return [boolean]
+        def snippet_edit_support
+          attributes.fetch(:snippetEditSupport)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -0,0 +1,38 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Additional data about a workspace edit.
+      #
+      # @since 3.18.0
+      #
+      class WorkspaceEditMetadata
+        def initialize(is_refactoring: nil)
+          @attributes = {}
+
+          @attributes[:isRefactoring] = is_refactoring unless is_refactoring.nil?
+
+          @attributes.freeze
+        end
+
+        #
+        # Signal to the editor that this edit is a refactoring.
+        #
+        # @return [boolean]
+        def is_refactoring
+          attributes.fetch(:isRefactoring)
+        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_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 unless workspace_folders.nil?
+
+          @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

@@ -5,8 +5,8 @@ module LanguageServer
         def initialize(supported: nil, change_notifications: nil)
           @attributes = {}
 
-          @attributes[:supported] = supported if supported
-          @attributes[:changeNotifications] = change_notifications if change_notifications
+          @attributes[:supported] = supported unless supported.nil?
+          @attributes[:changeNotifications] = change_notifications unless change_notifications.nil?
 
           @attributes.freeze
         end
@@ -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.