language_server-protocol 3.14.0.1 → 3.16.0.0

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

@@ -0,0 +1,36 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Represents information on a file/folder delete.
+      #
+      class FileDelete
+        def initialize(uri:)
+          @attributes = {}
+
+          @attributes[:uri] = uri
+
+          @attributes.freeze
+        end
+
+        #
+        # A file:// URI for the location of the file/folder being deleted.
+        #
+        # @return [string]
+        def uri
+          attributes.fetch(:uri)
+        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_filter.rb

@@ -0,0 +1,46 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A filter to describe in which file operation requests or notifications
+      # the server is interested in.
+      #
+      class FileOperationFilter
+        def initialize(scheme: nil, pattern:)
+          @attributes = {}
+
+          @attributes[:scheme] = scheme if scheme
+          @attributes[:pattern] = pattern
+
+          @attributes.freeze
+        end
+
+        #
+        # A Uri like `file` or `untitled`.
+        #
+        # @return [string]
+        def scheme
+          attributes.fetch(:scheme)
+        end
+
+        #
+        # The actual file operation pattern.
+        #
+        # @return [FileOperationPattern]
+        def pattern
+          attributes.fetch(:pattern)
+        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_pattern.rb

@@ -0,0 +1,67 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A pattern to describe in which file operation requests or notifications
+      # the server is interested in.
+      #
+      class FileOperationPattern
+        def initialize(glob:, matches: nil, options: nil)
+          @attributes = {}
+
+          @attributes[:glob] = glob
+          @attributes[:matches] = matches if matches
+          @attributes[:options] = options if options
+
+          @attributes.freeze
+        end
+
+        #
+        # The glob pattern to match. Glob patterns can have the following syntax:
+        # - `*` 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 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
+          attributes.fetch(:glob)
+        end
+
+        #
+        # Whether to match files or folders with this pattern.
+        #
+        # Matches both if undefined.
+        #
+        # @return [FileOperationPatternKind]
+        def matches
+          attributes.fetch(:matches)
+        end
+
+        #
+        # Additional options used during matching.
+        #
+        # @return [FileOperationPatternOptions]
+        def options
+          attributes.fetch(:options)
+        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_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

@@ -0,0 +1,58 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class FoldingRangeClientCapabilities
+        def initialize(dynamic_registration: nil, range_limit: nil, line_folding_only: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+          @attributes[:rangeLimit] = range_limit if range_limit
+          @attributes[:lineFoldingOnly] = line_folding_only if line_folding_only
+
+          @attributes.freeze
+        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.
+        #
+        # @return [boolean]
+        def dynamic_registration
+          attributes.fetch(:dynamicRegistration)
+        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.
+        #
+        # @return [number]
+        def range_limit
+          attributes.fetch(:rangeLimit)
+        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.
+        #
+        # @return [boolean]
+        def line_folding_only
+          attributes.fetch(:lineFoldingOnly)
+        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/folding_range_options.rb

@@ -0,0 +1,25 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class FoldingRangeOptions < 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

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

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