language_server-protocol 3.14.0.2 → 3.16.0.1

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,30 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class FoldingRangeOptions
+        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/folding_range_params.rb

@@ -2,14 +2,33 @@ module LanguageServer
   module Protocol
     module Interface
       class FoldingRangeParams
-        def initialize(text_document:)
+        def initialize(work_done_token: nil, partial_result_token: nil, text_document:)
           @attributes = {}
 
+          @attributes[:workDoneToken] = work_done_token if work_done_token
+          @attributes[:partialResultToken] = partial_result_token if partial_result_token
           @attributes[:textDocument] = text_document
 
           @attributes.freeze
         end
 
+        #
+        # An optional token that a server can use to report work done progress.
+        #
+        # @return [ProgressToken]
+        def work_done_token
+          attributes.fetch(:workDoneToken)
+        end
+
+        #
+        # An optional token that a server can use to report partial results (e.g.
+        # streaming) to the client.
+        #
+        # @return [ProgressToken]
+        def partial_result_token
+          attributes.fetch(:partialResultToken)
+        end
+
         #
         # The text document.
         #

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

@@ -0,0 +1,50 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class FoldingRangeRegistrationOptions
+        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/formatting_options.rb

@@ -5,11 +5,14 @@ module LanguageServer
       # Value-object describing what options formatting should use.
       #
       class FormattingOptions
-        def initialize(tab_size:, insert_spaces:)
+        def initialize(tab_size:, insert_spaces:, trim_trailing_whitespace: nil, insert_final_newline: nil, trim_final_newlines: nil)
           @attributes = {}
 
           @attributes[:tabSize] = tab_size
           @attributes[:insertSpaces] = insert_spaces
+          @attributes[:trimTrailingWhitespace] = trim_trailing_whitespace if trim_trailing_whitespace
+          @attributes[:insertFinalNewline] = insert_final_newline if insert_final_newline
+          @attributes[:trimFinalNewlines] = trim_final_newlines if trim_final_newlines
 
           @attributes.freeze
         end
@@ -30,6 +33,30 @@ module LanguageServer
           attributes.fetch(:insertSpaces)
         end
 
+        #
+        # Trim trailing whitespace on a line.
+        #
+        # @return [boolean]
+        def trim_trailing_whitespace
+          attributes.fetch(:trimTrailingWhitespace)
+        end
+
+        #
+        # Insert a newline character at the end of the file if one does not exist.
+        #
+        # @return [boolean]
+        def insert_final_newline
+          attributes.fetch(:insertFinalNewline)
+        end
+
+        #
+        # Trim all newlines after the final newline at the end of the file.
+        #
+        # @return [boolean]
+        def trim_final_newlines
+          attributes.fetch(:trimFinalNewlines)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -0,0 +1,44 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class HoverClientCapabilities
+        def initialize(dynamic_registration: nil, content_format: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+          @attributes[:contentFormat] = content_format if content_format
+
+          @attributes.freeze
+        end
+
+        #
+        # Whether hover supports dynamic registration.
+        #
+        # @return [boolean]
+        def dynamic_registration
+          attributes.fetch(:dynamicRegistration)
+        end
+
+        #
+        # 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
+          attributes.fetch(:contentFormat)
+        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/hover_options.rb

@@ -0,0 +1,30 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class HoverOptions
+        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/hover_params.rb

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