language_server-protocol 3.14.0.2 → 3.16.0.1

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

@@ -2,13 +2,13 @@ module LanguageServer
   module Protocol
     module Interface
       class LocationLink
-        def initialize(origin_selection_range: nil, target_uri:, target_range:, target_selection_range: nil)
+        def initialize(origin_selection_range: nil, target_uri:, target_range:, target_selection_range:)
           @attributes = {}
 
           @attributes[:originSelectionRange] = origin_selection_range if origin_selection_range
           @attributes[:targetUri] = target_uri
           @attributes[:targetRange] = target_range
-          @attributes[:targetSelectionRange] = target_selection_range if target_selection_range
+          @attributes[:targetSelectionRange] = target_selection_range
 
           @attributes.freeze
         end
@@ -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,7 +33,10 @@ module LanguageServer
         end
 
         #
-        # The full target range of this link.
+        # 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
@@ -41,7 +44,9 @@ module LanguageServer
         end
 
         #
-        # The span of this link.
+        # 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

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

@@ -2,13 +2,15 @@ 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.
-      # See https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting
+      # If the kind is `markdown` then the value can contain fenced code blocks like
+      # in GitHub issues.
       #
-      # Here is an example how such a string can be constructed using JavaScript / TypeScript:
+      # Here is an example how such a string can be constructed using
+      # JavaScript / TypeScript:
       # ```typescript
       # let markdown: MarkdownContent = {
       # kind: MarkupKind.Markdown,
@@ -22,8 +24,8 @@ module LanguageServer
       # };
       # ```
       #
-      # *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

@@ -0,0 +1,64 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Moniker definition to match LSIF 0.5 moniker definition.
+      #
+      class Moniker
+        def initialize(scheme:, identifier:, unique:, kind: nil)
+          @attributes = {}
+
+          @attributes[:scheme] = scheme
+          @attributes[:identifier] = identifier
+          @attributes[:unique] = unique
+          @attributes[:kind] = kind if kind
+
+          @attributes.freeze
+        end
+
+        #
+        # The scheme of the moniker. For example tsc or .Net
+        #
+        # @return [string]
+        def scheme
+          attributes.fetch(:scheme)
+        end
+
+        #
+        # The identifier of the moniker. The value is opaque in LSIF however
+        # schema owners are allowed to define the structure if they want.
+        #
+        # @return [string]
+        def identifier
+          attributes.fetch(:identifier)
+        end
+
+        #
+        # The scope in which the moniker is unique
+        #
+        # @return [UniquenessLevel]
+        def unique
+          attributes.fetch(:unique)
+        end
+
+        #
+        # The moniker kind if known.
+        #
+        # @return [MonikerKind]
+        def kind
+          attributes.fetch(:kind)
+        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/moniker_client_capabilities.rb

@@ -0,0 +1,36 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class MonikerClientCapabilities
+        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/moniker_options.rb

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