Refine error message with package name suggestion #6897
Merged
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
mininny
requested review from
neonichu,
tomerd and
MaxDesiatov
as code owners
MaxDesiatov
reviewed
Sep 14, 2023
MaxDesiatov
reviewed
Sep 14, 2023
MaxDesiatov
changed the title
MaxDesiatov
reviewed
Sep 14, 2023
neonichu
reviewed
Sep 14, 2023
No, this is not a true fix-it that users can interact on(e.g. click to replace text). It's just a text inside warning that gives a clue about detecting typos. |
mininny
force-pushed
the
add-fix-it-for-similar-package-dependency
branch
from
e6d992c to
efd8395
Compare
… provided in the dependency
mininny
force-pushed
the
add-fix-it-for-similar-package-dependency
branch
from
efd8395 to
ab88fd3
Compare
MaxDesiatov
changed the title
MaxDesiatov
approved these changes
Sep 18, 2023
|
@swift-ci test |
MaxDesiatov
pushed a commit
that referenced
this pull request
Sep 28, 2023
… provided in the dependency (#6897) Update error message when there's a package target with a similar name as the one provided in the dependency. ### Motivation: Partially addresses #4803. It adds a suggestion for an alternative dependency name when there's a dependency target with similar name as the one provided in the `Package.swift`. ### Modifications: Use the existing `bestMatch(for, from)` from TSCBasic to compare the `productRef.name` and `allTargetNames`. However, I'm not sure how and if I can include target from system packages. ### Result: Error messages for package target not found may also suggest an alternative name like: `product 'Barx' required by package 'foo' target 'FooTarget' not found. Did you mean 'Bar'?`
MaxDesiatov
pushed a commit
that referenced
this pull request
Sep 28, 2023
… provided in the dependency (#6897) Update error message when there's a package target with a similar name as the one provided in the dependency. ### Motivation: Partially addresses #4803. It adds a suggestion for an alternative dependency name when there's a dependency target with similar name as the one provided in the `Package.swift`. ### Modifications: Use the existing `bestMatch(for, from)` from TSCBasic to compare the `productRef.name` and `allTargetNames`. However, I'm not sure how and if I can include target from system packages. ### Result: Error messages for package target not found may also suggest an alternative name like: `product 'Barx' required by package 'foo' target 'FooTarget' not found. Did you mean 'Bar'?`
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.
Update error message when there's a package target with a similar name as the one provided in the dependency.
Motivation:
Partially addresses #4803.
It adds a suggestion for an alternative dependency name when there's a dependency target with similar name as the one provided in the
Package.swift.Modifications:
Use the existing
bestMatch(for, from)from TSCBasic to compare theproductRef.nameandallTargetNames.However, I'm not sure how and if I can include target from system packages.
Result:
Error messages for package target not found may also suggest an alternative name like:
product 'Barx' required by package 'foo' target 'FooTarget' not found. Did you mean 'Bar'?