feat: structured hints for unsatisfiable conflicts#234
Open
baszalmstra wants to merge 1 commit into
Open
Conversation
Add Conflict::hints, which returns machine-actionable explanations of why a solve failed alongside the existing rendered error message. Each hint describes a single cause, such as an unavailable package, a version that does not match, candidates that were all excluded, incompatible requests, an unfulfillable constraint, or a lock.
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
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.
When a solve fails, resolvo can render a human readable explanation, but it offers nothing a program can act on. That makes it hard to build helpful tooling on top, such as suggesting a fix for a misspelled package name or pointing out that a package is not available for the current platform.
This adds a way to get the causes of a conflict as structured data, next to the existing rendered message. Each hint describes a single cause: an unavailable package, a version that does not match, candidates that were all excluded, incompatible requests, an unfulfillable constraint, or a lock. The existing error message is unchanged.
Tested with snapshots covering each kind of hint.