Make orchard.java.parser-utils/parse-java-test more easily debuggable
#205
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
bbatsov
reviewed
Oct 30, 2023
CHANGELOG.md
Outdated
| @@ -5,6 +5,7 @@ | |||
| ### Changes | |||
|
|
|||
| * [#202](https://github.com/clojure-emacs/orchard/issues/202): `orchard.inspect`: right-align indices when rendering indexed collections. | |||
| * Internal: make `orchard.java.parser-utils/parse-java-test` more easily debuggable. | |||
There was a problem hiding this comment.
Such changes don't need a changelog entry. (I guess end users are not supposed to use this function directly)
There was a problem hiding this comment.
It would SGTM to remove it. My reasoning is that users might be interesed in knowing that something changed, so that any new bugs could be correlated to that change.
There was a problem hiding this comment.
I normally never document internal changes unless they can be observed externally somehow (e.g. performance improvement). I think that's just noise for many of the users. At any rate - I don't feel strongly about this, so feel free to keep it.
|
I'm fine with the proposed change. |
We used to return nil for invalid .java source code. Now we throw an exception, with the parsing error diagnostics as part of the ex-data. Note that this doesn't change user-facing behavior, since all exceptions are caught by default in `orchard.java.parser/source-info` / `orchard.java.parser-next/source-info`. This helps debug faulty .java source code, see e.g. aws/aws-sdk-java#3045
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.
We used to return nil for invalid .java source code.
Now we throw an exception, with the parsing error diagnostics as part of the ex-data.
Note that this doesn't change user-facing behavior, since all exceptions are caught by default in
orchard.java.parser/source-info/orchard.java.parser-next/source-info.This helps debug faulty .java source code, see e.g. aws/aws-sdk-java#3045
Cheers - V