language_server-protocol 3.16.0.1 → 3.17.0.0

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

@@ -1,19 +1,27 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Parameters for a [ReferencesRequest](#ReferencesRequest).
+      #
       class ReferenceParams
-        def initialize(text_document:, position:, work_done_token: nil, partial_result_token: nil, context:)
+        def initialize(context:, text_document:, position:, work_done_token: nil, partial_result_token: nil)
           @attributes = {}
 
+          @attributes[:context] = context
           @attributes[:textDocument] = text_document
           @attributes[:position] = position
           @attributes[:workDoneToken] = work_done_token if work_done_token
           @attributes[:partialResultToken] = partial_result_token if partial_result_token
-          @attributes[:context] = context
 
           @attributes.freeze
         end
 
+        # @return [ReferenceContext]
+        def context
+          attributes.fetch(:context)
+        end
+
         #
         # The text document.
         #
@@ -33,25 +41,20 @@ 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
 
         #
-        # 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]
+        # @return [ProgressToken | nil]
         def partial_result_token
           attributes.fetch(:partialResultToken)
         end
 
-        # @return [ReferenceContext]
-        def context
-          attributes.fetch(:context)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Registration options for a [ReferencesRequest](#ReferencesRequest).
+      #
       class ReferenceRegistrationOptions
         def initialize(document_selector:, work_done_progress: nil)
           @attributes = {}
@@ -12,15 +15,15 @@ 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 | null]
         def document_selector
           attributes.fetch(:documentSelector)
         end
 
-        # @return [boolean]
+        # @return [boolean | nil]
         def work_done_progress
           attributes.fetch(:workDoneProgress)
         end

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

@@ -2,7 +2,7 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # General parameters to register for a capability.
+      # General parameters to to register for an notification or to register a provider.
       #
       class Registration
         def initialize(id:, method:, register_options: nil)
@@ -35,7 +35,7 @@ module LanguageServer
         #
         # Options necessary for the registration.
         #
-        # @return [any]
+        # @return [LSPAny | nil]
         def register_options
           attributes.fetch(:registerOptions)
         end

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

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # Client capabilities specific to regular expressions.
       #
+      # @since 3.16.0
+      #
       class RegularExpressionsClientCapabilities
         def initialize(engine:, version: nil)
           @attributes = {}
@@ -25,7 +27,7 @@ module LanguageServer
         #
         # The engine's version.
         #
-        # @return [string]
+        # @return [string | nil]
         def version
           attributes.fetch(:version)
         end

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

@@ -0,0 +1,73 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A full diagnostic report with a set of related documents.
+      #
+      # @since 3.17.0
+      #
+      class RelatedFullDocumentDiagnosticReport
+        def initialize(related_documents: nil, kind:, result_id: nil, items:)
+          @attributes = {}
+
+          @attributes[:relatedDocuments] = related_documents if related_documents
+          @attributes[:kind] = kind
+          @attributes[:resultId] = result_id if result_id
+          @attributes[:items] = items
+
+          @attributes.freeze
+        end
+
+        #
+        # Diagnostics of related documents. This information is useful
+        # in programming languages where code in a file A can generate
+        # diagnostics in a file B which A depends on. An example of
+        # such a language is C/C++ where marco definitions in a file
+        # a.cpp and result in errors in a header file b.hpp.
+        #
+        # @since 3.17.0
+        #
+        # @return [DocumentUri => FullDocumentDiagnosticReport | UnchangedDocumentDiagnosticReport | nil]
+        def related_documents
+          attributes.fetch(:relatedDocuments)
+        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/related_unchanged_document_diagnostic_report.rb

@@ -0,0 +1,66 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # An unchanged diagnostic report with a set of related documents.
+      #
+      # @since 3.17.0
+      #
+      class RelatedUnchangedDocumentDiagnosticReport
+        def initialize(related_documents: nil, kind:, result_id:)
+          @attributes = {}
+
+          @attributes[:relatedDocuments] = related_documents if related_documents
+          @attributes[:kind] = kind
+          @attributes[:resultId] = result_id
+
+          @attributes.freeze
+        end
+
+        #
+        # Diagnostics of related documents. This information is useful
+        # in programming languages where code in a file A can generate
+        # diagnostics in a file B which A depends on. An example of
+        # such a language is C/C++ where marco definitions in a file
+        # a.cpp and result in errors in a header file b.hpp.
+        #
+        # @since 3.17.0
+        #
+        # @return [DocumentUri => FullDocumentDiagnosticReport | UnchangedDocumentDiagnosticReport | nil]
+        def related_documents
+          attributes.fetch(:relatedDocuments)
+        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"]
+        def kind
+          attributes.fetch(:kind)
+        end
+
+        #
+        # 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
+
+        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/relative_pattern.rb

@@ -0,0 +1,50 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A relative pattern is a helper to construct glob patterns that are matched
+      # relatively to a base URI. The common value for a `baseUri` is a workspace
+      # folder root, but it can be another absolute URI as well.
+      #
+      # @since 3.17.0
+      #
+      class RelativePattern
+        def initialize(base_uri:, pattern:)
+          @attributes = {}
+
+          @attributes[:baseUri] = base_uri
+          @attributes[:pattern] = pattern
+
+          @attributes.freeze
+        end
+
+        #
+        # A workspace folder or a base URI to which this pattern will be matched
+        # against relatively.
+        #
+        # @return [WorkspaceFolder | URI]
+        def base_uri
+          attributes.fetch(:baseUri)
+        end
+
+        #
+        # The actual glob pattern;
+        #
+        # @return [Pattern]
+        def pattern
+          attributes.fetch(:pattern)
+        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/rename_client_capabilities.rb

@@ -16,7 +16,7 @@ module LanguageServer
         #
         # Whether rename supports dynamic registration.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end
@@ -25,31 +25,36 @@ module LanguageServer
         # Client supports testing for validity of rename operations
         # before execution.
         #
-        # @return [boolean]
+        # @since 3.12.0
+        #
+        # @return [boolean | nil]
         def prepare_support
           attributes.fetch(:prepareSupport)
         end
 
         #
-        # Client supports the default behavior result
-        # (`{ defaultBehavior: boolean }`).
+        # Client supports the default behavior result.
         #
         # The value indicates the default behavior used by the
         # client.
         #
-        # @return [any]
+        # @since 3.16.0
+        #
+        # @return [PrepareSupportDefaultBehavior | nil]
         def prepare_support_default_behavior
           attributes.fetch(:prepareSupportDefaultBehavior)
         end
 
         #
-        # Whether th client honors the change annotations in
+        # Whether the client honors the change annotations in
         # text edits and resource operations returned via the
         # rename request's workspace edit by for example presenting
         # the workspace edit in the user interface and asking
         # for confirmation.
         #
-        # @return [boolean]
+        # @since 3.16.0
+        #
+        # @return [boolean | nil]
         def honors_change_annotations
           attributes.fetch(:honorsChangeAnnotations)
         end

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

@@ -28,7 +28,7 @@ module LanguageServer
         #
         # The old (existing) location.
         #
-        # @return [string]
+        # @return [DocumentUri]
         def old_uri
           attributes.fetch(:oldUri)
         end
@@ -36,7 +36,7 @@ module LanguageServer
         #
         # The new location.
         #
-        # @return [string]
+        # @return [DocumentUri]
         def new_uri
           attributes.fetch(:newUri)
         end
@@ -44,15 +44,17 @@ module LanguageServer
         #
         # Rename options.
         #
-        # @return [RenameFileOptions]
+        # @return [RenameFileOptions | nil]
         def options
           attributes.fetch(:options)
         end
 
         #
-        # An optional annotation identifer describing the operation.
+        # An optional annotation identifier describing the operation.
         #
-        # @return [string]
+        # @since 3.16.0
+        #
+        # @return [ChangeAnnotationIdentifier | nil]
         def annotation_id
           attributes.fetch(:annotationId)
         end

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

@@ -17,7 +17,7 @@ module LanguageServer
         #
         # Overwrite target if existing. Overwrite wins over `ignoreIfExists`
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def overwrite
           attributes.fetch(:overwrite)
         end
@@ -25,7 +25,7 @@ module LanguageServer
         #
         # Ignores if target exists.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def ignore_if_exists
           attributes.fetch(:ignoreIfExists)
         end

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

@@ -2,8 +2,10 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # The parameters sent in notifications/requests for user-initiated renames
-      # of files.
+      # The parameters sent in notifications/requests for user-initiated renames of
+      # files.
+      #
+      # @since 3.16.0
       #
       class RenameFilesParams
         def initialize(files:)
@@ -15,8 +17,8 @@ module LanguageServer
         end
 
         #
-        # An array of all files/folders renamed in this operation. When a folder
-        # is renamed, only the folder will be included, and not its children.
+        # An array of all files/folders renamed in this operation. When a folder is renamed, only
+        # the folder will be included, and not its children.
         #
         # @return [FileRename[]]
         def files

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

@@ -1,29 +1,34 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Provider options for a [RenameRequest](#RenameRequest).
+      #
       class RenameOptions
-        def initialize(work_done_progress: nil, prepare_provider: nil)
+        def initialize(prepare_provider: nil, work_done_progress: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
           @attributes[:prepareProvider] = prepare_provider if prepare_provider
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
 
           @attributes.freeze
         end
 
-        # @return [boolean]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         #
         # Renames should be checked and tested before being executed.
         #
-        # @return [boolean]
+        # @since version 3.12.0
+        #
+        # @return [boolean | nil]
         def prepare_provider
           attributes.fetch(:prepareProvider)
         end
 
+        # @return [boolean | nil]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -1,20 +1,23 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The parameters of a [RenameRequest](#RenameRequest).
+      #
       class RenameParams
-        def initialize(text_document:, position:, work_done_token: nil, new_name:)
+        def initialize(text_document:, position:, new_name:, work_done_token: nil)
           @attributes = {}
 
           @attributes[:textDocument] = text_document
           @attributes[:position] = position
-          @attributes[:workDoneToken] = work_done_token if work_done_token
           @attributes[:newName] = new_name
+          @attributes[:workDoneToken] = work_done_token if work_done_token
 
           @attributes.freeze
         end
 
         #
-        # The text document.
+        # The document to rename.
         #
         # @return [TextDocumentIdentifier]
         def text_document
@@ -22,21 +25,13 @@ module LanguageServer
         end
 
         #
-        # The position inside the text document.
+        # The position at which this request was sent.
         #
         # @return [Position]
         def position
           attributes.fetch(:position)
         end
 
-        #
-        # An optional token that a server can use to report work done progress.
-        #
-        # @return [ProgressToken]
-        def work_done_token
-          attributes.fetch(:workDoneToken)
-        end
-
         #
         # The new name of the symbol. If the given name is not valid the
         # request must return a [ResponseError](#ResponseError) with an
@@ -47,6 +42,14 @@ module LanguageServer
           attributes.fetch(:newName)
         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
+
         attr_reader :attributes
 
         def to_hash

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

@@ -1,39 +1,44 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Registration options for a [RenameRequest](#RenameRequest).
+      #
       class RenameRegistrationOptions
-        def initialize(document_selector:, work_done_progress: nil, prepare_provider: nil)
+        def initialize(document_selector:, prepare_provider: nil, work_done_progress: nil)
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
           @attributes[:prepareProvider] = prepare_provider if prepare_provider
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
 
           @attributes.freeze
         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 | null]
         def document_selector
           attributes.fetch(:documentSelector)
         end
 
-        # @return [boolean]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         #
         # Renames should be checked and tested before being executed.
         #
-        # @return [boolean]
+        # @since version 3.12.0
+        #
+        # @return [boolean | nil]
         def prepare_provider
           attributes.fetch(:prepareProvider)
         end
 
+        # @return [boolean | nil]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -0,0 +1,47 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A generic resource operation.
+      #
+      class ResourceOperation
+        def initialize(kind:, annotation_id: nil)
+          @attributes = {}
+
+          @attributes[:kind] = kind
+          @attributes[:annotationId] = annotation_id if annotation_id
+
+          @attributes.freeze
+        end
+
+        #
+        # The resource operation kind.
+        #
+        # @return [string]
+        def kind
+          attributes.fetch(:kind)
+        end
+
+        #
+        # An optional annotation identifier describing the operation.
+        #
+        # @since 3.16.0
+        #
+        # @return [ChangeAnnotationIdentifier | nil]
+        def annotation_id
+          attributes.fetch(:annotationId)
+        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/save_options.rb

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Save options.
+      #
       class SaveOptions
         def initialize(include_text: nil)
           @attributes = {}
@@ -13,7 +16,7 @@ module LanguageServer
         #
         # The client is supposed to include the content on save.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def include_text
           attributes.fetch(:includeText)
         end