Type Members

1.  case class CompletionClientCapabilities(dynamicRegistration: Option[Boolean] = None, completionItem: Option[CompletionItemClientCapabilities] = None, completionItemKind: Option[CompletionItemKindClientCapabilities] = None, contextSupport: Option[Boolean]) extends Product with Serializable

   Capabilities specific to the textDocument/completion

   Capabilities specific to the textDocument/completion

   dynamicRegistration

   Whether completion supports dynamic registration.

   completionItem

   The client supports the following CompletionItem specific capabilities.

   completionItemKind

   The client supports the following CompletionItemKind specific capabilities

   contextSupport

   The client supports to send additional context information for a textDocument/completion request.

2.  case class CompletionContext(triggerKind: CompletionTriggerKind, triggerCharacter: Option[Char]) extends Product with Serializable

   Contains additional information about the context in which a completion request is triggered.

   Contains additional information about the context in which a completion request is triggered.

   triggerKind

   How the completion was triggered.

   triggerCharacter

   The trigger character that has trigger code complete. Is None if triggerKind !== CompletionTriggerKind.TriggerCharacter

3.  case class CompletionItem(label: String, kind: Option[CompletionItemKind] = None, detail: Option[String] = None, documentation: Option[String] = None, deprecated: Option[Boolean] = None, preselect: Option[Boolean] = None, sortText: Option[String] = None, filterText: Option[String] = None, insertText: Option[String] = None, insertTextFormat: Option[InsertTextFormat] = None, textEdit: Option[Either[TextEdit, InsertReplaceEdit]] = None, additionalTextEdits: Option[Seq[TextEdit]] = None, commitCharacters: Option[Seq[Char]] = None, command: Option[Command] = None) extends Product with Serializable
   label

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

   kind

   The kind of this completion item. Based of the kind an icon is chosen by the editor.

   detail

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

   documentation

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

   deprecated

   Indicates if this item is deprecated.

   preselect

   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.

   sortText

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

   filterText

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

   insertText

   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.

   insertTextFormat

   The format of the insert text. The format applies to both the insertText property and the newText property of a provided textEdit.

   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.

   additionalTextEdits

   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).

   commitCharacters

   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.

   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.

4.  case class CompletionItemClientCapabilities(snippetSupport: Option[Boolean], commitCharactersSupport: Option[Boolean], deprecatedSupport: Option[Boolean], preselectSupport: Option[Boolean]) extends Product with Serializable
   snippetSupport

   The client supports snippets as insert text. A snippet can define tab stops and placeholders with $1, $2 and ${3:foo}. $0 defines the final tab stop, it defaults to the end of the snippet. Placeholders with equal identifiers are linked, that is typing in one will update others too.

   commitCharactersSupport

   The client supports commit characters on a completion item.

   deprecatedSupport

   The client supports the deprecated property on a completion item.

   preselectSupport

   The client supports the preselect property on a completion item.

5.  case class CompletionItemKindClientCapabilities(valueSet: Set[CompletionItemKind]) extends Product with Serializable
   valueSet

   The completion item kind values the client supports. When this property exists the client also guarantees that it will handle values outside its set gracefully and falls back to a default value when unknown. If this property is not present the client only supports the completion items kinds from Text to Reference as defined in the initial version of the protocol.

6.  case class CompletionList(items: Seq[CompletionItem], isIncomplete: Boolean) extends Product with Serializable

   Represents a collection of [completion items](#CompletionItem) to be presented in the editor.

   Represents a collection of [completion items](#CompletionItem) to be presented in the editor.

   items

   The completion items.

   isIncomplete

   This list it not complete. Further typing should result in recomputing this list.

7.  case class CompletionOptions(resolveProvider: Option[Boolean] = None, triggerCharacters: Option[Set[Char]] = None) extends Product with Serializable

   Completion options.

   Completion options.

   resolveProvider

   The server provides support to resolve additional information for a completion item.

   triggerCharacters

   The characters that trigger completion automatically.

8.  case class CompletionParams(textDocument: TextDocumentIdentifier, position: Position, context: Option[CompletionContext] = None) extends TextDocumentPositionParams with Product with Serializable