Correct "Did you mean XYZ" messages when a dependency is not found. #8303
Conversation
This file contains hidden or 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
Before: the test scenario asserted two cases: that a missing dependency triggers error; that a similar name includes a suggested correction. After: the test scenario asserts one case: that a missing dependency triggers error. Motivation: similar names already have dedicated tests, cleaning this up to provide more clarity on intent of the tests.
…cenarios. Refactor test and split into two to make it clear what scenario does it verify. Assert looks the same between the two tests, but the setup is different: - testByNameDependencyWithSimilarTargetName verifies typo in dependencies between modules within the same package. - testByNameDependencyWithSimilarProductName verifies typo in dependencies on a product from a different package.
Before: occasionally swiftpm suggested dependencies which aren't accurate, since it looked for global list of modules for matches, while actual depedencies are on products. After: swiftpm suggestions now search through - local modules - global products - package-specific products if explicit package is used in the deps Motivation: inaccurate suggestions which made me distrust swiftpm.
yyvch
requested review from
MaxDesiatov,
bkhouri,
bnbarham,
bripeticca,
dschaefer2,
jakepetroules,
owenv,
plemarquand,
shawnhyam and
xedin
as code owners
|
@swift-ci please test |
bripeticca
approved these changes
Feb 25, 2025
plemarquand
reviewed
Feb 25, 2025
|
@swift-ci please test |
|
@swift-ci test windows |
|
@swift-ci please test windows |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Correct "Did you mean XYZ" messages when a dependency is not found.
Motivation:
I found that "Did you mean XYZ" messages quite often aren't helpful. Specifically, scenarios which I found very frustrating:
Scenario 1:
.product(name="Awesomeness", package="MylibKit")Did you mean '.product(name="Awesomeness", package="MylibKit")'. I triple-checked what it suggested vs what I had, and after some staring, I checked MylibKit and indeed, it was missing a product definition. It was pretty frustrating that it errored out with suggestion which clearly wasn't working.Scenario 2:
"Awesomenes", making a typo.Did you mean 'Awesomenesswith correct spelling."Awesomeness".Did you mean '.product(name="Awesomeness", package="MylibKit")', and it's pretty frustrating why it didn't suggest it in the first place.Modifications:
Result: