language_server-protocol 3.17.0.5 → 3.17.0.6

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Registration options for a {@link ReferencesRequest}.
+      #
       class ReferenceRegistrationOptions
         def initialize(document_selector:, work_done_progress: nil)
           @attributes = {}
@@ -12,10 +15,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/registration.rb

@@ -2,7 +2,7 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # General parameters to register for a capability.
+      # General parameters to register for a notification or to register a provider.
       #
       class Registration
         def initialize(id:, method:, register_options: nil)

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 = {}

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

@@ -4,22 +4,38 @@ module LanguageServer
       #
       # A full diagnostic report with a set of related documents.
       #
+      # @since 3.17.0
+      #
       class RelatedFullDocumentDiagnosticReport
-        def initialize(kind:, result_id: nil, items:, related_documents: nil)
+        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[:relatedDocuments] = related_documents if related_documents
 
           @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]
+        def related_documents
+          attributes.fetch(:relatedDocuments)
+        end
+
         #
         # A full document diagnostic report.
         #
-        # @return [any]
+        # @return ["full"]
         def kind
           attributes.fetch(:kind)
         end
@@ -42,18 +58,6 @@ module LanguageServer
           attributes.fetch(:items)
         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.
-        #
-        # @return [{ [uri: string]: FullDocumentDiagnosticReport | UnchangedDocumentDiagnosticReport; }]
-        def related_documents
-          attributes.fetch(:relatedDocuments)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -4,24 +4,40 @@ module LanguageServer
       #
       # An unchanged diagnostic report with a set of related documents.
       #
+      # @since 3.17.0
+      #
       class RelatedUnchangedDocumentDiagnosticReport
-        def initialize(kind:, result_id:, related_documents: nil)
+        def initialize(related_documents: nil, kind:, result_id:)
           @attributes = {}
 
+          @attributes[:relatedDocuments] = related_documents if related_documents
           @attributes[:kind] = kind
           @attributes[:resultId] = result_id
-          @attributes[:relatedDocuments] = related_documents if related_documents
 
           @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]
+        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 [any]
+        # @return ["unchanged"]
         def kind
           attributes.fetch(:kind)
         end
@@ -35,18 +51,6 @@ module LanguageServer
           attributes.fetch(:resultId)
         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.
-        #
-        # @return [{ [uri: string]: FullDocumentDiagnosticReport | UnchangedDocumentDiagnosticReport; }]
-        def related_documents
-          attributes.fetch(:relatedDocuments)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -6,6 +6,8 @@ module LanguageServer
       # 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 = {}
@@ -20,7 +22,7 @@ module LanguageServer
         # A workspace folder or a base URI to which this pattern will be matched
         # against relatively.
         #
-        # @return [string | WorkspaceFolder]
+        # @return [WorkspaceFolder | URI]
         def base_uri
           attributes.fetch(:baseUri)
         end
@@ -28,7 +30,7 @@ module LanguageServer
         #
         # The actual glob pattern;
         #
-        # @return [string]
+        # @return [Pattern]
         def pattern
           attributes.fetch(:pattern)
         end

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

@@ -25,19 +25,22 @@ module LanguageServer
         # Client supports testing for validity of rename operations
         # before execution.
         #
+        # @since 3.12.0
+        #
         # @return [boolean]
         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 [1]
+        # @since 3.16.0
+        #
+        # @return [PrepareSupportDefaultBehavior]
         def prepare_support_default_behavior
           attributes.fetch(:prepareSupportDefaultBehavior)
         end
@@ -49,6 +52,8 @@ module LanguageServer
         # the workspace edit in the user interface and asking
         # for confirmation.
         #
+        # @since 3.16.0
+        #
         # @return [boolean]
         def honors_change_annotations
           attributes.fetch(:honorsChangeAnnotations)

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
@@ -52,7 +52,9 @@ module LanguageServer
         #
         # An optional annotation identifier describing the operation.
         #
-        # @return [string]
+        # @since 3.16.0
+        #
+        # @return [ChangeAnnotationIdentifier]
         def annotation_id
           attributes.fetch(:annotationId)
         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 {@link 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.
         #
+        # @since version 3.12.0
+        #
         # @return [boolean]
         def prepare_provider
           attributes.fetch(:prepareProvider)
         end
 
+        # @return [boolean]
+        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 {@link 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,24 +25,16 @@ 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
+        # request must return a {@link ResponseError} with an
         # appropriate message set.
         #
         # @return [string]
@@ -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]
+        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 {@link 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 | nil]
         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.
         #
+        # @since version 3.12.0
+        #
         # @return [boolean]
         def prepare_provider
           attributes.fetch(:prepareProvider)
         end
 
+        # @return [boolean]
+        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]
+        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 = {}

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

@@ -1,6 +1,10 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # A selection range represents a part of a selection hierarchy. A selection range
+      # may have a parent selection range that contains it.
+      #
       class SelectionRange
         def initialize(range:, parent: nil)
           @attributes = {}
@@ -12,7 +16,7 @@ module LanguageServer
         end
 
         #
-        # The [range](#Range) of this selection range.
+        # The {@link Range range} of this selection range.
         #
         # @return [Range]
         def range
@@ -20,8 +24,7 @@ module LanguageServer
         end
 
         #
-        # The parent selection range containing this range. Therefore
-        # `parent.range` must contain `this.range`.
+        # The parent selection range containing this range. Therefore `parent.range` must contain `this.range`.
         #
         # @return [SelectionRange]
         def parent

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

@@ -11,10 +11,9 @@ module LanguageServer
         end
 
         #
-        # Whether implementation supports dynamic registration for selection range
-        # providers. If this is set to `true` the client supports the new
-        # `SelectionRangeRegistrationOptions` return value for the corresponding
-        # server capability as well.
+        # Whether implementation supports dynamic registration for selection range providers. If this is set to `true`
+        # the client supports the new `SelectionRangeRegistrationOptions` return value for the corresponding server
+        # capability as well.
         #
         # @return [boolean]
         def dynamic_registration

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

@@ -1,35 +1,21 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # A parameter literal used in selection range requests.
+      #
       class SelectionRangeParams
-        def initialize(work_done_token: nil, partial_result_token: nil, text_document:, positions:)
+        def initialize(text_document:, positions:, 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[:textDocument] = text_document
           @attributes[:positions] = positions
+          @attributes[:workDoneToken] = work_done_token if work_done_token
+          @attributes[:partialResultToken] = partial_result_token if partial_result_token
 
           @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 text document.
         #
@@ -46,6 +32,23 @@ module LanguageServer
           attributes.fetch(:positions)
         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/selection_range_registration_options.rb

@@ -18,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/semantic_tokens.rb

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # @since 3.16.0
+      #
       class SemanticTokens
         def initialize(result_id: nil, data:)
           @attributes = {}
@@ -25,7 +28,7 @@ module LanguageServer
         #
         # The actual tokens.
         #
-        # @return [number[]]
+        # @return [uinteger[]]
         def data
           attributes.fetch(:data)
         end