-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix application of fix-its replacing parent instead of first child (#16)
* Bump deps * Add test showing that a fix-it wrongly replaces parent instead of targeted child See #15. * Don't replace parent syntax collection when targeting its first child This pulls in the latest `FixItApplier` from swift-syntax `main` (d647052), which is now String-based. Fixes #15.
- Loading branch information
Showing
5 changed files
with
342 additions
and
69 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| //===----------------------------------------------------------------------===// | ||
| // | ||
| // This source file is part of the Swift.org open source project | ||
| // | ||
| // Copyright (c) 2014 - 2023 Apple Inc. and the Swift project authors | ||
| // Licensed under Apache License v2.0 with Runtime Library Exception | ||
| // | ||
| // See https://swift.org/LICENSE.txt for license information | ||
| // See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors | ||
| // | ||
| //===----------------------------------------------------------------------===// | ||
|
|
||
| import SwiftSyntax | ||
|
|
||
| /// A textual edit to the original source represented by a range and a | ||
| /// replacement. | ||
| public struct SourceEdit: Equatable { | ||
| /// The half-open range that this edit applies to. | ||
| public let range: Range<AbsolutePosition> | ||
| /// The text to replace the original range with. Empty for a deletion. | ||
| public let replacement: String | ||
|
|
||
| /// Length of the original source range that this edit applies to. Zero if | ||
| /// this is an addition. | ||
| public var length: SourceLength { | ||
| return SourceLength(utf8Length: range.lowerBound.utf8Offset - range.upperBound.utf8Offset) | ||
| } | ||
|
|
||
| /// Create an edit to replace `range` in the original source with | ||
| /// `replacement`. | ||
| public init(range: Range<AbsolutePosition>, replacement: String) { | ||
| self.range = range | ||
| self.replacement = replacement | ||
| } | ||
|
|
||
| /// Convenience function to create a textual addition after the given node | ||
| /// and its trivia. | ||
| public static func insert(_ newText: String, after node: some SyntaxProtocol) -> SourceEdit { | ||
| return SourceEdit(range: node.endPosition..<node.endPosition, replacement: newText) | ||
| } | ||
|
|
||
| /// Convenience function to create a textual addition before the given node | ||
| /// and its trivia. | ||
| public static func insert(_ newText: String, before node: some SyntaxProtocol) -> SourceEdit { | ||
| return SourceEdit(range: node.position..<node.position, replacement: newText) | ||
| } | ||
|
|
||
| /// Convenience function to create a textual replacement of the given node, | ||
| /// including its trivia. | ||
| public static func replace(_ node: some SyntaxProtocol, with replacement: String) -> SourceEdit { | ||
| return SourceEdit(range: node.position..<node.endPosition, replacement: replacement) | ||
| } | ||
|
|
||
| /// Convenience function to create a textual deletion the given node and its | ||
| /// trivia. | ||
| public static func remove(_ node: some SyntaxProtocol) -> SourceEdit { | ||
| return SourceEdit(range: node.position..<node.endPosition, replacement: "") | ||
| } | ||
| } | ||
|
|
||
| extension SourceEdit: CustomDebugStringConvertible { | ||
| public var debugDescription: String { | ||
| let hasNewline = replacement.contains { $0.isNewline } | ||
| if hasNewline { | ||
| return #""" | ||
| \#(range.lowerBound.utf8Offset)-\#(range.upperBound.utf8Offset) | ||
| """ | ||
| \#(replacement) | ||
| """ | ||
| """# | ||
| } | ||
| return "\(range.lowerBound.utf8Offset)-\(range.upperBound.utf8Offset) \"\(replacement)\"" | ||
| } | ||
| } |
109 changes: 109 additions & 0 deletions
109
Sources/MacroTesting/_SwiftSyntaxTestSupport/FixItApplier.swift
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| //===----------------------------------------------------------------------===// | ||
| // | ||
| // This source file is part of the Swift.org open source project | ||
| // | ||
| // Copyright (c) 2014 - 2023 Apple Inc. and the Swift project authors | ||
| // Licensed under Apache License v2.0 with Runtime Library Exception | ||
| // | ||
| // See https://swift.org/LICENSE.txt for license information | ||
| // See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors | ||
| // | ||
| //===----------------------------------------------------------------------===// | ||
|
|
||
| import SwiftDiagnostics | ||
| import SwiftSyntax | ||
| import SwiftSyntaxMacroExpansion | ||
|
|
||
| public enum FixItApplier { | ||
| /// Applies selected or all Fix-Its from the provided diagnostics to a given syntax tree. | ||
| /// | ||
| /// - Parameters: | ||
| /// - diagnostics: An array of `Diagnostic` objects, each containing one or more Fix-Its. | ||
| /// - filterByMessages: An optional array of message strings to filter which Fix-Its to apply. | ||
| /// If `nil`, the first Fix-It from each diagnostic is applied. | ||
| /// - tree: The syntax tree to which the Fix-Its will be applied. | ||
| /// | ||
| /// - Returns: A `String` representation of the modified syntax tree after applying the Fix-Its. | ||
| // public static func applyFixes( | ||
| // from diagnostics: [Diagnostic], | ||
| // filterByMessages messages: [String]?, | ||
| // to tree: any SyntaxProtocol | ||
| // ) -> String { | ||
| // let messages = messages ?? diagnostics.compactMap { $0.fixIts.first?.message.message } | ||
| // | ||
| // let edits = | ||
| // diagnostics | ||
| // .flatMap(\.fixIts) | ||
| // .filter { messages.contains($0.message.message) } | ||
| // .flatMap(\.edits) | ||
| // | ||
| // return self.apply(edits: edits, to: tree) | ||
| // } | ||
|
|
||
| /// Apply the given edits to the syntax tree. | ||
| /// | ||
| /// - Parameters: | ||
| /// - edits: The edits to apply to the syntax tree | ||
| /// - tree: he syntax tree to which the edits should be applied. | ||
| /// - Returns: A `String` representation of the modified syntax tree after applying the edits. | ||
| public static func apply( | ||
| edits: [SourceEdit], | ||
| to tree: any SyntaxProtocol | ||
| ) -> String { | ||
| var edits = edits | ||
| var source = tree.description | ||
|
|
||
| while let edit = edits.first { | ||
| edits = Array(edits.dropFirst()) | ||
|
|
||
| let startIndex = source.utf8.index(source.utf8.startIndex, offsetBy: edit.startUtf8Offset) | ||
| let endIndex = source.utf8.index(source.utf8.startIndex, offsetBy: edit.endUtf8Offset) | ||
|
|
||
| source.replaceSubrange(startIndex..<endIndex, with: edit.replacement) | ||
|
|
||
| edits = edits.compactMap { remainingEdit -> SourceEdit? in | ||
| if remainingEdit.replacementRange.overlaps(edit.replacementRange) { | ||
| // The edit overlaps with the previous edit. We can't apply both | ||
| // without conflicts. Apply the one that's listed first and drop the | ||
| // later edit. | ||
| return nil | ||
| } | ||
|
|
||
| // If the remaining edit starts after or at the end of the edit that we just applied, | ||
| // shift it by the current edit's difference in length. | ||
| if edit.endUtf8Offset <= remainingEdit.startUtf8Offset { | ||
| let startPosition = AbsolutePosition( | ||
| utf8Offset: remainingEdit.startUtf8Offset - edit.replacementRange.count | ||
| + edit.replacementLength) | ||
| let endPosition = AbsolutePosition( | ||
| utf8Offset: remainingEdit.endUtf8Offset - edit.replacementRange.count | ||
| + edit.replacementLength) | ||
| return SourceEdit( | ||
| range: startPosition..<endPosition, replacement: remainingEdit.replacement) | ||
| } | ||
|
|
||
| return remainingEdit | ||
| } | ||
| } | ||
|
|
||
| return source | ||
| } | ||
| } | ||
|
|
||
| extension SourceEdit { | ||
| fileprivate var startUtf8Offset: Int { | ||
| return range.lowerBound.utf8Offset | ||
| } | ||
|
|
||
| fileprivate var endUtf8Offset: Int { | ||
| return range.upperBound.utf8Offset | ||
| } | ||
|
|
||
| fileprivate var replacementLength: Int { | ||
| return replacement.utf8.count | ||
| } | ||
|
|
||
| fileprivate var replacementRange: Range<Int> { | ||
| return startUtf8Offset..<endUtf8Offset | ||
| } | ||
| } |
Oops, something went wrong.