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.
Author
|
@Relacibo Hey, just pinging you in case you did not see this PR :) |
Owner
|
ok thank you for the pr. I'll take a look at it. |
There was a problem hiding this comment.
Pull request overview
This PR improves how Typst compilation diagnostics are surfaced by resolving SourceDiagnostic information while the compilation World is still available, and by introducing a new pretty-printable diagnostic representation.
Changes:
- Add a new
diagnosticmodule that convertsSourceDiagnosticinto aDiagnostic/Diagnosticstype that can be displayed without aWorld. - Update compilation error handling to map Typst compilation errors into
TypstAsLibError::TypstSource(Diagnostics)using the in-scopeworld. - Change
TypstAsLibError::TypstSourcepayload type fromEcoVec<SourceDiagnostic>toDiagnosticsto enable human-readable formatting.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| src/lib.rs | Converts compilation error diagnostics into a new printable Diagnostics type and updates the public error enum accordingly. |
| src/diagnostic.rs | Introduces Diagnostic/Diagnostics and ResolvedSpan to pretty-print diagnostics without needing the compilation World. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -0,0 +1,182 @@ | |||
| //! Convert world dependent [`SourceDiagnositcs`] into independently displayable Diagnostics. | |||
Comment on lines
+37
to
+39
| /// This is basically a [`SourceDiagnostic`] where [`Spans`] have been converted to [`ResolvedSpans`], | ||
| /// so that diagnostic information can be obtained without access to the [`typst::World`] used for compilation. | ||
| /// |
Comment on lines
+151
to
+154
| impl Display for ResolvedSpan { | ||
| fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { | ||
| write!(f, "{:?}:{}", self.source.id().vpath(), self.location()) | ||
| } |
Comment on lines
148
to
151
| Warned { | ||
| output: output.map_err(Into::into), | ||
| output: output.map_err(|diags| TypstAsLibError::from_diagnostics(&world, diags)), | ||
| warnings, | ||
| } |
Comment on lines
748
to
753
| #[derive(Debug, Clone, Error)] | ||
| pub enum TypstAsLibError { | ||
| /// Errors from Typst source compilation. | ||
| #[error("Typst source error: {0:?}")] | ||
| TypstSource(EcoVec<SourceDiagnostic>), | ||
| #[error("{0}")] | ||
| TypstSource(Diagnostics), | ||
| /// Errors from file operations. |
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
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