feat(oxfmt,formatter): Support embeddedLanguageFormatting option (#15216)

Fixes #13427

I will add tests for this later(another day, another PR), with refactoring all tests...

Author: leaysgur

apps/oxfmt/src/service.rs

@@ -88,22 +88,25 @@ impl FormatService {
             return;
         }
 
-        let embedded_formatter = {
+        let base_formatter = Formatter::new(&allocator, self.format_options.clone());
+        let formatter = if self.format_options.embedded_language_formatting.is_off() {
+            base_formatter
+        } else {
             #[cfg(feature = "napi")]
             {
-                self.external_formatter
+                let external_formatter = self
+                    .external_formatter
                     .as_ref()
-                    .map(crate::prettier_plugins::ExternalFormatter::to_embedded_formatter)
+                    .map(crate::prettier_plugins::ExternalFormatter::to_embedded_formatter);
+                base_formatter.with_embedded_formatter(external_formatter)
             }
             #[cfg(not(feature = "napi"))]
             {
-                None
+                base_formatter
             }
         };
 
-        let code = Formatter::new(&allocator, self.format_options.clone())
-            .with_embedded_formatter(embedded_formatter)
-            .build(&ret.program);
+        let code = formatter.build(&ret.program);
 
         let elapsed = start_time.elapsed();
         let is_changed = source_text != code;

crates/oxc_formatter/src/options.rs

@@ -12,7 +12,6 @@ use crate::{
     write,
 };
 
-// TODO: rename these to align with prettier
 #[derive(Debug, Default, Clone)]
 pub struct FormatOptions {
     /// The indent style.
@@ -63,6 +62,9 @@ pub struct FormatOptions {
     /// - `"end"`: Places the operator at the end of the current line (default).
     pub experimental_operator_position: OperatorPosition,
 
+    /// Enable formatting for embedded languages (e.g., CSS, SQL, GraphQL) within template literals. Defaults to "auto".
+    pub embedded_language_formatting: EmbeddedLanguageFormatting,
+
     // TODO: `FormatOptions`? Split out as `TransformOptions`?
     /// Sort import statements. By default disabled.
     pub experimental_sort_imports: Option<SortImports>,
@@ -86,6 +88,7 @@ impl FormatOptions {
             attribute_position: AttributePosition::default(),
             expand: Expand::default(),
             experimental_operator_position: OperatorPosition::default(),
+            embedded_language_formatting: EmbeddedLanguageFormatting::default(),
             experimental_sort_imports: None,
         }
     }
@@ -112,6 +115,7 @@ impl fmt::Display for FormatOptions {
         writeln!(f, "Attribute Position: {}", self.attribute_position)?;
         writeln!(f, "Expand lists: {}", self.expand)?;
         writeln!(f, "Experimental operator position: {}", self.experimental_operator_position)?;
+        writeln!(f, "Embedded language formatting: {}", self.embedded_language_formatting)?;
         writeln!(f, "Experimental sort imports: {:?}", self.experimental_sort_imports)
     }
 }
@@ -914,6 +918,47 @@ impl fmt::Display for OperatorPosition {
     }
 }
 
+#[derive(Clone, Copy, Debug, Default, Eq, Hash, PartialEq)]
+pub enum EmbeddedLanguageFormatting {
+    /// Enable formatting for embedded languages.
+    #[default]
+    Auto,
+    /// Disable formatting for embedded languages.
+    Off,
+}
+
+impl EmbeddedLanguageFormatting {
+    pub const fn is_auto(self) -> bool {
+        matches!(self, Self::Auto)
+    }
+
+    pub const fn is_off(self) -> bool {
+        matches!(self, Self::Off)
+    }
+}
+
+impl FromStr for EmbeddedLanguageFormatting {
+    type Err = &'static str;
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        match s {
+            "auto" => Ok(Self::Auto),
+            "off" => Ok(Self::Off),
+            _ => Err("Value not supported for EmbeddedLanguageFormatting"),
+        }
+    }
+}
+
+impl fmt::Display for EmbeddedLanguageFormatting {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        let s = match self {
+            EmbeddedLanguageFormatting::Auto => "Auto",
+            EmbeddedLanguageFormatting::Off => "Off",
+        };
+        f.write_str(s)
+    }
+}
+
 // ---
 
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]

crates/oxc_formatter/src/service/oxfmtrc.rs

@@ -4,9 +4,10 @@ use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 
 use crate::{
-    ArrowParentheses, AttributePosition, BracketSameLine, BracketSpacing, Expand, FormatOptions,
-    IndentStyle, IndentWidth, LineEnding, LineWidth, OperatorPosition, QuoteProperties, QuoteStyle,
-    Semicolons, SortImports, SortOrder, TrailingCommas,
+    ArrowParentheses, AttributePosition, BracketSameLine, BracketSpacing,
+    EmbeddedLanguageFormatting, Expand, FormatOptions, IndentStyle, IndentWidth, LineEnding,
+    LineWidth, OperatorPosition, QuoteProperties, QuoteStyle, Semicolons, SortImports, SortOrder,
+    TrailingCommas,
 };
 
 /// Configuration options for the formatter.
@@ -64,6 +65,10 @@ pub struct Oxfmtrc {
     // TODO: Experimental: Use curious ternaries which move `?` after the condition. (Default: false)
     // #[serde(skip_serializing_if = "Option::is_none")]
     // pub experimental_ternaries: Option<bool>,
+    /// Control whether formats quoted code embedded in the file. (Default: "auto")
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub embedded_language_formatting: Option<EmbeddedLanguageFormattingConfig>,
+
     /// Experimental: Sort import statements. Disabled by default.
     #[serde(skip_serializing_if = "Option::is_none")]
     pub experimental_sort_imports: Option<SortImportsConfig>,
@@ -126,6 +131,14 @@ pub enum OperatorPositionConfig {
     End,
 }
 
+#[derive(Debug, Clone, Copy, Default, Deserialize, Serialize, JsonSchema)]
+#[serde(rename_all = "lowercase")]
+pub enum EmbeddedLanguageFormattingConfig {
+    #[default]
+    Auto,
+    Off,
+}
+
 #[derive(Debug, Clone, Default, Deserialize, Serialize, JsonSchema)]
 #[serde(rename_all = "camelCase", default)]
 pub struct SortImportsConfig {
@@ -291,6 +304,13 @@ impl Oxfmtrc {
             };
         }
 
+        if let Some(embedded_language_formatting) = self.embedded_language_formatting {
+            options.embedded_language_formatting = match embedded_language_formatting {
+                EmbeddedLanguageFormattingConfig::Auto => EmbeddedLanguageFormatting::Auto,
+                EmbeddedLanguageFormattingConfig::Off => EmbeddedLanguageFormatting::Off,
+            };
+        }
+
         // Below are our own extensions
 
         if let Some(sort_imports_config) = self.experimental_sort_imports {

crates/oxc_formatter/tests/snapshots/schema_json.snap

@@ -33,6 +33,17 @@ expression: json
         "null"
       ]
     },
+    "embeddedLanguageFormatting": {
+      "description": "Control whether formats quoted code embedded in the file. (Default: \"auto\")",
+      "anyOf": [
+        {
+          "$ref": "#/definitions/EmbeddedLanguageFormattingConfig"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
     "endOfLine": {
       "description": "Which end of line characters to apply. (Default: \"lf\")",
       "anyOf": [
@@ -171,6 +182,13 @@ expression: json
         "avoid"
       ]
     },
+    "EmbeddedLanguageFormattingConfig": {
+      "type": "string",
+      "enum": [
+        "auto",
+        "off"
+      ]
+    },
     "EndOfLineConfig": {
       "type": "string",
       "enum": [

npm/oxfmt/configuration_schema.json

@@ -29,6 +29,17 @@
         "null"
       ]
     },
+    "embeddedLanguageFormatting": {
+      "description": "Control whether formats quoted code embedded in the file. (Default: \"auto\")",
+      "anyOf": [
+        {
+          "$ref": "#/definitions/EmbeddedLanguageFormattingConfig"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
     "endOfLine": {
       "description": "Which end of line characters to apply. (Default: \"lf\")",
       "anyOf": [
@@ -167,6 +178,13 @@
         "avoid"
       ]
     },
+    "EmbeddedLanguageFormattingConfig": {
+      "type": "string",
+      "enum": [
+        "auto",
+        "off"
+      ]
+    },
     "EndOfLineConfig": {
       "type": "string",
       "enum": [
@@ -244,4 +262,4 @@
       ]
     }
   }
-}
+}