language_server-protocol 3.17.0.5 → 3.17.0.6

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

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # Client capabilities specific to inline values.
       #
+      # @since 3.17.0
+      #
       class InlineValueClientCapabilities
         def initialize(dynamic_registration: nil)
           @attributes = {}
@@ -14,8 +16,7 @@ module LanguageServer
         end
 
         #
-        # Whether implementation supports dynamic registration for inline
-        # value providers.
+        # Whether implementation supports dynamic registration for inline value providers.
         #
         # @return [boolean]
         def dynamic_registration

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # @since 3.17.0
+      #
       class InlineValueContext
         def initialize(frame_id:, stopped_location:)
           @attributes = {}
@@ -14,15 +17,14 @@ module LanguageServer
         #
         # The stack frame (as a DAP Id) where the execution has stopped.
         #
-        # @return [number]
+        # @return [integer]
         def frame_id
           attributes.fetch(:frameId)
         end
 
         #
         # The document range where execution has stopped.
-        # Typically the end position of the range denotes the line where the
-        # inline values are shown.
+        # Typically the end position of the range denotes the line where the inline values are shown.
         #
         # @return [Range]
         def stopped_location

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

@@ -3,12 +3,11 @@ module LanguageServer
     module Interface
       #
       # Provide an inline value through an expression evaluation.
-      #
-      # If only a range is specified, the expression will be extracted from the
-      # underlying document.
-      #
+      # If only a range is specified, the expression will be extracted from the underlying document.
       # An optional expression can be used to override the extracted expression.
       #
+      # @since 3.17.0
+      #
       class InlineValueEvaluatableExpression
         def initialize(range:, expression: nil)
           @attributes = {}
@@ -21,8 +20,7 @@ module LanguageServer
 
         #
         # The document range for which the inline value applies.
-        # The range is used to extract the evaluatable expression from the
-        # underlying document.
+        # The range is used to extract the evaluatable expression from the underlying document.
         #
         # @return [Range]
         def range

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

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # Inline value options used during static registration.
       #
+      # @since 3.17.0
+      #
       class InlineValueOptions
         def initialize(work_done_progress: nil)
           @attributes = {}

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

@@ -4,26 +4,20 @@ module LanguageServer
       #
       # A parameter literal used in inline value requests.
       #
+      # @since 3.17.0
+      #
       class InlineValueParams
-        def initialize(work_done_token: nil, text_document:, range:, context:)
+        def initialize(text_document:, range:, context:, work_done_token: nil)
           @attributes = {}
 
-          @attributes[:workDoneToken] = work_done_token if work_done_token
           @attributes[:textDocument] = text_document
           @attributes[:range] = range
           @attributes[:context] = context
+          @attributes[:workDoneToken] = work_done_token if work_done_token
 
           @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
-
         #
         # The text document.
         #
@@ -49,6 +43,14 @@ module LanguageServer
           attributes.fetch(:context)
         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

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

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # Inline value options used during static or dynamic registration.
       #
+      # @since 3.17.0
+      #
       class InlineValueRegistrationOptions
         def initialize(work_done_progress: nil, document_selector:, id: nil)
           @attributes = {}
@@ -21,10 +23,10 @@ module LanguageServer
         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.
+        # 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]
+        # @return [DocumentSelector | nil]
         def document_selector
           attributes.fetch(:documentSelector)
         end

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

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # Provide inline value as text.
       #
+      # @since 3.17.0
+      #
       class InlineValueText
         def initialize(range:, text:)
           @attributes = {}

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

@@ -3,12 +3,11 @@ module LanguageServer
     module Interface
       #
       # Provide inline value through a variable lookup.
-      #
-      # If only a range is specified, the variable name will be extracted from
-      # the underlying document.
-      #
+      # If only a range is specified, the variable name will be extracted from the underlying document.
       # An optional variable name can be used to override the extracted name.
       #
+      # @since 3.17.0
+      #
       class InlineValueVariableLookup
         def initialize(range:, variable_name: nil, case_sensitive_lookup:)
           @attributes = {}
@@ -22,8 +21,7 @@ module LanguageServer
 
         #
         # The document range for which the inline value applies.
-        # The range is used to extract the variable name from the underlying
-        # document.
+        # The range is used to extract the variable name from the underlying document.
         #
         # @return [Range]
         def range

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

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # Client workspace capabilities specific to inline values.
       #
+      # @since 3.17.0
+      #
       class InlineValueWorkspaceClientCapabilities
         def initialize(refresh_support: nil)
           @attributes = {}
@@ -14,12 +16,12 @@ module LanguageServer
         end
 
         #
-        # Whether the client implementation supports a refresh request sent from
-        # the server to the client.
+        # Whether the client implementation supports a refresh request sent from the
+        # server to the client.
         #
         # Note that this event is global and will force the client to refresh all
-        # inline values currently shown. It should be used with absolute care and
-        # is useful for situation where a server for example detect a project wide
+        # inline values currently shown. It should be used with absolute care and is
+        # useful for situation where a server for example detects a project wide
         # change that requires such a calculation.
         #
         # @return [boolean]

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

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # A special text edit to provide an insert and a replace operation.
       #
+      # @since 3.16.0
+      #
       class InsertReplaceEdit
         def initialize(new_text:, insert:, replace:)
           @attributes = {}

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

@@ -1,6 +1,11 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Client capabilities for the linked editing range request.
+      #
+      # @since 3.16.0
+      #
       class LinkedEditingRangeClientCapabilities
         def initialize(dynamic_registration: nil)
           @attributes = {}
@@ -11,9 +16,8 @@ module LanguageServer
         end
 
         #
-        # Whether the implementation supports dynamic registration.
-        # If this is set to `true` the client supports the new
-        # `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
+        # 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]

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

@@ -13,10 +13,10 @@ module LanguageServer
         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.
+        # 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]
+        # @return [DocumentSelector | nil]
         def document_selector
           attributes.fetch(:documentSelector)
         end

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

@@ -1,6 +1,11 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The result of a linked editing range request.
+      #
+      # @since 3.16.0
+      #
       class LinkedEditingRanges
         def initialize(ranges:, word_pattern: nil)
           @attributes = {}
@@ -12,9 +17,8 @@ module LanguageServer
         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.
+        # A list of ranges that can be edited together. The ranges must have
+        # identical length and contain identical text content. The ranges cannot overlap.
         #
         # @return [Range[]]
         def ranges
@@ -22,9 +26,9 @@ module LanguageServer
         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.
+        # 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

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

@@ -1,6 +1,10 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Represents a location inside a resource, such as a line
+      # inside a text file.
+      #
       class Location
         def initialize(uri:, range:)
           @attributes = {}
@@ -11,7 +15,7 @@ module LanguageServer
           @attributes.freeze
         end
 
-        # @return [string]
+        # @return [DocumentUri]
         def uri
           attributes.fetch(:uri)
         end

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

@@ -1,6 +1,10 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Represents the connection of two locations. Provides additional metadata over normal {@link Location locations},
+      # including an origin range.
+      #
       class LocationLink
         def initialize(origin_selection_range: nil, target_uri:, target_range:, target_selection_range:)
           @attributes = {}
@@ -16,8 +20,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 definition position.
         #
         # @return [Range]
         def origin_selection_range
@@ -27,16 +31,15 @@ module LanguageServer
         #
         # The target resource identifier of this link.
         #
-        # @return [string]
+        # @return [DocumentUri]
         def target_uri
           attributes.fetch(:targetUri)
         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
@@ -44,9 +47,8 @@ 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
-        # `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 `targetRange`. See also `DocumentSymbol#range`
         #
         # @return [Range]
         def target_selection_range

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The log message parameters.
+      #
       class LogMessageParams
         def initialize(type:, message:)
           @attributes = {}
@@ -20,7 +23,7 @@ module LanguageServer
         end
 
         #
-        # The actual message
+        # The actual message.
         #
         # @return [string]
         def message

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

@@ -11,18 +11,11 @@ module LanguageServer
           @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)

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

@@ -0,0 +1,59 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Client capabilities specific to the used markdown parser.
+      #
+      # @since 3.16.0
+      #
+      class MarkdownClientCapabilities
+        def initialize(parser:, version: nil, allowed_tags: nil)
+          @attributes = {}
+
+          @attributes[:parser] = parser
+          @attributes[:version] = version if version
+          @attributes[:allowedTags] = allowed_tags if allowed_tags
+
+          @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
+
+        #
+        # A list of HTML tags that the client allows / supports in
+        # Markdown.
+        #
+        # @since 3.17.0
+        #
+        # @return [string[]]
+        def allowed_tags
+          attributes.fetch(:allowedTags)
+        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/markup_content.rb

@@ -2,30 +2,28 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # A `MarkupContent` literal represents a string value which content is
-      # interpreted base on its kind flag. Currently the protocol supports
-      # `plaintext` and `markdown` as markup kinds.
+      # A `MarkupContent` literal represents a string value which content is interpreted base on its
+      # kind flag. Currently the protocol supports `plaintext` and `markdown` as markup kinds.
       #
-      # If the kind is `markdown` then the value can contain fenced code blocks like
-      # in GitHub issues.
+      # If the kind is `markdown` then the value can contain fenced code blocks like in GitHub issues.
+      # See https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting
       #
-      # Here is an example how such a string can be constructed using
-      # JavaScript / TypeScript:
-      # ```typescript
+      # Here is an example how such a string can be constructed using JavaScript / TypeScript:
+      # ```ts
       # let markdown: MarkdownContent = {
-      # kind: MarkupKind.Markdown,
-      # value: [
-      # '# Header',
-      # 'Some text',
-      # '```typescript',
-      # 'someCode();',
-      # '```'
-      # ].join('\n')
+      #  kind: MarkupKind.Markdown,
+      #  value: [
+      #    '# Header',
+      #    'Some text',
+      #    '```typescript',
+      #    'someCode();',
+      #    '```'
+      #  ].join('\n')
       # };
       # ```
       #
-      # *Please Note* that clients might sanitize the return markdown. A client could
-      # decide to remove HTML from the markdown to avoid script execution.
+      # *Please Note* that clients might sanitize the return markdown. A client could decide to
+      # remove HTML from the markdown to avoid script execution.
       #
       class MarkupContent
         def initialize(kind:, value:)

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

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # Moniker definition to match LSIF 0.5 moniker definition.
       #
+      # @since 3.16.0
+      #
       class Moniker
         def initialize(scheme:, identifier:, unique:, kind: nil)
           @attributes = {}

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

@@ -1,6 +1,11 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Client capabilities specific to the moniker request.
+      #
+      # @since 3.16.0
+      #
       class MonikerClientCapabilities
         def initialize(dynamic_registration: nil)
           @attributes = {}
@@ -11,10 +16,9 @@ module LanguageServer
         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.
+        # Whether moniker supports dynamic registration. If this is set to `true`
+        # the client supports the new `MonikerRegistrationOptions` return value
+        # for the corresponding server capability as well.
         #
         # @return [boolean]
         def dynamic_registration

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

@@ -38,8 +38,8 @@ module LanguageServer
         end
 
         #
-        # An optional token that a server can use to report partial results (e.g.
-        # streaming) to the client.
+        # An optional token that a server can use to report partial results (e.g. streaming) to
+        # the client.
         #
         # @return [ProgressToken]
         def partial_result_token

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

@@ -12,10 +12,10 @@ module LanguageServer
         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.
+        # 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]
+        # @return [DocumentSelector | nil]
         def document_selector
           attributes.fetch(:documentSelector)
         end

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

@@ -8,6 +8,8 @@ module LanguageServer
       # cells and can therefore be used to uniquely identify a
       # notebook cell or the cell's text document.
       #
+      # @since 3.17.0
+      #
       class NotebookCell
         def initialize(kind:, document:, metadata: nil, execution_summary: nil)
           @attributes = {}
@@ -23,7 +25,7 @@ module LanguageServer
         #
         # The cell's kind
         #
-        # @return [any]
+        # @return [NotebookCellKind]
         def kind
           attributes.fetch(:kind)
         end
@@ -32,7 +34,7 @@ module LanguageServer
         # The URI of the cell's text document
         # content.
         #
-        # @return [string]
+        # @return [DocumentUri]
         def document
           attributes.fetch(:document)
         end
@@ -40,6 +42,8 @@ module LanguageServer
         #
         # Additional metadata stored with the cell.
         #
+        # Note: should always be an object literal (e.g. LSPObject)
+        #
         # @return [LSPObject]
         def metadata
           attributes.fetch(:metadata)

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

@@ -5,6 +5,8 @@ module LanguageServer
       # A change describing how to move a `NotebookCell`
       # array from state S to S'.
       #
+      # @since 3.17.0
+      #
       class NotebookCellArrayChange
         def initialize(start:, delete_count:, cells: nil)
           @attributes = {}
@@ -17,9 +19,9 @@ module LanguageServer
         end
 
         #
-        # The start offset of the cell that changed.
+        # The start oftest of the cell that changed.
         #
-        # @return [number]
+        # @return [uinteger]
         def start
           attributes.fetch(:start)
         end
@@ -27,7 +29,7 @@ module LanguageServer
         #
         # The deleted cells
         #
-        # @return [number]
+        # @return [uinteger]
         def delete_count
           attributes.fetch(:deleteCount)
         end

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

@@ -5,6 +5,8 @@ module LanguageServer
       # A notebook cell text document filter denotes a cell text
       # document by different properties.
       #
+      # @since 3.17.0
+      #
       class NotebookCellTextDocumentFilter
         def initialize(notebook:, language: nil)
           @attributes = {}