Sha256: 3ced1e019a0c185e9985e34e615c1bb7eaee35efb7cc42b7105417f4936ccd92

Contents?: true

Size: 1.78 KB

Versions: 106

Compression:

Stored size: 1.78 KB

Contents

module LanguageServer
  module Protocol
    module Interface
      #
      # A document link is a range in a text document that links to an internal or
      # external resource, like another text document or a web site.
      #
      class DocumentLink
        def initialize(range:, target: nil, tooltip: nil, data: nil)
          @attributes = {}

          @attributes[:range] = range
          @attributes[:target] = target if target
          @attributes[:tooltip] = tooltip if tooltip
          @attributes[:data] = data if data

          @attributes.freeze
        end

        #
        # The range this link applies to.
        #
        # @return [Range]
        def range
          attributes.fetch(:range)
        end

        #
        # The uri this link points to. If missing a resolve request is sent later.
        #
        # @return [string]
        def target
          attributes.fetch(:target)
        end

        #
        # The tooltip text when you hover over this link.
        #
        # If a tooltip is provided, is will be displayed in a string that includes
        # instructions on how to trigger the link, such as `{0} (ctrl + click)`.
        # The specific instructions vary depending on OS, user settings, and
        # localization.
        #
        # @return [string]
        def tooltip
          attributes.fetch(:tooltip)
        end

        #
        # A data entry field that is preserved on a document link between a
        # DocumentLinkRequest and a DocumentLinkResolveRequest.
        #
        # @return [LSPAny]
        def data
          attributes.fetch(:data)
        end

        attr_reader :attributes

        def to_hash
          attributes
        end

        def to_json(*args)
          to_hash.to_json(*args)
        end
      end
    end
  end
end

Version data entries

106 entries across 106 versions & 15 rubygems

Version Path
siteimprove_api_client-1.0.1 vendor/bundle/ruby/3.2.0/gems/language_server-protocol-3.17.0.4/lib/language_server/protocol/interface/document_link.rb
tailscale_middleware-0.0.3 vendor/cache/ruby/3.4.0/gems/language_server-protocol-3.17.0.4/lib/language_server/protocol/interface/document_link.rb
language_server-protocol-3.17.0.4 lib/language_server/protocol/interface/document_link.rb
minato_ruby_api_client-0.2.2 vendor/bundle/ruby/3.2.0/gems/language_server-protocol-3.17.0.3/lib/language_server/protocol/interface/document_link.rb
blacklight-spotlight-3.6.0.beta8 vendor/bundle/ruby/3.2.0/gems/language_server-protocol-3.17.0.3/lib/language_server/protocol/interface/document_link.rb
katalyst-govuk-formbuilder-1.9.2 vendor/bundle/ruby/3.3.0/gems/language_server-protocol-3.17.0.3/lib/language_server/protocol/interface/document_link.rb
harbr-2.8.1 vendor/bundle/ruby/3.2.0/gems/language_server-protocol-3.17.0.3/lib/language_server/protocol/interface/document_link.rb
bison-0.1.0 vendor/bundle/ruby/3.2.0/gems/language_server-protocol-3.17.0.3/lib/language_server/protocol/interface/document_link.rb
mlh-rubocop-config-1.0.3 vendor/bundle/ruby/3.2.0/gems/language_server-protocol-3.17.0.3/lib/language_server/protocol/interface/document_link.rb
study_line-0.2.7 vendor/bundle/ruby/3.2.0/gems/language_server-protocol-3.17.0.3/lib/language_server/protocol/interface/document_link.rb
study_line-0.2.6 vendor/bundle/ruby/3.2.0/gems/language_server-protocol-3.17.0.3/lib/language_server/protocol/interface/document_link.rb
study_line-0.2.5 vendor/bundle/ruby/3.2.0/gems/language_server-protocol-3.17.0.3/lib/language_server/protocol/interface/document_link.rb
study_line-0.2.4 vendor/bundle/ruby/3.2.0/gems/language_server-protocol-3.17.0.3/lib/language_server/protocol/interface/document_link.rb
study_line-0.2.3 vendor/bundle/ruby/3.2.0/gems/language_server-protocol-3.17.0.3/lib/language_server/protocol/interface/document_link.rb
study_line-0.2.2 vendor/bundle/ruby/3.2.0/gems/language_server-protocol-3.17.0.3/lib/language_server/protocol/interface/document_link.rb
study_line-0.2.1 vendor/bundle/ruby/3.2.0/gems/language_server-protocol-3.17.0.3/lib/language_server/protocol/interface/document_link.rb
study_line-0.2.0 vendor/bundle/ruby/3.2.0/gems/language_server-protocol-3.17.0.3/lib/language_server/protocol/interface/document_link.rb
harbr-0.2.10 vendor/bundle/ruby/3.2.0/gems/language_server-protocol-3.17.0.3/lib/language_server/protocol/interface/document_link.rb
harbr-0.2.9 vendor/bundle/ruby/3.2.0/gems/language_server-protocol-3.17.0.3/lib/language_server/protocol/interface/document_link.rb
harbr-0.2.8 vendor/bundle/ruby/3.2.0/gems/language_server-protocol-3.17.0.3/lib/language_server/protocol/interface/document_link.rb