Removes extension on SourceEdit since the issue was fixed in swift-syntax & updates documentations

Author: mustiikhalil

Sources/SourceKitLSP/DocumentManager.swift

@@ -141,10 +141,10 @@ public final class DocumentManager {
   ///   - newVersion: The new version of the document. Must be greater than the
   ///     latest version of the document.
   ///   - edits: The edits to apply to the document
-  ///   - requiresUpcomingEdits: Flag to return upcoming editst. Will be
-  ///     calling ``willEditDocument`` for each edit made
-  /// - Returns: The snapshot of the document before the edit and the snapshot
-  ///   of the document after the edit, including all edits that were made.
+  /// - Returns: The snapshot of the document before the edit, the snapshot, and edits.
+  ///   The edits are sequential, ie. the edits are
+  ///   expected to be applied in order and later values in this array assume that
+  ///   previous edits are already applied.
   @discardableResult
   public func edit(
     _ uri: DocumentURI,
@@ -157,9 +157,9 @@ public final class DocumentManager {
       }
       let preEditSnapshot = document.latestSnapshot
 
-      var upcomingEdits: [SourceEdit] = []
+      var sourceEdits: [SourceEdit] = []
       for edit in edits {
-        upcomingEdits.append(SourceEdit(edit: edit, lineTableBeforeEdit: document.latestLineTable))
+        sourceEdits.append(SourceEdit(edit: edit, lineTableBeforeEdit: document.latestLineTable))
 
         if let range = edit.range {
           document.latestLineTable.replace(
@@ -179,7 +179,7 @@ public final class DocumentManager {
         logger.error("Document version did not increase on edit from \(document.latestVersion) to \(newVersion)")
       }
       document.latestVersion = newVersion
-      return (preEditSnapshot, document.latestSnapshot, upcomingEdits)
+      return (preEditSnapshot, document.latestSnapshot, sourceEdits)
     }
   }
 
@@ -191,7 +191,6 @@ public final class DocumentManager {
       return document.latestSnapshot
     }
   }
-
 }
 
 extension DocumentManager {
@@ -214,7 +213,7 @@ extension DocumentManager {
     }
   }
 
-  /// Convenience wrapper for `edit(_:newVersion:edits:requiresUpcomingEdits:updateDocumentTokens:)`
+  /// Convenience wrapper for `edit(_:newVersion:edits:updateDocumentTokens:)`
   /// that logs on failure.
   @discardableResult
   func edit(
@@ -231,7 +230,6 @@ extension DocumentManager {
 }
 
 fileprivate extension SourceEdit {
-
   init(edit: TextDocumentContentChangeEvent, lineTableBeforeEdit: LineTable) {
     if let range = edit.range {
       guard let offset = lineTableBeforeEdit.utf8OffsetOf(line: range.lowerBound.line, utf16Column: range.lowerBound.utf16index),
@@ -249,5 +247,4 @@ fileprivate extension SourceEdit {
       )
     }
   }
-
 }

Sources/SourceKitLSP/Swift/SwiftLanguageServer.swift

@@ -510,7 +510,7 @@ extension SwiftLanguageServer {
         keys.enableDiagnostics: 0,
         keys.syntacticOnly: 1,
         keys.offset: edit.range.lowerBound.utf8Offset,
-        keys.length: edit.positiveLength,
+        keys.length: edit.length.utf8Length,
         keys.sourceText: edit.replacement,
       ])
       do {
@@ -524,7 +524,7 @@ extension SwiftLanguageServer {
       fromSequential: edits.map {
         IncrementalEdit(
           offset: $0.range.lowerBound.utf8Offset,
-          length: $0.positiveLength,
+          length: $0.length.utf8Length,
           replacementLength: $0.replacement.utf8.count
         )
       }
@@ -1107,10 +1107,3 @@ extension sourcekitd_api_uid_t {
     }
   }
 }
-
-extension SourceEdit {
-  var positiveLength: Int {
-    // Required since SourceEdit returns a negative length
-    -length.utf8Length
-  }
-}