feat: Improve role resolution error diagnostics#763
Draft
ejgallego wants to merge 3 commits intoleanprover:mainfrom
Draft
feat: Improve role resolution error diagnostics#763ejgallego wants to merge 3 commits intoleanprover:mainfrom
ejgallego wants to merge 3 commits intoleanprover:mainfrom
Conversation
As seen in leanprover#762 , the experience of using a non-registered or incorrect role is far from ideal. In particular, the error message is a syntax error. We can do better if we only consider registered roles for name resolution. In order to do this we: remove the role-inline fallback that treated unknown/unregistered roles as plain function applications - add explicit diagnostics for role resolution failures: - function found but not registered as a role - function found but likely not a role - unknown role with fuzzy suggestion when close, otherwise an available-role list - display short role names (in-scope style) in diagnostics - expose `registeredRoleNames` in `Verso.Doc.Elab.Monad` to support role diagnostics - add `Tests.RoleResolution` and wire it into `src/tests/Tests.lean` This PR is a RFC. If accepted, I'd suggest implementing the same idea for directives and commands, and implement role/directive/command auto-completion as a follow-up.
ejgallego
force-pushed
the
research/role-fallback
branch
from
d9ac671 to
3796cec
Compare
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
2 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.
As seen in #762 , the experience of using a non-registered or incorrect role is far from ideal. In particular, the error message is a syntax error. We can do better if we only consider registered roles for name resolution.
In order to do this we:
remove the role-inline fallback that treated unknown/unregistered roles as plain function applications
registeredRoleNamesinVerso.Doc.Elab.Monadto support role diagnosticsTests.RoleResolutionand wire it intosrc/tests/Tests.leanThis PR is a RFC. If accepted, I'd suggest implementing the same idea for directives and commands, and implement role/directive/command auto-completion as a follow-up.
Notes: