Class: LanguageServer::Protocol::Interface::CompletionItem

Inherits:
Object
  • Object
show all
Defined in:
lib/language_server/protocol/interface/completion_item.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(label:, kind: nil, tags: nil, detail: nil, documentation: nil, deprecated: nil, preselect: nil, sort_text: nil, filter_text: nil, insert_text: nil, insert_text_format: nil, text_edit: nil, additional_text_edits: nil, commit_characters: nil, command: nil, data: nil) ⇒ CompletionItem

Returns a new instance of CompletionItem.



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 5

def initialize(label:, kind: nil, tags: nil, detail: nil, documentation: nil, deprecated: nil, preselect: nil, sort_text: nil, filter_text: nil, insert_text: nil, insert_text_format: nil, text_edit: nil, additional_text_edits: nil, commit_characters: nil, command: nil, data: nil)
  @attributes = {}

  @attributes[:label] = label
  @attributes[:kind] = kind if kind
  @attributes[:tags] = tags if tags
  @attributes[:detail] = detail if detail
  @attributes[:documentation] = documentation if documentation
  @attributes[:deprecated] = deprecated if deprecated
  @attributes[:preselect] = preselect if preselect
  @attributes[:sortText] = sort_text if sort_text
  @attributes[:filterText] = filter_text if filter_text
  @attributes[:insertText] = insert_text if insert_text
  @attributes[:insertTextFormat] = insert_text_format if insert_text_format
  @attributes[:textEdit] = text_edit if text_edit
  @attributes[:additionalTextEdits] = additional_text_edits if additional_text_edits
  @attributes[:commitCharacters] = commit_characters if commit_characters
  @attributes[:command] = command if command
  @attributes[:data] = data if data

  @attributes.freeze
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



192
193
194
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 192

def attributes
  @attributes
end

Instance Method Details

#additional_text_edits ⇒ TextEdit[]

An optional array of additional text edits that are applied when selecting this completion. Edits must not overlap (including the same insert position) with the main edit nor with themselves.

Additional text edits should be used to change text unrelated to the current cursor position (for example adding an import statement at the top of the file if the completion item will insert an unqualified type).

Returns:



159
160
161
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 159

def additional_text_edits
  attributes.fetch(:additionalTextEdits)
end

#command ⇒ Command

An optional command that is executed after inserting this completion. Note that additional modifications to the current document should be described with the additionalTextEdits-property.

Returns:



179
180
181
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 179

def command
  attributes.fetch(:command)
end

#commit_characters ⇒ string[]

An optional set of characters that when pressed while this completion is active will accept it first and then type that character. Note that all commit characters should have ‘length=1` and that superfluous characters will be ignored.

Returns:

  • (string[]) 


169
170
171
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 169

def commit_characters
  attributes.fetch(:commitCharacters)
end

#data ⇒ any

A data entry field that is preserved on a completion item between a completion and a completion resolve request.

Returns:

  • (any) 


188
189
190
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 188

def data
  attributes.fetch(:data)
end

#deprecated ⇒ boolean

Indicates if this item is deprecated.

Returns:

  • (boolean) 


77
78
79
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 77

def deprecated
  attributes.fetch(:deprecated)
end

#detail ⇒ string

A human-readable string with additional information about this item, like type or symbol information.

Returns:

  • (string) 


61
62
63
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 61

def detail
  attributes.fetch(:detail)
end

#documentation ⇒ string | MarkupContent

A human-readable string that represents a doc-comment.

Returns:



69
70
71
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 69

def documentation
  attributes.fetch(:documentation)
end

#filter_text ⇒ string

A string that should be used when filtering a set of completion items. When ‘falsy` the label is used.

Returns:

  • (string) 


107
108
109
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 107

def filter_text
  attributes.fetch(:filterText)
end

#insert_text ⇒ string

A string that should be inserted into a document when selecting this completion. When ‘falsy` the label is used.

The ‘insertText` is subject to interpretation by the client side. Some tools might not take the string literally. For example VS Code when code complete is requested in this example `con<cursor position>` and a completion item with an `insertText` of `console` is provided it will only insert `sole`. Therefore it is recommended to use `textEdit` instead since it avoids additional client side interpretation.

Returns:

  • (string) 


123
124
125
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 123

def insert_text
  attributes.fetch(:insertText)
end

#insert_text_format ⇒ DiagnosticTag

The format of the insert text. The format applies to both the ‘insertText` property and the `newText` property of a provided `textEdit`. If omitted defaults to `InsertTextFormat.PlainText`.

Returns:

  • (DiagnosticTag) 


133
134
135
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 133

def insert_text_format
  attributes.fetch(:insertTextFormat)
end

#kind ⇒ number

The kind of this completion item. Based of the kind an icon is chosen by the editor. The standardized set of available values is defined in ‘CompletionItemKind`.

Returns:

  • (number) 


44
45
46
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 44

def kind
  attributes.fetch(:kind)
end

#label ⇒ string

The label of this completion item. By default also the text that is inserted when selecting this completion.

Returns:

  • (string) 


34
35
36
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 34

def label
  attributes.fetch(:label)
end

#preselect ⇒ boolean

Select this item when showing.

Note that only one completion item can be selected and that the tool / client decides which item that is. The rule is that the first item of those that match best is selected.

Returns:

  • (boolean) 


89
90
91
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 89

def preselect
  attributes.fetch(:preselect)
end

#sort_text ⇒ string

A string that should be used when comparing this item with other items. When ‘falsy` the label is used.

Returns:

  • (string) 


98
99
100
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 98

def sort_text
  attributes.fetch(:sortText)
end

#tags ⇒ 1[]

Tags for this completion item.

Returns:

  • (1[]) 


52
53
54
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 52

def tags
  attributes.fetch(:tags)
end

#text_edit ⇒ TextEdit

An edit which is applied to a document when selecting this completion. When an edit is provided the value of ‘insertText` is ignored.

Note: The range of the edit must be a single line range and it must contain the position at which completion has been requested.

Returns:



145
146
147
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 145

def text_edit
  attributes.fetch(:textEdit)
end

#to_hash ⇒ Object 



194
195
196
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 194

def to_hash
  attributes
end

#to_json(*args) ⇒ Object 



198
199
200
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 198

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