Implement CompletionItem.insertTextFormat

Author: RLovelett

Sources/LanguageServerProtocol/Types/CompletionItem.swift

@@ -12,6 +12,19 @@ import Foundation
 import Ogra
 import Runes
 
+/// Defines whether the insert text in a completion item should be interpreted as plain text or a snippet.
+public enum InsertTextFormat: Int {
+    /// The primary text to be inserted is treated as a plain string.
+    case plainText = 1
+
+    /// The primary text to be inserted is treated as a snippet.
+    ///
+    /// 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.
+    case snippet = 2
+}
+
 ///
 public struct CompletionItem {
 
@@ -29,6 +42,9 @@ public struct CompletionItem {
     /// A human-readable string that represents a doc-comment.
     var documentation: String?
 
+    /// Indicates if this item is deprecated.
+    var deprecated: Bool?
+
     /// A string that shoud be used when comparing this item with other items. When `falsy` the
     /// label is used.
     var sortText: String?
@@ -39,8 +55,19 @@ public struct CompletionItem {
 
     /// A string that should be inserted 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.
+    ///
+    /// - Warning: This property is deprecated. Use `textEdit` instead.
     var insertText: String?
 
+    /// The format of the insert text. The format applies to both the `insertText` property and the `newText` property
+    /// of a provided `textEdit`.
+    var insertTextFormat: InsertTextFormat? = .snippet
+
     /// An edit which is applied to a document when selecting this completion. When an edit is
     /// provided the value of insertText is ignored.
     var textEdit: TextEdit?
@@ -49,6 +76,11 @@ public struct CompletionItem {
     /// Edits must not overlap with the main edit nor with themselves.
     var additionalTextEdits: [TextEdit]?
 
+    /// 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.
+    var commitCharacters: [Character]?
+
     /// An optional command that is executed *after* inserting this completion.
     ///
     /// - Note: That additional modifications to the current document should be described with the
@@ -92,6 +124,10 @@ extension CompletionItem : Ogra.Encodable {
             obj["insertText"] = JSON.string(insertText)
         }
 
+        if let insertTextFormat = self.insertTextFormat {
+            obj["insertTextFormat"] = JSON.number(NSNumber(value: insertTextFormat.rawValue))
+        }
+
         if let textEdit = self.textEdit {
             obj["textEdit"] = textEdit.encode()
         }