language_server-protocol 3.15.0.1 → 3.16.0.2

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

@@ -1,13 +1,14 @@
 module LanguageServer
   module Protocol
     module Interface
-      class InitializeParams < WorkDoneProgressParams
-        def initialize(work_done_token: nil, process_id:, client_info: nil, root_path: nil, root_uri:, initialization_options: nil, capabilities:, trace: nil, workspace_folders: nil)
+      class InitializeParams
+        def initialize(work_done_token: nil, process_id:, client_info: nil, locale: nil, root_path: nil, root_uri:, initialization_options: nil, capabilities:, trace: nil, workspace_folders: nil)
           @attributes = {}
 
           @attributes[:workDoneToken] = work_done_token if work_done_token
           @attributes[:processId] = process_id
           @attributes[:clientInfo] = client_info if client_info
+          @attributes[:locale] = locale if locale
           @attributes[:rootPath] = root_path if root_path
           @attributes[:rootUri] = root_uri
           @attributes[:initializationOptions] = initialization_options if initialization_options
@@ -19,9 +20,18 @@ module LanguageServer
         end
 
         #
-        # The process Id of the parent process that started
-        # the server. Is null if the process has not been started by another process.
-        # If the parent process is not alive then the server should exit (see exit notification) its process.
+        # An optional token that a server can use to report work done progress.
+        #
+        # @return [ProgressToken]
+        def work_done_token
+          attributes.fetch(:workDoneToken)
+        end
+
+        #
+        # The process Id of the parent process that started the server. Is null if
+        # the process has not been started by another process. If the parent
+        # process is not alive then the server should exit (see exit notification)
+        # its process.
         #
         # @return [number]
         def process_id
@@ -36,6 +46,19 @@ module LanguageServer
           attributes.fetch(:clientInfo)
         end
 
+        #
+        # The locale the client is currently showing the user interface
+        # in. This must not necessarily be the locale of the operating
+        # system.
+        #
+        # Uses IETF language tags as the value's syntax
+        # (See https://en.wikipedia.org/wiki/IETF_language_tag)
+        #
+        # @return [string]
+        def locale
+          attributes.fetch(:locale)
+        end
+
         #
         # The rootPath of the workspace. Is null
         # if no folder is open.
@@ -74,7 +97,7 @@ module LanguageServer
         #
         # The initial trace setting. If omitted trace is disabled ('off').
         #
-        # @return ["off" | "messages" | "verbose"]
+        # @return [TraceValue]
         def trace
           attributes.fetch(:trace)
         end

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

@@ -0,0 +1,54 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A special text edit to provide an insert and a replace operation.
+      #
+      class InsertReplaceEdit
+        def initialize(new_text:, insert:, replace:)
+          @attributes = {}
+
+          @attributes[:newText] = new_text
+          @attributes[:insert] = insert
+          @attributes[:replace] = replace
+
+          @attributes.freeze
+        end
+
+        #
+        # The string to be inserted.
+        #
+        # @return [string]
+        def new_text
+          attributes.fetch(:newText)
+        end
+
+        #
+        # The range if the insert is requested
+        #
+        # @return [Range]
+        def insert
+          attributes.fetch(:insert)
+        end
+
+        #
+        # The range if the replace is requested.
+        #
+        # @return [Range]
+        def replace
+          attributes.fetch(:replace)
+        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/linked_editing_range_client_capabilities.rb

@@ -0,0 +1,36 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class LinkedEditingRangeClientCapabilities
+        def initialize(dynamic_registration: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+
+          @attributes.freeze
+        end
+
+        #
+        # Whether implementation supports dynamic registration.
+        # If this is set to `true` the client supports the new
+        # `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
+        # 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

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

@@ -0,0 +1,30 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class LinkedEditingRangeOptions
+        def initialize(work_done_progress: nil)
+          @attributes = {}
+
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+
+          @attributes.freeze
+        end
+
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        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/linked_editing_range_params.rb

@@ -0,0 +1,51 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class LinkedEditingRangeParams
+        def initialize(text_document:, position:, work_done_token: nil)
+          @attributes = {}
+
+          @attributes[:textDocument] = text_document
+          @attributes[:position] = position
+          @attributes[:workDoneToken] = work_done_token if work_done_token
+
+          @attributes.freeze
+        end
+
+        #
+        # The text document.
+        #
+        # @return [TextDocumentIdentifier]
+        def text_document
+          attributes.fetch(:textDocument)
+        end
+
+        #
+        # 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
+
+        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/linked_editing_range_registration_options.rb

@@ -0,0 +1,50 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class LinkedEditingRangeRegistrationOptions
+        def initialize(document_selector:, work_done_progress: nil, id: nil)
+          @attributes = {}
+
+          @attributes[:documentSelector] = document_selector
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:id] = id if id
+
+          @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.
+        #
+        # @return [DocumentSelector]
+        def document_selector
+          attributes.fetch(:documentSelector)
+        end
+
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
+        #
+        # The id used to register the request. The id can be used to deregister
+        # the request again. See also Registration#id.
+        #
+        # @return [string]
+        def id
+          attributes.fetch(:id)
+        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/linked_editing_ranges.rb

@@ -0,0 +1,45 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class LinkedEditingRanges
+        def initialize(ranges:, word_pattern: nil)
+          @attributes = {}
+
+          @attributes[:ranges] = ranges
+          @attributes[:wordPattern] = word_pattern if word_pattern
+
+          @attributes.freeze
+        end
+
+        #
+        # A list of ranges that can be renamed together. The ranges must have
+        # identical length and contain identical text content. The ranges cannot overlap.
+        #
+        # @return [Range[]]
+        def ranges
+          attributes.fetch(:ranges)
+        end
+
+        #
+        # An optional word pattern (regular expression) that describes valid contents for
+        # the given ranges. If no pattern is provided, the client configuration's word
+        # pattern will be used.
+        #
+        # @return [string]
+        def word_pattern
+          attributes.fetch(:wordPattern)
+        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/location_link.rb

@@ -16,8 +16,8 @@ module LanguageServer
         #
         # Span of the origin of this link.
         #
-        # Used as the underlined span for mouse interaction. Defaults to the word range at
-        # the mouse position.
+        # Used as the underlined span for mouse interaction. Defaults to the word
+        # range at the mouse position.
         #
         # @return [Range]
         def origin_selection_range
@@ -33,9 +33,10 @@ module LanguageServer
         end
 
         #
-        # The full target range of this link. If the target for example is a symbol then target range is the
-        # range enclosing this symbol not including leading/trailing whitespace but everything else
-        # like comments. This information is typically used to highlight the range in the editor.
+        # The full target range of this link. If the target for example is a symbol
+        # then target range is the range enclosing this symbol not including
+        # leading/trailing whitespace but everything else like comments. This
+        # information is typically used to highlight the range in the editor.
         #
         # @return [Range]
         def target_range
@@ -43,8 +44,9 @@ module LanguageServer
         end
 
         #
-        # The range that should be selected and revealed when this link is being followed, e.g the name of a function.
-        # Must be contained by the the `targetRange`. See also `DocumentSymbol#range`
+        # The range that should be selected and revealed when this link is being
+        # followed, e.g the name of a function. Must be contained by the the
+        # `targetRange`. See also `DocumentSymbol#range`
         #
         # @return [Range]
         def target_selection_range

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

@@ -14,7 +14,7 @@ module LanguageServer
         #
         # The message type. See {@link MessageType}
         #
-        # @return [number]
+        # @return [MessageType]
         def type
           attributes.fetch(:type)
         end

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

@@ -0,0 +1,43 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class LogTraceParams
+        def initialize(message:, verbose: nil)
+          @attributes = {}
+
+          @attributes[:message] = message
+          @attributes[:verbose] = verbose if verbose
+
+          @attributes.freeze
+        end
+
+        #
+        # The message to be logged.
+        #
+        # @return [string]
+        def message
+          attributes.fetch(:message)
+        end
+
+        #
+        # Additional information that can be computed if the `trace` configuration
+        # is set to `'verbose'`
+        #
+        # @return [string]
+        def verbose
+          attributes.fetch(:verbose)
+        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/markdown_client_capabilities.rb

@@ -0,0 +1,45 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Client capabilities specific to the used markdown parser.
+      #
+      class MarkdownClientCapabilities
+        def initialize(parser:, version: nil)
+          @attributes = {}
+
+          @attributes[:parser] = parser
+          @attributes[:version] = version if version
+
+          @attributes.freeze
+        end
+
+        #
+        # The name of the parser.
+        #
+        # @return [string]
+        def parser
+          attributes.fetch(:parser)
+        end
+
+        #
+        # The version of the parser.
+        #
+        # @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