feat(format/html): normalize casing for directive (#5266)

biomejs · Mar 5, 2025 · e26c1c3 · e26c1c3
1 parent c3ceca4
commit e26c1c3
Show file tree

Hide file tree

Showing 14 changed files with 109 additions and 166 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/crates/biome_html_formatter/Cargo.toml b/crates/biome_html_formatter/Cargo.toml
@@ -16,6 +16,7 @@ biome_diagnostics_categories = { workspace = true }
 biome_formatter              = { workspace = true }
 biome_html_syntax            = { workspace = true }
 biome_rowan                  = { workspace = true }
+biome_string_case            = { workspace = true }
 biome_suppression            = { workspace = true }
 schemars                     = { workspace = true, optional = true }
 serde                        = { workspace = true, optional = true }

diff --git a/crates/biome_html_formatter/src/html/auxiliary/directive.rs b/crates/biome_html_formatter/src/html/auxiliary/directive.rs
@@ -1,4 +1,4 @@
-use crate::prelude::*;
+use crate::{prelude::*, utils::formatters::FormatTokenAsLowercase};
 use biome_formatter::write;
 use biome_html_syntax::{HtmlDirective, HtmlDirectiveFields};
 #[derive(Debug, Clone, Default)]
@@ -25,8 +25,7 @@ impl FormatNodeRule<HtmlDirective> for FormatHtmlDirective {
             ]
         )?;
         if let Some(html) = html_token {
-            write!(f, [space()])?;
-            html.format().fmt(f)?;
+            write!(f, [space(), FormatTokenAsLowercase::from(html)])?;
         }
         if let Some(quirk) = quirk_token {
             write!(f, [space()])?;

diff --git a/crates/biome_html_formatter/src/utils/formatters.rs b/crates/biome_html_formatter/src/utils/formatters.rs
@@ -0,0 +1,37 @@
+use std::borrow::Cow;
+
+use crate::prelude::*;
+use biome_formatter::write;
+use biome_formatter::{Format, FormatResult};
+use biome_html_syntax::HtmlLanguage;
+use biome_rowan::{Language, SyntaxToken};
+use biome_string_case::StrLikeExtension;
+
+use crate::{HtmlFormatter, context::HtmlFormatContext};
+
+// TODO: deduplicate with CSS formatter's version of this, move to `biome_formatter`.
+pub(crate) struct FormatTokenAsLowercase<L: Language> {
+    token: SyntaxToken<L>,
+}
+
+impl<L: Language> From<SyntaxToken<L>> for FormatTokenAsLowercase<L> {
+    fn from(value: SyntaxToken<L>) -> Self {
+        Self { token: value }
+    }
+}
+
+impl Format<HtmlFormatContext> for FormatTokenAsLowercase<HtmlLanguage> {
+    fn fmt(&self, f: &mut HtmlFormatter) -> FormatResult<()> {
+        let original = self.token.text_trimmed();
+        match original.to_ascii_lowercase_cow() {
+            Cow::Borrowed(_) => write!(f, [self.token.format()]),
+            Cow::Owned(lowercase) => write!(
+                f,
+                [format_replaced(
+                    &self.token,
+                    &dynamic_text(&lowercase, self.token.text_trimmed_range().start()),
+                )]
+            ),
+        }
+    }
+}
diff --git a/crates/biome_html_formatter/src/utils/mod.rs b/crates/biome_html_formatter/src/utils/mod.rs
@@ -1,2 +1,3 @@
 pub mod children;
+pub mod formatters;
 pub mod metadata;
diff --git a/crates/biome_html_formatter/tests/specs/html/directive/lowercase.html b/crates/biome_html_formatter/tests/specs/html/directive/lowercase.html
@@ -0,0 +1 @@
+<!doctype html>
diff --git a/crates/biome_html_formatter/tests/specs/html/directive/lowercase.html.snap b/crates/biome_html_formatter/tests/specs/html/directive/lowercase.html.snap
@@ -0,0 +1,32 @@
+---
+source: crates/biome_formatter_test/src/snapshot_builder.rs
+info: directive/lowercase.html
+---
+# Input
+
+```html
+<!doctype html>
+
+```
+
+
+=============================
+
+# Outputs
+
+## Output 1
+
+-----
+Indent style: Tab
+Indent width: 2
+Line ending: LF
+Line width: 80
+Attribute Position: Auto
+Bracket same line: false
+Whitespace sensitivity: css
+Indent script and style: false
+-----
+
+```html
+<!doctype html>
+```
diff --git a/...l_formatter/tests/specs/html/example.html → ...tests/specs/html/directive/uppercase.html b/...l_formatter/tests/specs/html/example.html → ...tests/specs/html/directive/uppercase.html
diff --git a/...matter/tests/specs/html/example.html.snap → .../specs/html/directive/uppercase.html.snap b/...matter/tests/specs/html/example.html.snap → .../specs/html/directive/uppercase.html.snap
@@ -1,6 +1,6 @@
 ---
 source: crates/biome_formatter_test/src/snapshot_builder.rs
-info: example.html
+info: directive/uppercase.html
 ---
 # Input
 

diff --git a/crates/biome_html_formatter/tests/specs/html/directive/uppercase2.html b/crates/biome_html_formatter/tests/specs/html/directive/uppercase2.html
@@ -0,0 +1 @@
+<!DOCTYPE HTML>
diff --git a/crates/biome_html_formatter/tests/specs/html/directive/uppercase2.html.snap b/crates/biome_html_formatter/tests/specs/html/directive/uppercase2.html.snap
@@ -0,0 +1,32 @@
+---
+source: crates/biome_formatter_test/src/snapshot_builder.rs
+info: directive/uppercase2.html
+---
+# Input
+
+```html
+<!DOCTYPE HTML>
+
+```
+
+
+=============================
+
+# Outputs
+
+## Output 1
+
+-----
+Indent style: Tab
+Indent width: 2
+Line ending: LF
+Line width: 80
+Attribute Position: Auto
+Bracket same line: false
+Whitespace sensitivity: css
+Indent script and style: false
+-----
+
+```html
+<!DOCTYPE html>
+```
diff --git a/...html_formatter/tests/specs/prettier/html/doctype_declarations/html4.01_frameset.html.snap b/...html_formatter/tests/specs/prettier/html/doctype_declarations/html4.01_frameset.html.snap
diff --git a/...e_html_formatter/tests/specs/prettier/html/doctype_declarations/html4.01_strict.html.snap b/...e_html_formatter/tests/specs/prettier/html/doctype_declarations/html4.01_strict.html.snap
diff --git a/..._formatter/tests/specs/prettier/html/doctype_declarations/html4.01_transitional.html.snap b/..._formatter/tests/specs/prettier/html/doctype_declarations/html4.01_transitional.html.snap