Skip to content

Commit 6946835

Browse files
dyc3dyc3
committed
fix(parse/html): don't lex astro fence when we've already processed an astro frontmatter or when there is no actual frontmatter
1 parent aa6f837 commit 6946835

9 files changed

Lines changed: 224 additions & 1 deletion

File tree

‎.changeset/fix-astro-fence-in-html-content.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@biomejs/biome": patch
3+
---
4+
5+
Fixed [#9138](https://github.com/biomejs/biome/issues/9138): Astro files containing `---` in HTML content (e.g., `<h1>---Hi</h1>`) are now parsed correctly, both when a frontmatter block is present and when there is no frontmatter at all.

‎crates/biome_html_parser/src/lexer/mod.rs‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,10 @@ pub(crate) struct HtmlLexer<'src> {
3030
preceding_line_break: bool,
3131
after_newline: bool,
3232
unicode_bom_length: usize,
33+
/// Set to `true` after the Astro frontmatter closing fence (`---`) has been
34+
/// consumed. Once set, the `Regular` context will no longer treat `---` as a
35+
/// `FENCE` token, allowing `---` to appear as plain text in HTML content.
36+
after_frontmatter: bool,
3337
}
3438

3539
enum IdentifierContext {
@@ -62,9 +66,16 @@ impl<'src> HtmlLexer<'src> {
6266
after_newline: false,
6367
current_flags: TokenFlags::empty(),
6468
unicode_bom_length: 0,
69+
after_frontmatter: false,
6570
}
6671
}
6772

73+
/// Sets the `after_frontmatter` flag. When `true`, `---` in the `Regular`
74+
/// context is treated as plain HTML text rather than a `FENCE` token.
75+
pub fn set_after_frontmatter(&mut self, value: bool) {
76+
self.after_frontmatter = value;
77+
}
78+
6879
/// Consume a token in the [HtmlLexContext::InsideTag] context.
6980
fn consume_token_inside_tag(&mut self, current: u8) -> HtmlSyntaxKind {
7081
let dispatched = lookup_byte(current);
@@ -265,7 +276,9 @@ impl<'src> HtmlLexer<'src> {
265276
EXL if self.current() == T![<] => self.consume_byte(T![!]),
266277
SLH if self.current() == T![<] => self.consume_byte(T![/]),
267278
COM if self.current() == T![<] => self.consume_byte(T![,]),
268-
MIN if self.at_frontmatter_edge() => self.consume_frontmatter_edge(),
279+
MIN if !self.after_frontmatter && self.at_frontmatter_edge() => {
280+
self.consume_frontmatter_edge()
281+
}
269282
BEO if self.at_svelte_opening_block() => self.consume_svelte_opening_block(),
270283
BEO => {
271284
if self.at_opening_double_text_expression() {
@@ -569,6 +582,7 @@ impl<'src> HtmlLexer<'src> {
569582
MIN => {
570583
debug_assert!(self.at_frontmatter_edge());
571584
self.advance(3);
585+
self.after_frontmatter = true;
572586
T![---]
573587
}
574588
_ => {

‎crates/biome_html_parser/src/parser.rs‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,13 @@ impl<'source> HtmlParser<'source> {
7373
pub fn re_lex(&mut self, context: HtmlReLexContext) -> HtmlSyntaxKind {
7474
self.source_mut().re_lex(context)
7575
}
76+
77+
/// Signals to the lexer that the frontmatter decision has been made.
78+
/// After this call, `---` in the `Regular` context is treated as plain
79+
/// HTML text rather than a `FENCE` token.
80+
pub(crate) fn set_after_frontmatter(&mut self, value: bool) {
81+
self.source.set_after_frontmatter(value);
82+
}
7683
}
7784

7885
pub struct HtmlParserCheckpoint {

‎crates/biome_html_parser/src/syntax/mod.rs‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,14 @@ pub(crate) fn parse_root(p: &mut HtmlParser) {
8787
)
8888
.ok();
8989
}
90+
91+
// Whether or not frontmatter was present, once we're past the frontmatter
92+
// position `---` can no longer start a fence. This prevents `---` in HTML
93+
// content from being incorrectly lexed as a FENCE token.
94+
if p.options().frontmatter {
95+
p.set_after_frontmatter(true);
96+
}
97+
9098
parse_doc_type(p).ok();
9199
ElementList.parse_list(p);
92100

‎crates/biome_html_parser/src/token_source.rs‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -219,6 +219,13 @@ impl<'source> HtmlTokenSource<'source> {
219219
pub fn re_lex(&mut self, mode: HtmlReLexContext) -> HtmlSyntaxKind {
220220
self.lexer.re_lex(mode)
221221
}
222+
223+
/// Signals to the lexer that the frontmatter decision has been made.
224+
/// After this call, `---` in the `Regular` context is treated as plain
225+
/// HTML text rather than a `FENCE` token.
226+
pub fn set_after_frontmatter(&mut self, value: bool) {
227+
self.lexer.lexer_mut().set_after_frontmatter(value);
228+
}
222229
}
223230

224231
impl TokenSource for HtmlTokenSource<'_> {

‎crates/biome_html_parser/tests/html_specs/ok/astro/fence_in_html_no_frontmatter.astro‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<h1>---Hi</h1>

‎crates/biome_html_parser/tests/html_specs/ok/astro/fence_in_html_no_frontmatter.astro.snap‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
source: crates/biome_html_parser/tests/spec_test.rs
3+
assertion_line: 145
4+
expression: snapshot
5+
---
6+
7+
## Input
8+
9+
```astro
10+
<h1>---Hi</h1>
11+
12+
```
13+
14+
15+
## AST
16+
17+
```
18+
HtmlRoot {
19+
bom_token: missing (optional),
20+
frontmatter: missing (optional),
21+
directive: missing (optional),
22+
html: HtmlElementList [
23+
HtmlElement {
24+
opening_element: HtmlOpeningElement {
25+
l_angle_token: L_ANGLE@0..1 "<" [] [],
26+
name: HtmlTagName {
27+
value_token: HTML_LITERAL@1..3 "h1" [] [],
28+
},
29+
attributes: HtmlAttributeList [],
30+
r_angle_token: R_ANGLE@3..4 ">" [] [],
31+
},
32+
children: HtmlElementList [
33+
HtmlContent {
34+
value_token: HTML_LITERAL@4..9 "---Hi" [] [],
35+
},
36+
],
37+
closing_element: HtmlClosingElement {
38+
l_angle_token: L_ANGLE@9..10 "<" [] [],
39+
slash_token: SLASH@10..11 "/" [] [],
40+
name: HtmlTagName {
41+
value_token: HTML_LITERAL@11..13 "h1" [] [],
42+
},
43+
r_angle_token: R_ANGLE@13..14 ">" [] [],
44+
},
45+
},
46+
],
47+
eof_token: EOF@14..15 "" [Newline("\n")] [],
48+
}
49+
```
50+
51+
## CST
52+
53+
```
54+
0: [email protected]
55+
0: (empty)
56+
1: (empty)
57+
2: (empty)
58+
3: [email protected]
59+
0: [email protected]
60+
0: [email protected]
61+
0: [email protected] "<" [] []
62+
1: [email protected]
63+
0: [email protected] "h1" [] []
64+
2: [email protected]
65+
3: [email protected] ">" [] []
66+
1: [email protected]
67+
0: [email protected]
68+
0: [email protected] "---Hi" [] []
69+
2: [email protected]
70+
0: [email protected] "<" [] []
71+
1: [email protected] "/" [] []
72+
2: [email protected]
73+
0: [email protected] "h1" [] []
74+
3: [email protected] ">" [] []
75+
4: [email protected] "" [Newline("\n")] []
76+
77+
```

‎crates/biome_html_parser/tests/html_specs/ok/astro/issue_9138.astro‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
const test = `
3+
4+
---
5+
6+
`
7+
---
8+
9+
<h1>---Hi</h1>

‎crates/biome_html_parser/tests/html_specs/ok/astro/issue_9138.astro.snap‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
---
2+
source: crates/biome_html_parser/tests/spec_test.rs
3+
assertion_line: 145
4+
expression: snapshot
5+
---
6+
7+
## Input
8+
9+
```astro
10+
---
11+
const test = `
12+
13+
---
14+
15+
`
16+
---
17+
18+
<h1>---Hi</h1>
19+
20+
```
21+
22+
23+
## AST
24+
25+
```
26+
HtmlRoot {
27+
bom_token: missing (optional),
28+
frontmatter: AstroFrontmatterElement {
29+
l_fence_token: FENCE@0..3 "---" [] [],
30+
content: AstroEmbeddedContent {
31+
content_token: HTML_LITERAL@3..27 "const test = `\n\n---\n\n`\n" [Newline("\n")] [],
32+
},
33+
r_fence_token: FENCE@27..30 "---" [] [],
34+
},
35+
directive: missing (optional),
36+
html: HtmlElementList [
37+
HtmlElement {
38+
opening_element: HtmlOpeningElement {
39+
l_angle_token: L_ANGLE@30..33 "<" [Newline("\n"), Newline("\n")] [],
40+
name: HtmlTagName {
41+
value_token: HTML_LITERAL@33..35 "h1" [] [],
42+
},
43+
attributes: HtmlAttributeList [],
44+
r_angle_token: R_ANGLE@35..36 ">" [] [],
45+
},
46+
children: HtmlElementList [
47+
HtmlContent {
48+
value_token: HTML_LITERAL@36..41 "---Hi" [] [],
49+
},
50+
],
51+
closing_element: HtmlClosingElement {
52+
l_angle_token: L_ANGLE@41..42 "<" [] [],
53+
slash_token: SLASH@42..43 "/" [] [],
54+
name: HtmlTagName {
55+
value_token: HTML_LITERAL@43..45 "h1" [] [],
56+
},
57+
r_angle_token: R_ANGLE@45..46 ">" [] [],
58+
},
59+
},
60+
],
61+
eof_token: EOF@46..47 "" [Newline("\n")] [],
62+
}
63+
```
64+
65+
## CST
66+
67+
```
68+
0: [email protected]
69+
0: (empty)
70+
1: [email protected]
71+
0: [email protected] "---" [] []
72+
1: [email protected]
73+
0: [email protected] "const test = `\n\n---\n\n`\n" [Newline("\n")] []
74+
2: [email protected] "---" [] []
75+
2: (empty)
76+
3: [email protected]
77+
0: [email protected]
78+
0: [email protected]
79+
0: [email protected] "<" [Newline("\n"), Newline("\n")] []
80+
1: [email protected]
81+
0: [email protected] "h1" [] []
82+
2: [email protected]
83+
3: [email protected] ">" [] []
84+
1: [email protected]
85+
0: [email protected]
86+
0: [email protected] "---Hi" [] []
87+
2: [email protected]
88+
0: [email protected] "<" [] []
89+
1: [email protected] "/" [] []
90+
2: [email protected]
91+
0: [email protected] "h1" [] []
92+
3: [email protected] ">" [] []
93+
4: [email protected] "" [Newline("\n")] []
94+
95+
```

0 commit comments

Comments
 (0)