Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

refactor(diagnostics): indentation #3722

Merged
merged 1 commit into from
Aug 26, 2024
Merged

refactor(diagnostics): indentation #3722

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
129 changes: 55 additions & 74 deletions crates/biome_diagnostics/src/display.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
use std::path::Path;
use std::{env, io, iter};

use biome_console::fmt::MarkupElements;
use biome_console::{fmt, markup, HorizontalLine, Markup, MarkupBuf, MarkupElement, MarkupNode};
use biome_text_edit::TextEdit;
use unicode_width::UnicodeWidthStr;
Expand Down Expand Up @@ -38,7 +39,6 @@ pub struct PrintDiagnostic<'fmt, D: ?Sized> {
diag: &'fmt D,
verbose: bool,
search: bool,
escape_indentation: bool,
}

impl<'fmt, D: AsDiagnostic + ?Sized> PrintDiagnostic<'fmt, D> {
Expand All @@ -47,7 +47,6 @@ impl<'fmt, D: AsDiagnostic + ?Sized> PrintDiagnostic<'fmt, D> {
diag,
verbose: false,
search: false,
escape_indentation: false,
}
}

Expand All @@ -56,7 +55,6 @@ impl<'fmt, D: AsDiagnostic + ?Sized> PrintDiagnostic<'fmt, D> {
diag,
verbose: true,
search: false,
escape_indentation: false,
}
}

Expand All @@ -65,17 +63,8 @@ impl<'fmt, D: AsDiagnostic + ?Sized> PrintDiagnostic<'fmt, D> {
diag,
verbose: false,
search: true,
escape_indentation: false,
}
}

/// When enabled, the indentation of the messages will be escaped using `&nbsp;`, which is HTML friendly.
///
/// Various tools out there, notably MDX, treats tags with whitespaces differently, and they will strip them.
pub fn with_escaped_indentation(mut self) -> Self {
self.escape_indentation = true;
self
}
}

impl<D: AsDiagnostic + ?Sized> fmt::Display for PrintDiagnostic<'_, D> {
Expand All @@ -86,31 +75,16 @@ impl<D: AsDiagnostic + ?Sized> fmt::Display for PrintDiagnostic<'_, D> {
fmt.write_markup(markup! {
{PrintHeader(diagnostic)}"\n\n"
})?;
let indentation = if self.escape_indentation {
"&nbsp;&nbsp;"
} else {
" "
};
// Wrap the formatter with an indentation level and print the advices
let mut slot = None;
let mut fmt = IndentWriter::wrap(fmt, &mut slot, true, indentation);
let mut fmt = IndentWriter::wrap(fmt, &mut slot, true, " ");

if self.search {
let mut visitor = PrintSearch(&mut fmt);
print_advices(
&mut visitor,
diagnostic,
self.verbose,
self.escape_indentation,
)
print_advices(&mut visitor, diagnostic, self.verbose)
} else {
let mut visitor = PrintAdvices(&mut fmt);
print_advices(
&mut visitor,
diagnostic,
self.verbose,
self.escape_indentation,
)
print_advices(&mut visitor, diagnostic, self.verbose)
}
}
}
Expand Down Expand Up @@ -260,12 +234,7 @@ impl<W: fmt::Write + ?Sized> fmt::Write for CountWidth<'_, W> {
}

/// Write the advices for `diagnostic` into `visitor`.
fn print_advices<V, D>(
visitor: &mut V,
diagnostic: &D,
verbose: bool,
escape_indentation: bool,
) -> io::Result<()>
fn print_advices<V, D>(visitor: &mut V, diagnostic: &D, verbose: bool) -> io::Result<()>
where
V: Visit,
D: Diagnostic + ?Sized,
Expand All @@ -282,7 +251,7 @@ where
let skip_frame = frame_visitor.skip_frame;

// Print the message for the diagnostic as a log advice
print_message_advice(visitor, diagnostic, skip_frame, escape_indentation)?;
print_message_advice(visitor, diagnostic, skip_frame)?;

// Print the other advices for the diagnostic
diagnostic.advices(visitor)?;
Expand Down Expand Up @@ -328,12 +297,7 @@ impl Visit for FrameVisitor<'_> {
}

/// Print the message and code frame for the diagnostic as advices.
fn print_message_advice<V, D>(
visitor: &mut V,
diagnostic: &D,
skip_frame: bool,
escape_indentation: bool,
) -> io::Result<()>
fn print_message_advice<V, D>(visitor: &mut V, diagnostic: &D, skip_frame: bool) -> io::Result<()>
where
V: Visit,
D: Diagnostic + ?Sized,
Expand All @@ -342,7 +306,7 @@ where
let message = {
let mut message = MarkupBuf::default();
let mut fmt = fmt::Formatter::new(&mut message);
fmt.write_markup(markup!({ PrintCauseChain(diagnostic, escape_indentation) }))?;
fmt.write_markup(markup!({ PrintCauseChain(diagnostic) }))?;
message
};

Expand Down Expand Up @@ -378,11 +342,11 @@ where

/// Display wrapper for printing the "cause chain" of a diagnostic, with the
/// message of this diagnostic and all of its sources.
struct PrintCauseChain<'fmt, D: ?Sized>(&'fmt D, bool);
struct PrintCauseChain<'fmt, D: ?Sized>(&'fmt D);

impl<D: Diagnostic + ?Sized> fmt::Display for PrintCauseChain<'_, D> {
fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> io::Result<()> {
let Self(diagnostic, should_escape_indentation) = *self;
let Self(diagnostic) = *self;

diagnostic.message(fmt)?;

Expand All @@ -391,12 +355,7 @@ impl<D: Diagnostic + ?Sized> fmt::Display for PrintCauseChain<'_, D> {
fmt.write_str("\n\nCaused by:\n")?;

let mut slot = None;
let indentation = if should_escape_indentation {
"&nbsp;&nbsp;"
} else {
" "
};
let mut fmt = IndentWriter::wrap(fmt, &mut slot, true, indentation);
let mut fmt = IndentWriter::wrap(fmt, &mut slot, true, " ");
diagnostic.message(&mut fmt)?;
}

Expand Down Expand Up @@ -614,7 +573,8 @@ impl<W: fmt::Write + ?Sized> fmt::Write for IndentWriter<'_, W> {
) -> io::Result<()> {
while !content.is_empty() {
if self.pending_indent {
self.writer.write_str(elements, self.ident_text)?;
self.writer
.write_str(&MarkupElements::Root, self.ident_text)?;
self.pending_indent = false;
}

Expand Down Expand Up @@ -843,9 +803,11 @@ mod tests {
let expected = markup!{
"path:1:1 internalError/io "<Inverse>" FIXABLE "</Inverse>" ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n"
"\n"
<Emphasis><Error>" ✖"</Error></Emphasis>" "<Error>"diagnostic message"</Error>"\n"
" "
<Emphasis><Error>"✖"</Error></Emphasis>" "<Error>"diagnostic message"</Error>"\n"
" \n"
<Emphasis><Error>" >"</Error></Emphasis>" "<Emphasis>"1 │ "</Emphasis>"source code\n"
" "
<Emphasis><Error>">"</Error></Emphasis>" "<Emphasis>"1 │ "</Emphasis>"source code\n"
" "<Emphasis>" │ "</Emphasis><Emphasis><Error>"^^^^^^"</Error></Emphasis>"\n"
" \n"
}.to_owned();
Expand All @@ -867,13 +829,17 @@ mod tests {
let expected = markup!{
"internalError/io "<Inverse>" FIXABLE "</Inverse>" ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n"
"\n"
<Emphasis><Error>" ✖"</Error></Emphasis>" "<Error>"diagnostic message"</Error>"\n"
" "
<Emphasis><Error>"✖"</Error></Emphasis>" "<Error>"diagnostic message"</Error>"\n"
" \n"
<Emphasis><Error>" ✖"</Error></Emphasis>" "<Error>"error"</Error>"\n"
" "
<Emphasis><Error>"✖"</Error></Emphasis>" "<Error>"error"</Error>"\n"
" \n"
<Emphasis><Warn>" ⚠"</Warn></Emphasis>" "<Warn>"warn"</Warn>"\n"
" "
<Emphasis><Warn>"⚠"</Warn></Emphasis>" "<Warn>"warn"</Warn>"\n"
" \n"
<Emphasis><Info>" ℹ"</Info></Emphasis>" "<Info>"info"</Info>"\n"
" "
<Emphasis><Info>"ℹ"</Info></Emphasis>" "<Info>"info"</Info>"\n"
" \n"
" none\n"
" \n"
Expand All @@ -897,7 +863,8 @@ mod tests {
let expected = markup!{
"internalError/io "<Inverse>" FIXABLE "</Inverse>" ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n"
"\n"
<Emphasis><Error>" ✖"</Error></Emphasis>" "<Error>"diagnostic message"</Error>"\n"
" "
<Emphasis><Error>"✖"</Error></Emphasis>" "<Error>"diagnostic message"</Error>"\n"
" \n"
" - item 1\n"
" - item 2\n"
Expand All @@ -922,9 +889,11 @@ mod tests {
let expected = markup!{
"internalError/io "<Inverse>" FIXABLE "</Inverse>" ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n"
"\n"
<Emphasis><Error>" ✖"</Error></Emphasis>" "<Error>"diagnostic message"</Error>"\n"
" "
<Emphasis><Error>"✖"</Error></Emphasis>" "<Error>"diagnostic message"</Error>"\n"
" \n"
<Emphasis><Error>" >"</Error></Emphasis>" "<Emphasis>"1 │ "</Emphasis>"context location context\n"
" "
<Emphasis><Error>">"</Error></Emphasis>" "<Emphasis>"1 │ "</Emphasis>"context location context\n"
" "<Emphasis>" │ "</Emphasis>" "<Emphasis><Error>"^^^^^^^^"</Error></Emphasis>"\n"
" \n"
}.to_owned();
Expand All @@ -947,10 +916,13 @@ mod tests {
let expected = markup!{
"internalError/io "<Inverse>" FIXABLE "</Inverse>" ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n"
"\n"
<Emphasis><Error>" ✖"</Error></Emphasis>" "<Error>"diagnostic message"</Error>"\n"
" "
<Emphasis><Error>"✖"</Error></Emphasis>" "<Error>"diagnostic message"</Error>"\n"
" \n"
<Error>" -"</Error>" "<Error>"context"</Error><Error><Dim>"·"</Dim></Error><Error><Emphasis>"before"</Emphasis></Error><Error><Dim>"·"</Dim></Error><Error>"context"</Error>"\n"
<Success>" +"</Success>" "<Success>"context"</Success><Success><Dim>"·"</Dim></Success><Success><Emphasis>"after"</Emphasis></Success><Success><Dim>"·"</Dim></Success><Success>"context"</Success>"\n"
" "
<Error>"-"</Error>" "<Error>"context"</Error><Error><Dim>"·"</Dim></Error><Error><Emphasis>"before"</Emphasis></Error><Error><Dim>"·"</Dim></Error><Error>"context"</Error>"\n"
" "
<Success>"+"</Success>" "<Success>"context"</Success><Success><Dim>"·"</Dim></Success><Success><Emphasis>"after"</Emphasis></Success><Success><Dim>"·"</Dim></Success><Success>"context"</Success>"\n"
" \n"
}.to_owned();

Expand All @@ -972,9 +944,11 @@ mod tests {
let expected = markup!{
"internalError/io "<Inverse>" FIXABLE "</Inverse>" ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n"
"\n"
<Emphasis><Error>" ✖"</Error></Emphasis>" "<Error>"diagnostic message"</Error>"\n"
" "
<Emphasis><Error>"✖"</Error></Emphasis>" "<Error>"diagnostic message"</Error>"\n"
" \n"
<Emphasis><Info>" ℹ"</Info></Emphasis>" "<Info>"Backtrace Title"</Info>"\n"
" "
<Emphasis><Info>"ℹ"</Info></Emphasis>" "<Info>"Backtrace Title"</Info>"\n"
" \n"
" 0: crate::module::function\n"
" at crate/src/module.rs:8:16\n"
Expand All @@ -998,9 +972,11 @@ mod tests {
let expected = markup!{
"internalError/io "<Inverse>" FIXABLE "</Inverse>" ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n"
"\n"
<Emphasis><Error>" ✖"</Error></Emphasis>" "<Error>"diagnostic message"</Error>"\n"
" "
<Emphasis><Error>"✖"</Error></Emphasis>" "<Error>"diagnostic message"</Error>"\n"
" \n"
<Emphasis>" $"</Emphasis>" biome command --argument\n"
" "
<Emphasis>"$"</Emphasis>" biome command --argument\n"
" \n"
}.to_owned();

Expand All @@ -1022,15 +998,20 @@ mod tests {
let expected = markup!{
"internalError/io "<Inverse>" FIXABLE "</Inverse>" ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n"
"\n"
<Emphasis><Error>" ✖"</Error></Emphasis>" "<Error>"diagnostic message"</Error>"\n"
" "
<Emphasis><Error>"✖"</Error></Emphasis>" "<Error>"diagnostic message"</Error>"\n"
" \n"
<Emphasis>" Group Title"</Emphasis>"\n"
" "
<Emphasis>"Group Title"</Emphasis>"\n"
" \n"
<Emphasis><Error>" ✖"</Error></Emphasis>" "<Error>"error"</Error>"\n"
" "
<Emphasis><Error>"✖"</Error></Emphasis>" "<Error>"error"</Error>"\n"
" \n"
<Emphasis><Warn>" ⚠"</Warn></Emphasis>" "<Warn>"warn"</Warn>"\n"
" "
<Emphasis><Warn>"⚠"</Warn></Emphasis>" "<Warn>"warn"</Warn>"\n"
" \n"
<Emphasis><Info>" ℹ"</Info></Emphasis>" "<Info>"info"</Info>"\n"
" "
<Emphasis><Info>"ℹ"</Info></Emphasis>" "<Info>"info"</Info>"\n"
" \n"
" none\n"
" \n"
Expand Down
30 changes: 10 additions & 20 deletions crates/biome_diagnostics/tests/disagnostics.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ use biome_console::fmt::{Formatter, HTML};
use biome_console::markup;
use biome_diagnostics::{DiagnosticTags, MessageAndDescription, PrintDiagnostic};
use biome_diagnostics_macros::Diagnostic;
use biome_text_size::TextRange;

#[derive(Diagnostic, Debug)]
#[diagnostic(
Expand All @@ -18,6 +19,12 @@ struct TestDiagnostic {

#[location(resource)]
path: String,

#[location(source_code)]
source_code: String,

#[location(span)]
span: TextRange,
}

impl Default for TestDiagnostic {
Expand All @@ -27,7 +34,9 @@ impl Default for TestDiagnostic {
"This is the message of the diagnostic. It will appear in different colours based on the severity of the diagnostic."
).to_owned()),
tags: DiagnosticTags::FIXABLE,
path: "code_block".to_string()
path: "code_block".to_string(),
source_code: "fn main() {\n println!(\"Hello, world!\");\n}".to_string(),
span: TextRange::new(10.into(), 20.into())
}
}
}
Expand Down Expand Up @@ -72,22 +81,3 @@ fn html_mdx_print_diagnostic() {
insta::assert_snapshot!(content);
});
}

#[test]
fn html_mdx_print_diagnostic_with_escaped_indentation() {
let mut content = vec![];
let mut writer = HTML::new(&mut content).with_mdx();

Formatter::new(&mut writer)
.write_markup(markup! {
{PrintDiagnostic::simple(&TestDiagnostic::default()).with_escaped_indentation()}
})
.unwrap();

let content = String::from_utf8(content).unwrap();
insta::with_settings!({
prepend_module_to_snapshot => false,
}, {
insta::assert_snapshot!(content);
});
}
2 changes: 1 addition & 1 deletion crates/biome_diagnostics/tests/snapshots/html_mdx_print_diagnostic.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
source: crates/biome_diagnostics/tests/disagnostics.rs
expression: content
---
code&#95;block check <span style="color: #000; background-color: #ddd;"> FIXABLE </span> ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━<br /><br /><strong><span style="color: Tomato;"> </span></strong><strong><span style="color: Tomato;">✖</span></strong> <span style="color: Tomato;">This is the message of the diagnostic. It will appear in different colours based on the severity of the diagnostic.</span><br /> <br />
code&#95;block:1:11 check <span style="color: #000; background-color: #ddd;"> FIXABLE </span> ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━<br /><br /> <strong><span style="color: Tomato;">✖</span></strong> <span style="color: Tomato;">This is the message of the diagnostic. It will appear in different colours based on the severity of the diagnostic.</span><br /> <br /> <strong><span style="color: Tomato;">&gt;</span></strong> <strong>1 │ </strong>fn main() &#123;<br /> <strong> │ </strong> <strong><span style="color: Tomato;">^</span></strong><br /> <strong><span style="color: Tomato;">&gt;</span></strong> <strong>2 │ </strong> println!(&quot;Hello, world!&quot;);<br /> <strong> │ </strong> <strong><span style="color: Tomato;">^</span></strong><strong><span style="color: Tomato;">^</span></strong><strong><span style="color: Tomato;">^</span></strong><strong><span style="color: Tomato;">^</span></strong><br /> <strong>3 │ </strong>&#125;<br /> <br />
Copy link
Member Author

@ematipico ematipico Aug 26, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Notice here, after the first two <br /><br /> that you can find after the long line. We have two whitespace. They aren't wrapped by any special tag. Instead, on the left, we have <strong><span style="color: Tomato;"> </span></strong>

5 changes: 0 additions & 5 deletions ...biome_diagnostics/tests/snapshots/html_mdx_print_diagnostic_with_escaped_indentation.snap
View file
Open in desktop

This file was deleted.

Loading