language_server-protocol 3.15.0.2 → 3.16.0.0

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

@@ -0,0 +1,36 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Matching options for the file operation pattern.
+      #
+      class FileOperationPatternOptions
+        def initialize(ignore_case: nil)
+          @attributes = {}
+
+          @attributes[:ignoreCase] = ignore_case if ignore_case
+
+          @attributes.freeze
+        end
+
+        #
+        # The pattern should be matched ignoring casing.
+        #
+        # @return [boolean]
+        def ignore_case
+          attributes.fetch(:ignoreCase)
+        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/file_operation_registration_options.rb

@@ -0,0 +1,36 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # The options to register for file operations.
+      #
+      class FileOperationRegistrationOptions
+        def initialize(filters:)
+          @attributes = {}
+
+          @attributes[:filters] = filters
+
+          @attributes.freeze
+        end
+
+        #
+        # The actual filters.
+        #
+        # @return [FileOperationFilter[]]
+        def filters
+          attributes.fetch(:filters)
+        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/file_rename.rb

@@ -0,0 +1,45 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Represents information on a file/folder rename.
+      #
+      class FileRename
+        def initialize(old_uri:, new_uri:)
+          @attributes = {}
+
+          @attributes[:oldUri] = old_uri
+          @attributes[:newUri] = new_uri
+
+          @attributes.freeze
+        end
+
+        #
+        # A file:// URI for the original location of the file/folder being renamed.
+        #
+        # @return [string]
+        def old_uri
+          attributes.fetch(:oldUri)
+        end
+
+        #
+        # A file:// URI for the new location of the file/folder being renamed.
+        #
+        # @return [string]
+        def new_uri
+          attributes.fetch(:newUri)
+        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/file_system_watcher.rb

@@ -18,9 +18,13 @@ module LanguageServer
         # - `*` to match one or more characters in a path segment
         # - `?` to match on one character in a path segment
         # - `**` to match any number of path segments, including none
-        # - `{}` to group conditions (e.g. `**​/*.{ts,js}` matches all TypeScript and JavaScript files)
-        # - `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
-        # - `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)
+        # - `{}` to group sub patterns into an OR expression. (e.g. `**​/*.{ts,js}`
+        # matches all TypeScript and JavaScript files)
+        # - `[]` to declare a range of characters to match in a path segment
+        # (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
+        # - `[!...]` to negate a range of characters to match in a path segment
+        # (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not
+        # `example.0`)
         #
         # @return [string]
         def glob_pattern

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

@@ -2,7 +2,9 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # Represents a folding range.
+      # Represents a folding range. To be valid, start and end line must be bigger
+      # than zero and smaller than the number of lines in the document. Clients
+      # are free to ignore invalid ranges.
       #
       class FoldingRange
         def initialize(start_line:, start_character: nil, end_line:, end_character: nil, kind: nil)
@@ -18,7 +20,9 @@ module LanguageServer
         end
 
         #
-        # The zero-based line number from where the folded range starts.
+        # The zero-based start line of the range to fold. The folded area starts
+        # after the line's last character. To be valid, the end must be zero or
+        # larger and smaller than the number of lines in the document.
         #
         # @return [number]
         def start_line
@@ -26,7 +30,8 @@ module LanguageServer
         end
 
         #
-        # The zero-based character offset from where the folded range starts. If not defined, defaults to the length of the start line.
+        # The zero-based character offset from where the folded range starts. If
+        # not defined, defaults to the length of the start line.
         #
         # @return [number]
         def start_character
@@ -34,7 +39,9 @@ module LanguageServer
         end
 
         #
-        # The zero-based line number where the folded range ends.
+        # The zero-based end line of the range to fold. The folded area ends with
+        # the line's last character. To be valid, the end must be zero or larger
+        # and smaller than the number of lines in the document.
         #
         # @return [number]
         def end_line
@@ -42,7 +49,8 @@ module LanguageServer
         end
 
         #
-        # The zero-based character offset before the folded range ends. If not defined, defaults to the length of the end line.
+        # The zero-based character offset before the folded range ends. If not
+        # defined, defaults to the length of the end line.
         #
         # @return [number]
         def end_character
@@ -50,9 +58,10 @@ module LanguageServer
         end
 
         #
-        # Describes the kind of the folding range such as `comment` or `region`. The kind
-        # is used to categorize folding ranges and used by commands like 'Fold all comments'. See
-        # [FoldingRangeKind](#FoldingRangeKind) for an enumeration of standardized kinds.
+        # Describes the kind of the folding range such as `comment` or `region`.
+        # The kind is used to categorize folding ranges and used by commands like
+        # 'Fold all comments'. See [FoldingRangeKind](#FoldingRangeKind) for an
+        # enumeration of standardized kinds.
         #
         # @return [string]
         def kind

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

@@ -13,9 +13,10 @@ module LanguageServer
         end
 
         #
-        # Whether implementation supports dynamic registration for folding range providers. If this is set to `true`
-        # the client supports the new `FoldingRangeRegistrationOptions` return value for the corresponding server
-        # capability as well.
+        # Whether implementation supports dynamic registration for folding range
+        # providers. If this is set to `true` the client supports the new
+        # `FoldingRangeRegistrationOptions` return value for the corresponding
+        # server capability as well.
         #
         # @return [boolean]
         def dynamic_registration
@@ -23,8 +24,9 @@ module LanguageServer
         end
 
         #
-        # The maximum number of folding ranges that the client prefers to receive per document. The value serves as a
-        # hint, servers are free to follow the limit.
+        # The maximum number of folding ranges that the client prefers to receive
+        # per document. The value serves as a hint, servers are free to follow the
+        # limit.
         #
         # @return [number]
         def range_limit
@@ -32,8 +34,9 @@ module LanguageServer
         end
 
         #
-        # If set, the client signals that it only supports folding complete lines. If set, client will
-        # ignore specified `startCharacter` and `endCharacter` properties in a FoldingRange.
+        # If set, the client signals that it only supports folding complete lines.
+        # If set, client will ignore specified `startCharacter` and `endCharacter`
+        # properties in a FoldingRange.
         #
         # @return [boolean]
         def line_folding_only

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

@@ -17,7 +17,7 @@ module LanguageServer
         #
         # The hover's content
         #
-        # @return [string | MarkupContent | { language: string; value: string; } | MarkedString[]]
+        # @return [MarkupContent | MarkedString | MarkedString[]]
         def contents
           attributes.fetch(:contents)
         end

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

@@ -20,8 +20,9 @@ module LanguageServer
         end
 
         #
-        # Client supports the follow content formats for the content
-        # property. The order describes the preferred format of the client.
+        # Client supports the following content formats if the content
+        # property refers to a `literal of type MarkupContent`.
+        # The order describes the preferred format of the client.
         #
         # @return [MarkupKind[]]
         def content_format

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

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

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

@@ -2,12 +2,13 @@ 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)
+        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,10 @@ 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.
+        # 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 +38,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 +89,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,25 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class LinkedEditingRangeOptions < WorkDoneProgressOptions
+        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