feat: return printable compilation diagnostics#53
Open
lukas-loering wants to merge 1 commit into
Open
Conversation
The previous implementation forwarded the display of source diagnostics to the debug implementation of Typst's `SourceDiagnostic`. While this prints the diagnostic message, other information like the diagnostics location in the source file, or the backtrace were not shown in a human- readble way. Crucially, this information could also **not** be obtained, as the `World` used for the compilation went out of scope as the compile function returned. This commit solves this issue by converting SourceDiagnostics to a new `Diagnostic` type, which resolves World dependent information, while keeping all other data of the SourceDiagnostic. Furthermore, a `Diagnostic` will display the information in a human-readable way.
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
1 participant
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.
The previous implementation forwarded the display of source diagnostics to the debug implementation of Typst's
SourceDiagnostic. While this prints the diagnostic message, other information like the diagnostics location in the source file, or the backtrace were not shown in a human- readble way.Crucially, this information could also not be obtained, as the
Worldused for the compilation went out of scope as the compile function returned.This commit solves this issue by converting SourceDiagnostics to a new
Diagnostictype, which resolves World dependent information, while keeping all other data of the SourceDiagnostic. Furthermore, aDiagnosticwill display the information in a human-readable way.Closes #19