language_server-protocol 3.17.0.0 → 3.17.0.2

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

@@ -4,40 +4,24 @@ module LanguageServer
       #
       # An unchanged diagnostic report with a set of related documents.
       #
-      # @since 3.17.0
-      #
       class RelatedUnchangedDocumentDiagnosticReport
-        def initialize(related_documents: nil, kind:, result_id:)
+        def initialize(kind:, result_id:, related_documents: nil)
           @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 | 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"]
+        # @return [any]
         def kind
           attributes.fetch(:kind)
         end
@@ -51,6 +35,18 @@ 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,8 +6,6 @@ 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 = {}
@@ -22,7 +20,7 @@ module LanguageServer
         # A workspace folder or a base URI to which this pattern will be matched
         # against relatively.
         #
-        # @return [WorkspaceFolder | URI]
+        # @return [string | WorkspaceFolder]
         def base_uri
           attributes.fetch(:baseUri)
         end
@@ -30,7 +28,7 @@ module LanguageServer
         #
         # The actual glob pattern;
         #
-        # @return [Pattern]
+        # @return [string]
         def pattern
           attributes.fetch(:pattern)
         end

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

@@ -16,7 +16,7 @@ module LanguageServer
         #
         # Whether rename supports dynamic registration.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end
@@ -25,36 +25,31 @@ module LanguageServer
         # Client supports testing for validity of rename operations
         # before execution.
         #
-        # @since 3.12.0
-        #
-        # @return [boolean | nil]
+        # @return [boolean]
         def prepare_support
           attributes.fetch(:prepareSupport)
         end
 
         #
-        # Client supports the default behavior result.
+        # Client supports the default behavior result
+        # (`{ defaultBehavior: boolean }`).
         #
         # The value indicates the default behavior used by the
         # client.
         #
-        # @since 3.16.0
-        #
-        # @return [PrepareSupportDefaultBehavior | nil]
+        # @return [1]
         def prepare_support_default_behavior
           attributes.fetch(:prepareSupportDefaultBehavior)
         end
 
         #
-        # Whether the client honors the change annotations in
+        # Whether th 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.
         #
-        # @since 3.16.0
-        #
-        # @return [boolean | nil]
+        # @return [boolean]
         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 [DocumentUri]
+        # @return [string]
         def old_uri
           attributes.fetch(:oldUri)
         end
@@ -36,7 +36,7 @@ module LanguageServer
         #
         # The new location.
         #
-        # @return [DocumentUri]
+        # @return [string]
         def new_uri
           attributes.fetch(:newUri)
         end
@@ -44,7 +44,7 @@ module LanguageServer
         #
         # Rename options.
         #
-        # @return [RenameFileOptions | nil]
+        # @return [RenameFileOptions]
         def options
           attributes.fetch(:options)
         end
@@ -52,9 +52,7 @@ module LanguageServer
         #
         # An optional annotation identifier describing the operation.
         #
-        # @since 3.16.0
-        #
-        # @return [ChangeAnnotationIdentifier | nil]
+        # @return [string]
         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 | nil]
+        # @return [boolean]
         def overwrite
           attributes.fetch(:overwrite)
         end
@@ -25,7 +25,7 @@ module LanguageServer
         #
         # Ignores if target exists.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def ignore_if_exists
           attributes.fetch(:ignoreIfExists)
         end

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

@@ -2,10 +2,8 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # The parameters sent in notifications/requests for user-initiated renames of
-      # files.
-      #
-      # @since 3.16.0
+      # The parameters sent in notifications/requests for user-initiated renames
+      # of files.
       #
       class RenameFilesParams
         def initialize(files:)
@@ -17,8 +15,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,34 +1,29 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Provider options for a [RenameRequest](#RenameRequest).
-      #
       class RenameOptions
-        def initialize(prepare_provider: nil, work_done_progress: nil)
+        def initialize(work_done_progress: nil, prepare_provider: nil)
           @attributes = {}
 
-          @attributes[:prepareProvider] = prepare_provider if prepare_provider
           @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:prepareProvider] = prepare_provider if prepare_provider
 
           @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 | nil]
+        # @return [boolean]
         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,23 +1,20 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # The parameters of a [RenameRequest](#RenameRequest).
-      #
       class RenameParams
-        def initialize(text_document:, position:, new_name:, work_done_token: nil)
+        def initialize(text_document:, position:, work_done_token: nil, new_name:)
           @attributes = {}
 
           @attributes[:textDocument] = text_document
           @attributes[:position] = position
-          @attributes[:newName] = new_name
           @attributes[:workDoneToken] = work_done_token if work_done_token
+          @attributes[:newName] = new_name
 
           @attributes.freeze
         end
 
         #
-        # The document to rename.
+        # The text document.
         #
         # @return [TextDocumentIdentifier]
         def text_document
@@ -25,13 +22,21 @@ module LanguageServer
         end
 
         #
-        # The position at which this request was sent.
+        # The position inside the text document.
         #
         # @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
@@ -42,14 +47,6 @@ 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,44 +1,39 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Registration options for a [RenameRequest](#RenameRequest).
-      #
       class RenameRegistrationOptions
-        def initialize(document_selector:, prepare_provider: nil, work_done_progress: nil)
+        def initialize(document_selector:, work_done_progress: nil, prepare_provider: nil)
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @attributes[:prepareProvider] = prepare_provider if prepare_provider
           @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:prepareProvider] = prepare_provider if prepare_provider
 
           @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 | null]
+        # @return [DocumentSelector]
         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 | nil]
+        # @return [boolean]
         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/request_message.rb

@@ -0,0 +1,57 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class RequestMessage
+        def initialize(jsonrpc:, id:, method:, params: nil)
+          @attributes = {}
+
+          @attributes[:jsonrpc] = jsonrpc
+          @attributes[:id] = id
+          @attributes[:method] = method
+          @attributes[:params] = params if params
+
+          @attributes.freeze
+        end
+
+        # @return [string]
+        def jsonrpc
+          attributes.fetch(:jsonrpc)
+        end
+
+        #
+        # The request id.
+        #
+        # @return [string | number]
+        def id
+          attributes.fetch(:id)
+        end
+
+        #
+        # The method to be invoked.
+        #
+        # @return [string]
+        def method
+          attributes.fetch(:method)
+        end
+
+        #
+        # The method's params.
+        #
+        # @return [any]
+        def params
+          attributes.fetch(:params)
+        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/response_error.rb

@@ -0,0 +1,52 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class ResponseError
+        def initialize(code:, message:, data: nil)
+          @attributes = {}
+
+          @attributes[:code] = code
+          @attributes[:message] = message
+          @attributes[:data] = data if data
+
+          @attributes.freeze
+        end
+
+        #
+        # A number indicating the error type that occurred.
+        #
+        # @return [number]
+        def code
+          attributes.fetch(:code)
+        end
+
+        #
+        # A string providing a short description of the error.
+        #
+        # @return [string]
+        def message
+          attributes.fetch(:message)
+        end
+
+        #
+        # A primitive or structured value that contains additional
+        # information about the error. Can be omitted.
+        #
+        # @return [any]
+        def data
+          attributes.fetch(:data)
+        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/response_message.rb

@@ -0,0 +1,58 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class ResponseMessage
+        def initialize(jsonrpc:, id:, result: nil, error: nil)
+          @attributes = {}
+
+          @attributes[:jsonrpc] = jsonrpc
+          @attributes[:id] = id
+          @attributes[:result] = result if result
+          @attributes[:error] = error if error
+
+          @attributes.freeze
+        end
+
+        # @return [string]
+        def jsonrpc
+          attributes.fetch(:jsonrpc)
+        end
+
+        #
+        # The request id.
+        #
+        # @return [string | number]
+        def id
+          attributes.fetch(:id)
+        end
+
+        #
+        # The result of a request. This member is REQUIRED on success.
+        # This member MUST NOT exist if there was an error invoking the method.
+        #
+        # @return [string | number | boolean | object]
+        def result
+          attributes.fetch(:result)
+        end
+
+        #
+        # The error object in case a request fails.
+        #
+        # @return [ResponseError]
+        def error
+          attributes.fetch(:error)
+        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,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Save options.
-      #
       class SaveOptions
         def initialize(include_text: nil)
           @attributes = {}
@@ -16,7 +13,7 @@ module LanguageServer
         #
         # The client is supposed to include the content on save.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def include_text
           attributes.fetch(:includeText)
         end

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

@@ -1,10 +1,6 @@
 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 = {}
@@ -24,9 +20,10 @@ 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 | nil]
+        # @return [SelectionRange]
         def parent
           attributes.fetch(:parent)
         end

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

@@ -11,11 +11,12 @@ 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 | nil]
+        # @return [boolean]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end

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

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