Improve the error messages displayed by the JSON5 lexer and parser. #182
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
gcluzel
requested review from
NathanReb,
panglesd and
Leonidas-from-XIV
as code owners
* Display the line number in the error message * Try to harmonize the error messages with the ones displayed by the classic yojson parser.
gcluzel
force-pushed
the
better-error-messages
branch
from
6f4cdb8
to
b9a1530
Compare
Leonidas-from-XIV
requested changes
Jun 7, 2024
|
Thanks for the PR, it's definitely useful to have some better error messages. Can you add some tests for the error messages so that we know they are working fine and how they look? That will also serve as regression test. |
|
Thanks for the review. |
gcluzel
force-pushed
the
better-error-messages
branch
from
9b7ac7d
to
4796445
Compare
|
I think this is good for now. If you want to add more tests you're welcome. The CI failures are known and I have opened ocaml/opam-repository#26154 and ocaml/opam-repository#26156 to solve them but they are unrelated to the PR. Merging. Thanks for your contribution! |
Leonidas-from-XIV
approved these changes
Jun 27, 2024
Leonidas-from-XIV
merged commit 93f3496
into
ocaml-community:master
3 of 4 checks passed
Leonidas-from-XIV
added a commit
to Leonidas-from-XIV/opam-repository
that referenced
this pull request
Jun 27, 2024
CHANGES: *2024-06-27* ### Added - Add locations in the JSON5 parser error messages (@gcluzel, ocaml-community/yojson#182)
avsm
pushed a commit
to avsm/opam-repository
that referenced
this pull request
Sep 5, 2024
CHANGES: *2024-06-27* ### Added - Add locations in the JSON5 parser error messages (@gcluzel, ocaml-community/yojson#182)
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.
Since JSON5 is a standard intended to parse JSON written by humans, it's a bit unfortunate that the error messages were not very descriptive.
I tried to make them closer to the ones displayed by the classic YoJson parser. Also, when it's available, the line where the error message is located is displayed.