File: completion_options.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 (87 lines) | stat: -rw-r--r-- 3,122 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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
module LanguageServer
  module Protocol
    module Interface
      #
      # Completion options.
      #
      class CompletionOptions
        def initialize(work_done_progress: nil, trigger_characters: nil, all_commit_characters: nil, resolve_provider: nil, completion_item: nil)
          @attributes = {}

          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
          @attributes[:triggerCharacters] = trigger_characters if trigger_characters
          @attributes[:allCommitCharacters] = all_commit_characters if all_commit_characters
          @attributes[:resolveProvider] = resolve_provider if resolve_provider
          @attributes[:completionItem] = completion_item if completion_item

          @attributes.freeze
        end

        # @return [boolean]
        def work_done_progress
          attributes.fetch(:workDoneProgress)
        end

        #
        # The additional characters, beyond the defaults provided by the client (typically
        # [a-zA-Z]), that should automatically trigger a completion request. For example
        # `.` in JavaScript represents the beginning of an object property or method and is
        # thus a good candidate for triggering a completion request.
        #
        # Most tools trigger a completion request automatically without explicitly
        # requesting it using a keyboard shortcut (e.g. Ctrl+Space). Typically they
        # do so when the user starts to type an identifier. For example if the user
        # types `c` in a JavaScript file code complete will automatically pop up
        # present `console` besides others as a completion item. Characters that
        # make up identifiers don't need to be listed here.
        #
        # @return [string[]]
        def trigger_characters
          attributes.fetch(:triggerCharacters)
        end

        #
        # The list of all possible characters that commit a completion. This field
        # can be used if clients don't support individual commit characters per
        # completion item. See client capability
        # `completion.completionItem.commitCharactersSupport`.
        #
        # If a server provides both `allCommitCharacters` and commit characters on
        # an individual completion item the ones on the completion item win.
        #
        # @return [string[]]
        def all_commit_characters
          attributes.fetch(:allCommitCharacters)
        end

        #
        # The server provides support to resolve additional
        # information for a completion item.
        #
        # @return [boolean]
        def resolve_provider
          attributes.fetch(:resolveProvider)
        end

        #
        # The server supports the following `CompletionItem` specific
        # capabilities.
        #
        # @return [{ labelDetailsSupport?: boolean; }]
        def completion_item
          attributes.fetch(:completionItem)
        end

        attr_reader :attributes

        def to_hash
          attributes
        end

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