Update WorkspaceEdit to match version 3.14 of the LSP spec

Author: ahoppen

Sources/LanguageServerProtocol/WorkspaceEdit.swift

@@ -16,38 +16,240 @@ public struct WorkspaceEdit: Hashable, ResponseType {
   /// The edits to be applied to existing resources.
   public var changes: [DocumentURI: [TextEdit]]?
 
-  public init(changes: [DocumentURI: [TextEdit]]?) {
+  public var documentChanges: [WorkspaceEditDocumentChange]?
+
+  public init(changes: [DocumentURI: [TextEdit]]? = nil, documentChanges: [WorkspaceEditDocumentChange]? = nil) {
     self.changes = changes
+    self.documentChanges = documentChanges
   }
 }
 
 // Workaround for Codable not correctly encoding dictionaries whose keys aren't strings.
 extension WorkspaceEdit: Codable {
   private enum CodingKeys: String, CodingKey {
     case changes
+    case documentChanges
   }
 
   public init(from decoder: Decoder) throws {
     let container = try decoder.container(keyedBy: CodingKeys.self)
-    let changesDict = try container.decode([String: [TextEdit]].self, forKey: .changes)
-    var changes = [DocumentURI: [TextEdit]]()
-    for change in changesDict {
-      let uri = DocumentURI(string: change.key)
-      changes[uri] = change.value
+    if let changesDict = try container.decodeIfPresent([String: [TextEdit]].self, forKey: .changes) {
+      var changes = [DocumentURI: [TextEdit]]()
+      for change in changesDict {
+        let uri = DocumentURI(string: change.key)
+        changes[uri] = change.value
+      }
+      self.changes = changes
+    } else {
+      self.changes = nil
     }
-    self.changes = changes
+    self.documentChanges = try container.decodeIfPresent([WorkspaceEditDocumentChange].self, forKey: .documentChanges)
   }
 
   public func encode(to encoder: Encoder) throws {
-    guard let changes = changes else {
-      return
+    var container = encoder.container(keyedBy: CodingKeys.self)
+    if let changes = changes {
+      var stringDictionary = [String: [TextEdit]]()
+      for (key, value) in changes {
+        stringDictionary[key.stringValue] = value
+      }
+      try container.encodeIfPresent(stringDictionary, forKey: .changes)
+    }
+    try container.encodeIfPresent(documentChanges, forKey: .documentChanges)
+  }
+}
+
+public enum WorkspaceEditDocumentChange: Codable, Hashable {
+  case textDocumentEdit(TextDocumentEdit)
+  case createFile(CreateFile)
+  case renameFile(RenameFile)
+  case deleteFile(DeleteFile)
+
+  public init(from decoder: Decoder) throws {
+    if let edit = try? TextDocumentEdit(from: decoder) {
+      self = .textDocumentEdit(edit)
+    } else if let createFile = try? CreateFile(from: decoder) {
+      self = .createFile(createFile)
+    } else if let renameFile = try? RenameFile(from: decoder) {
+      self = .renameFile(renameFile)
+    } else if let deleteFile = try? DeleteFile(from: decoder) {
+      self = .deleteFile(deleteFile)
+    } else {
+      let context = DecodingError.Context(codingPath: decoder.codingPath, debugDescription: "Could neither decode WorkspaceEditDocumentChange as   TextDocumentEdit, nor CreateFile, nor RenameFile, nor DeleteFile")
+      throw DecodingError.dataCorrupted(context)
+    }
+  }
+
+  public func encode(to encoder: Encoder) throws {
+    switch self {
+    case .textDocumentEdit(let textDocumentEdit):
+      try textDocumentEdit.encode(to: encoder)
+    case .createFile(let createFile):
+      try createFile.encode(to: encoder)
+    case .renameFile(let renameFile):
+      try renameFile.encode(to: encoder)
+    case .deleteFile(let deleteFile):
+      try deleteFile.encode(to: encoder)
+    }
+  }
+}
+
+ /// Options to create a file.
+public struct CreateFileOptions: Codable, Hashable {
+   /// Overwrite existing file. Overwrite wins over `ignoreIfExists`
+  public var overwrite: Bool?
+   /// Ignore if exists.
+  public var ignoreIfExists: Bool?
+
+  public init(overwrite: Bool? = nil, ignoreIfExists: Bool? = nil) {
+    self.overwrite = overwrite
+    self.ignoreIfExists = ignoreIfExists
+  }
+}
+
+ /// Create file operation
+public struct CreateFile: Codable, Hashable {
+   /// The resource to create.
+  public var uri: DocumentURI
+   /// Additional options
+  public var options: CreateFileOptions?
+
+  public init(uri: DocumentURI, options: CreateFileOptions? = nil) {
+    self.uri = uri
+    self.options = options
+  }
+
+  // MARK: Codable conformance
+
+  public enum CodingKeys: String, CodingKey {
+    case kind
+    case uri
+    case options
+  }
+
+  public init(from decoder: Decoder) throws {
+    let container = try decoder.container(keyedBy: CodingKeys.self)
+    let kind = try container.decode(String.self, forKey: .kind)
+    guard kind == "create" else {
+      throw DecodingError.dataCorruptedError(forKey: .kind, in: container, debugDescription: "Kind of CreateFile is not 'create'")
+    }
+    self.uri = try container.decode(DocumentURI.self, forKey: .uri)
+    self.options = try container.decodeIfPresent(CreateFileOptions.self, forKey: .options)
+  }
+
+  public func encode(to encoder: Encoder) throws {
+    var container = encoder.container(keyedBy: CodingKeys.self)
+    try container.encode("create", forKey: .kind)
+    try container.encode(self.uri, forKey: .uri)
+    try container.encodeIfPresent(self.options, forKey: .options)
+  }
+}
+
+ /// Rename file options
+public struct RenameFileOptions: Codable, Hashable {
+   /// Overwrite target if existing. Overwrite wins over `ignoreIfExists`
+  public var overwrite: Bool?
+   /// Ignores if target exists.
+  public var ignoreIfExists: Bool?
+
+  public init(overwrite: Bool? = nil, ignoreIfExists: Bool? = nil) {
+    self.overwrite = overwrite
+    self.ignoreIfExists = ignoreIfExists
+  }
+}
+
+ /// Rename file operation
+public struct RenameFile: Codable, Hashable {
+   /// The old (existing) location.
+  public var oldUri: DocumentURI
+   /// The new location.
+  public var newUri: DocumentURI
+   /// Rename options.
+  public var options: RenameFileOptions?
+
+  public init(oldUri: DocumentURI, newUri: DocumentURI, options: RenameFileOptions? = nil) {
+    self.oldUri = oldUri
+    self.newUri = newUri
+    self.options = options
+  }
+
+  // MARK: Codable conformance
+
+  public enum CodingKeys: String, CodingKey {
+    case kind
+    case oldUri
+    case newUri
+    case options
+  }
+
+  public init(from decoder: Decoder) throws {
+    let container = try decoder.container(keyedBy: CodingKeys.self)
+    let kind = try container.decode(String.self, forKey: .kind)
+    guard kind == "rename" else {
+      throw DecodingError.dataCorruptedError(forKey: .kind, in: container, debugDescription: "Kind of RenameFile is not 'rename'")
     }
-    var stringDictionary = [String: [TextEdit]]()
-    for (key, value) in changes {
-      stringDictionary[key.stringValue] = value
+    self.oldUri = try container.decode(DocumentURI.self, forKey: .oldUri)
+    self.newUri = try container.decode(DocumentURI.self, forKey: .newUri)
+    self.options = try container.decodeIfPresent(RenameFileOptions.self, forKey: .options)
+  }
+
+  public func encode(to encoder: Encoder) throws {
+    var container = encoder.container(keyedBy: CodingKeys.self)
+    try container.encode("rename", forKey: .kind)
+    try container.encode(self.oldUri, forKey: .oldUri)
+    try container.encode(self.newUri, forKey: .newUri)
+    try container.encodeIfPresent(self.options, forKey: .options)
+  }
+}
+
+ /// Delete file options
+public struct DeleteFileOptions: Codable, Hashable {
+   /// Delete the content recursively if a folder is denoted.
+  public var recursive: Bool?
+   /// Ignore the operation if the file doesn't exist.
+  public var ignoreIfNotExists: Bool?
+
+  public init(recursive: Bool? = nil, ignoreIfNotExists: Bool? = nil) {
+    self.recursive = recursive
+    self.ignoreIfNotExists = ignoreIfNotExists
+  }
+}
+
+ /// Delete file operation
+public struct DeleteFile: Codable, Hashable {
+   /// The file to delete.
+  public var uri: DocumentURI
+   /// Delete options.
+  public var options: DeleteFileOptions?
+
+  public init(uri: DocumentURI, options: DeleteFileOptions? = nil) {
+    self.uri = uri
+    self.options = options
+  }
+
+  // MARK: Codable conformance
+
+  public enum CodingKeys: String, CodingKey {
+    case kind
+    case uri
+    case options
+  }
+
+  public init(from decoder: Decoder) throws {
+    let container = try decoder.container(keyedBy: CodingKeys.self)
+    let kind = try container.decode(String.self, forKey: .kind)
+    guard kind == "delete" else {
+      throw DecodingError.dataCorruptedError(forKey: .kind, in: container, debugDescription: "Kind of DeleteFile is not 'delete'")
     }
+    self.uri = try container.decode(DocumentURI.self, forKey: .uri)
+    self.options = try container.decodeIfPresent(DeleteFileOptions.self, forKey: .options)
+  }
+
+  public func encode(to encoder: Encoder) throws {
     var container = encoder.container(keyedBy: CodingKeys.self)
-    try container.encode(stringDictionary, forKey: .changes)
+    try container.encode("delete", forKey: .kind)
+    try container.encode(self.uri, forKey: .uri)
+    try container.encodeIfPresent(self.options, forKey: .options)
   }
 }
 

Tests/LanguageServerProtocolTests/CodingTests.swift

@@ -265,6 +265,54 @@ final class CodingTests: XCTestCase {
         }
       }
       """)
+
+    checkCoding(WorkspaceEdit(documentChanges: [.textDocumentEdit(TextDocumentEdit(textDocument: VersionedTextDocumentIdentifier(uri, version: 2), edits: []))]), json: """
+      {
+        "documentChanges" : [
+          {
+            "edits" : [
+
+            ],
+            "textDocument" : {
+              "uri" : "\(urljson)",
+              "version" : 2
+            }
+          }
+        ]
+      }
+      """)
+    checkCoding(WorkspaceEdit(documentChanges: [.createFile(CreateFile(uri: uri))]), json: """
+    {
+      "documentChanges" : [
+        {
+          "kind" : "create",
+          "uri" : "\(urljson)"
+        }
+      ]
+    }
+    """)
+    checkCoding(WorkspaceEdit(documentChanges: [.renameFile(RenameFile(oldUri: uri, newUri: uri))]), json: """
+    {
+      "documentChanges" : [
+        {
+          "kind" : "rename",
+          "newUri" : "\(urljson)",
+          "oldUri" : "\(urljson)"
+        }
+      ]
+    }
+    """)
+    checkCoding(WorkspaceEdit(documentChanges: [.deleteFile(DeleteFile(uri: uri))]), json: """
+    {
+      "documentChanges" : [
+        {
+          "kind" : "delete",
+          "uri" : "\(urljson)"
+        }
+      ]
+    }
+    """)
+
   }
 
   func testPositionRange() {