File: completion_item_label_details.rb

package info (click to toggle)
ruby-language-server-protocol 3.17.0.5-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,636 kB
  • sloc: ruby: 10,741; makefile: 4
file content (49 lines) | stat: -rw-r--r-- 1,243 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
module LanguageServer
  module Protocol
    module Interface
      #
      # Additional details for a completion item label.
      #
      class CompletionItemLabelDetails
        def initialize(detail: nil, description: nil)
          @attributes = {}

          @attributes[:detail] = detail if detail
          @attributes[:description] = description if description

          @attributes.freeze
        end

        #
        # An optional string which is rendered less prominently directly after
        # {@link CompletionItem.label label}, without any spacing. Should be
        # used for function signatures or type annotations.
        #
        # @return [string]
        def detail
          attributes.fetch(:detail)
        end

        #
        # An optional string which is rendered less prominently after
        # {@link CompletionItemLabelDetails.detail}. Should be used for fully qualified
        # names or file path.
        #
        # @return [string]
        def description
          attributes.fetch(:description)
        end

        attr_reader :attributes

        def to_hash
          attributes
        end

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