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
|
module LanguageServer
module Protocol
module Interface
class WorkDoneProgressBegin
def initialize(kind:, title:, cancellable: nil, message: nil, percentage: nil)
@attributes = {}
@attributes[:kind] = kind
@attributes[:title] = title
@attributes[:cancellable] = cancellable if cancellable
@attributes[:message] = message if message
@attributes[:percentage] = percentage if percentage
@attributes.freeze
end
# @return ["begin"]
def kind
attributes.fetch(:kind)
end
#
# Mandatory title of the progress operation. Used to briefly inform about
# the kind of operation being performed.
#
# Examples: "Indexing" or "Linking dependencies".
#
# @return [string]
def title
attributes.fetch(:title)
end
#
# Controls if a cancel button should show to allow the user to cancel the
# long running operation. Clients that don't support cancellation are
# allowed to ignore the setting.
#
# @return [boolean]
def cancellable
attributes.fetch(:cancellable)
end
#
# Optional, more detailed associated progress message. Contains
# complementary information to the `title`.
#
# Examples: "3/25 files", "project/src/module2", "node_modules/some_dep".
# If unset, the previous progress message (if any) is still valid.
#
# @return [string]
def message
attributes.fetch(:message)
end
#
# Optional progress percentage to display (value 100 is considered 100%).
# If not provided infinite progress is assumed and clients are allowed
# to ignore the `percentage` value in subsequent in report notifications.
#
# The value should be steadily rising. Clients are free to ignore values
# that are not following this rule. The value range is [0, 100]
#
# @return [number]
def percentage
attributes.fetch(:percentage)
end
attr_reader :attributes
def to_hash
attributes
end
def to_json(*args)
to_hash.to_json(*args)
end
end
end
end
end
|
