swiftlang/swift-package-manager

[SR-7828] Include name-based "fixits" whenever we do a unique name membership lookup

Open

#4803 opened on May 31, 2018

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Swift (10,145 stars) (1,462 forks)batch import
buggood first issue

Description
Previous ID SR-7828
Radar rdar://problem/34911728
Original Reporter @aciidb0mb3r
Type Bug
Status Reopened
Resolution
Votes 0
Component/s Package Manager
Labels Bug, StarterBug
Assignee None
Priority Medium

md5: 09bf5631fee7a0af06fa651808d31d64

Issue Description:

This diagnostic is not very good, SwiftPM should suggest the right spelling by comparing against the products which are available and suggesting a likely match if the string edit distance is small enough, similar to what the compiler does.

$ swift build
error: product dependency 'FooBar' not found

The edit distance algorithm as landed in SwiftPM with https://github.com/apple/swift-package-manager/pull/1431

Contributor guide

Tech stack
swift
Domain
clideveloper experience
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Swift programmingSwift Package ManagerEdit distance algorithmFamiliarity with PR #1431
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Investigate the current implementation of the error message 'product dependency ... not found' to understand how it is generated. Look at the edit distance algorithm introduced in PR #1431 (https://github.com/apple/swift package manager/pull/1431) and integrate it to provide suggestions. Identify the source file(s) where the diagnostic is raised, such as in the dependency resolution code, and implement a fix that compares the given name against available products and suggests likely matches using the edit distance algorithm.