language_server-protocol 3.14.0.1 → 3.16.0.0

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

@@ -1,10 +1,11 @@
 module LanguageServer
   module Protocol
     module Interface
-      class ReferenceParams < TextDocumentPositionParams
-        def initialize(text_document:, position:, context:)
+      class ReferenceParams < PartialResultParams
+        def initialize(partial_result_token: nil, context:)
           @attributes = {}
 
+          @attributes[:partialResultToken] = partial_result_token if partial_result_token
           @attributes[:context] = context
 
           @attributes.freeze

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

@@ -0,0 +1,25 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class ReferenceRegistrationOptions < ReferenceOptions
+        def initialize(work_done_progress: nil)
+          @attributes = {}
+
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+
+          @attributes.freeze
+        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/regular_expressions_client_capabilities.rb

@@ -0,0 +1,45 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Client capabilities specific to regular expressions.
+      #
+      class RegularExpressionsClientCapabilities
+        def initialize(engine:, version: nil)
+          @attributes = {}
+
+          @attributes[:engine] = engine
+          @attributes[:version] = version if version
+
+          @attributes.freeze
+        end
+
+        #
+        # The engine's name.
+        #
+        # @return [string]
+        def engine
+          attributes.fetch(:engine)
+        end
+
+        #
+        # The engine's version.
+        #
+        # @return [string]
+        def version
+          attributes.fetch(:version)
+        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

@@ -0,0 +1,69 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class RenameClientCapabilities
+        def initialize(dynamic_registration: nil, prepare_support: nil, prepare_support_default_behavior: nil, honors_change_annotations: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+          @attributes[:prepareSupport] = prepare_support if prepare_support
+          @attributes[:prepareSupportDefaultBehavior] = prepare_support_default_behavior if prepare_support_default_behavior
+          @attributes[:honorsChangeAnnotations] = honors_change_annotations if honors_change_annotations
+
+          @attributes.freeze
+        end
+
+        #
+        # Whether rename supports dynamic registration.
+        #
+        # @return [boolean]
+        def dynamic_registration
+          attributes.fetch(:dynamicRegistration)
+        end
+
+        #
+        # Client supports testing for validity of rename operations
+        # before execution.
+        #
+        # @return [boolean]
+        def prepare_support
+          attributes.fetch(:prepareSupport)
+        end
+
+        #
+        # Client supports the default behavior result
+        # (`{ defaultBehavior: boolean }`).
+        #
+        # The value indicates the default behavior used by the
+        # client.
+        #
+        # @return [any]
+        def prepare_support_default_behavior
+          attributes.fetch(:prepareSupportDefaultBehavior)
+        end
+
+        #
+        # 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.
+        #
+        # @return [boolean]
+        def honors_change_annotations
+          attributes.fetch(:honorsChangeAnnotations)
+        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_file.rb

@@ -5,13 +5,14 @@ module LanguageServer
       # Rename file operation
       #
       class RenameFile
-        def initialize(kind:, old_uri:, new_uri:, options: nil)
+        def initialize(kind:, old_uri:, new_uri:, options: nil, annotation_id: nil)
           @attributes = {}
 
           @attributes[:kind] = kind
           @attributes[:oldUri] = old_uri
           @attributes[:newUri] = new_uri
           @attributes[:options] = options if options
+          @attributes[:annotationId] = annotation_id if annotation_id
 
           @attributes.freeze
         end
@@ -48,6 +49,14 @@ module LanguageServer
           attributes.fetch(:options)
         end
 
+        #
+        # An optional annotation identifer describing the operation.
+        #
+        # @return [string]
+        def annotation_id
+          attributes.fetch(:annotationId)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -0,0 +1,38 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # The parameters sent in notifications/requests for user-initiated renames
+      # of files.
+      #
+      class RenameFilesParams
+        def initialize(files:)
+          @attributes = {}
+
+          @attributes[:files] = files
+
+          @attributes.freeze
+        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.
+        #
+        # @return [FileRename[]]
+        def files
+          attributes.fetch(:files)
+        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_options.rb

@@ -1,13 +1,11 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Rename options
-      #
-      class RenameOptions
-        def initialize(prepare_provider: nil)
+      class RenameOptions < WorkDoneProgressOptions
+        def initialize(work_done_progress: nil, prepare_provider: nil)
           @attributes = {}
 
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
           @attributes[:prepareProvider] = prepare_provider if prepare_provider
 
           @attributes.freeze

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

@@ -1,33 +1,16 @@
 module LanguageServer
   module Protocol
     module Interface
-      class RenameParams
-        def initialize(text_document:, position:, new_name:)
+      class RenameParams < WorkDoneProgressParams
+        def initialize(work_done_token: nil, new_name:)
           @attributes = {}
 
-          @attributes[:textDocument] = text_document
-          @attributes[:position] = position
+          @attributes[:workDoneToken] = work_done_token if work_done_token
           @attributes[:newName] = new_name
 
           @attributes.freeze
         end
 
-        #
-        # The document to rename.
-        #
-        # @return [TextDocumentIdentifier]
-        def text_document
-          attributes.fetch(:textDocument)
-        end
-
-        #
-        # The position at which this request was sent.
-        #
-        # @return [Position]
-        def position
-          attributes.fetch(:position)
-        end
-
         #
         # The new name of the symbol. If the given name is not valid the
         # request must return a [ResponseError](#ResponseError) with an

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

@@ -1,23 +1,16 @@
 module LanguageServer
   module Protocol
     module Interface
-      class RenameRegistrationOptions < TextDocumentRegistrationOptions
-        def initialize(document_selector:, prepare_provider: nil)
+      class RenameRegistrationOptions < RenameOptions
+        def initialize(work_done_progress: nil, prepare_provider: nil)
           @attributes = {}
 
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
           @attributes[:prepareProvider] = prepare_provider if prepare_provider
 
           @attributes.freeze
         end
 
-        #
-        # Renames should be checked and tested for validity before being executed.
-        #
-        # @return [boolean]
-        def prepare_provider
-          attributes.fetch(:prepareProvider)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -5,6 +5,7 @@ module LanguageServer
         def initialize(jsonrpc:, id:, method:, params: nil)
           @attributes = {}
 
+          @attributes[:jsonrpc] = jsonrpc
           @attributes[:id] = id
           @attributes[:method] = method
           @attributes[:params] = params if params
@@ -31,7 +32,7 @@ module LanguageServer
         #
         # The method's params.
         #
-        # @return [object | any[]]
+        # @return [any]
         def params
           attributes.fetch(:params)
         end

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

@@ -29,10 +29,10 @@ module LanguageServer
         end
 
         #
-        # A Primitive or Structured value that contains additional
+        # A primitive or structured value that contains additional
         # information about the error. Can be omitted.
         #
-        # @return [D]
+        # @return [any]
         def data
           attributes.fetch(:data)
         end

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

@@ -5,6 +5,7 @@ module LanguageServer
         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
@@ -21,10 +22,10 @@ module LanguageServer
         end
 
         #
-        # The result of a request. This can be omitted in
-        # the case of an error.
+        # 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 [any]
+        # @return [string | number | boolean | object]
         def result
           attributes.fetch(:result)
         end
@@ -32,7 +33,7 @@ module LanguageServer
         #
         # The error object in case a request fails.
         #
-        # @return [ResponseError<any>]
+        # @return [ResponseError]
         def error
           attributes.fetch(:error)
         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 = {}

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

@@ -0,0 +1,43 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class SelectionRange
+        def initialize(range:, parent: nil)
+          @attributes = {}
+
+          @attributes[:range] = range
+          @attributes[:parent] = parent if parent
+
+          @attributes.freeze
+        end
+
+        #
+        # The [range](#Range) of this selection range.
+        #
+        # @return [Range]
+        def range
+          attributes.fetch(:range)
+        end
+
+        #
+        # The parent selection range containing this range. Therefore
+        # `parent.range` must contain `this.range`.
+        #
+        # @return [SelectionRange]
+        def parent
+          attributes.fetch(:parent)
+        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/selection_range_client_capabilities.rb

@@ -0,0 +1,36 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class SelectionRangeClientCapabilities
+        def initialize(dynamic_registration: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+
+          @attributes.freeze
+        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.
+        #
+        # @return [boolean]
+        def dynamic_registration
+          attributes.fetch(:dynamicRegistration)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end