Fix Package.swift diagnostics line off by 1 for tools versions <= 5.7 #7795
Conversation
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
SPM was implicitly preprending the manifest with 'import Foundation' for toolchains using swift version 5.7 and under. The original file itself was never overwritten, thus the diagnostics being reported would always present on the next line. This is a quick fix that appends the line to the end of the file; doing so assures that the intended behaviour doesn't change, but allows for correct diagnostics to be reported.
bripeticca
requested review from
bnbarham,
MaxDesiatov,
jakepetroules,
francescomikulis and
xedin
as code owners
|
@swift-ci please test |
MaxDesiatov
reviewed
Jul 18, 2024
Previous testing worked off of the incorrect line number that was reported by diagnostics.
bripeticca
force-pushed
the
packagediagnosticfix
branch
from
099fc73
to
110b602
Compare
|
@swift-ci please test |
|
@swift-ci test windows |
MaxDesiatov
added
package manifests
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes issue #7688
SwiftPM was implicitly prepending the manifest with 'import Foundation' for toolchains using Swift toolchain versions 5.7 and under. The original file itself was never overwritten, thus the diagnostics being reported would always present on the next line.
This is a quick fix that appends the same line to the end of the manifest; doing so assures that the intended behaviour doesn't change, but allows for correct diagnostics to be reported.
Motivation:
Diagnostics would present on the incorrect line for Package.swift files using tools version 5.7 and under.
Modifications:
When evaluating the manifest, a temporary directory copies the contents of the manifest to a temporary file; rather than prepending the import to Foundation at the top of the file (causing all lines in the diagnostic reports to be off by one), append the import to the bottom of the temporary manifest when dealing with tools versions 5.7 and under.
Result:
The intended behaviour that requires users to explicitly import Foundation doesn't change for Swift versions 5.8 and up; diagnostics reported for Package.swift files for those using swift <= 5.7 will now show on the correct line.