Produce a meaningful error message for invalid module name #1354
Conversation
This file contains 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
While the AST form of the error generated by `modules/modulepaths` is
handled, the symbol form was not, creating terrible error messages like:
Error: invalid module name '<nil tree>'
This commit makes cli_reporter aware of the symbol form generated by
`modules/modules`, fixing the bad error message.
This allow us to test the error message with testament, as well as giving the user a better idea as to which file is the culprit.
zerbina
added
bug
zerbina
approved these changes
Jun 19, 2024
There was a problem hiding this comment.
Looks good to me, thank you for reviving the fix!
I think the current description is okay as is, but for future PRs, especially those with a more outside-facing change (like this fix), could you focus the summary more on the user-facing changes? Along the lines of "this was the visible previous behaviour, this is how it behaves now", with the implementation details going into the "Details" section.
Co-authored-by: zerbina <[email protected]>
zerbina
added
compiler/msgs
|
/merge |
|
Merge requested by: @zerbina Contents after the first section break of the PR description has been removed and preserved below:
|
This was referenced Jun 19, 2024
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.
Summary
While the AST form of the error generated by
modules/modulepathsishandled in
cli_reporter, the symbol form was not, creating terribleerror messages such as:
This PR makes cli_reporter aware of the symbol form generated by
modules/modules, fixing the bad error message.Details
cli_reporternow handles the symbol form ofrsemInvalidModuleNamecorrectly.modules/modulesnow raisesrsemInvalidModuleNamewith lineinformation, allowing user and tools to know which file the error
originated from.
Fixes #720