feat(formatter): remove Tag::StartVerbatim and Tag::EndVerbatim (#15370)

Dunqing · Dunqing · commit 2dfc3bde1a74 · 2025-11-07T01:18:11.000Z
No usage for this. From my understanding, this is used to handle invalid syntax, but our AST always produces a valid AST, so it is useless
diff --git a/crates/oxc_formatter/src/formatter/format_element/document.rs b/crates/oxc_formatter/src/formatter/format_element/document.rs
@@ -169,9 +169,9 @@ impl<'a> Format<'a> for &[FormatElement<'a>] {
     fn fmt(&self, f: &mut Formatter<'_, 'a>) -> FormatResult<()> {
         use Tag::{
             EndAlign, EndConditionalContent, EndDedent, EndEntry, EndFill, EndGroup, EndIndent,
-            EndIndentIfGroupBreaks, EndLabelled, EndLineSuffix, EndVerbatim, StartAlign,
+            EndIndentIfGroupBreaks, EndLabelled, EndLineSuffix, StartAlign,
             StartConditionalContent, StartDedent, StartEntry, StartFill, StartGroup, StartIndent,
-            StartIndentIfGroupBreaks, StartLabelled, StartLineSuffix, StartVerbatim,
+            StartIndentIfGroupBreaks, StartLabelled, StartLineSuffix,
         };
 
         write!(f, [ContentArrayStart])?;
@@ -391,10 +391,6 @@ impl<'a> Format<'a> for &[FormatElement<'a>] {
                             write!(f, [token("line_suffix(")])?;
                         }
 
-                        StartVerbatim(_) => {
-                            write!(f, [token("verbatim(")])?;
-                        }
-
                         StartGroup(group) => {
                             write!(f, [token("group(")])?;
 
@@ -499,8 +495,7 @@ impl<'a> Format<'a> for &[FormatElement<'a>] {
                         | EndIndent
                         | EndGroup
                         | EndLineSuffix
-                        | EndDedent(_)
-                        | EndVerbatim => {
+                        | EndDedent(_) => {
                             write!(f, [ContentArrayEnd, token(")")])?;
                         }
                     }
diff --git a/crates/oxc_formatter/src/formatter/format_element/tag.rs b/crates/oxc_formatter/src/formatter/format_element/tag.rs
@@ -56,10 +56,6 @@ pub enum Tag {
     StartLineSuffix,
     EndLineSuffix,
 
-    /// A token that tracks tokens/nodes that are printed as verbatim.
-    StartVerbatim(VerbatimKind),
-    EndVerbatim,
-
     /// Special semantic element marking the content with a label.
     /// This does not directly influence how the content will be printed.
     ///
@@ -82,7 +78,6 @@ impl Tag {
                 | Tag::StartFill
                 | Tag::StartEntry
                 | Tag::StartLineSuffix
-                | Tag::StartVerbatim(_)
                 | Tag::StartLabelled(_)
         )
     }
@@ -95,9 +90,9 @@ impl Tag {
     pub const fn kind(&self) -> TagKind {
         use Tag::{
             EndAlign, EndConditionalContent, EndDedent, EndEntry, EndFill, EndGroup, EndIndent,
-            EndIndentIfGroupBreaks, EndLabelled, EndLineSuffix, EndVerbatim, StartAlign,
+            EndIndentIfGroupBreaks, EndLabelled, EndLineSuffix, StartAlign,
             StartConditionalContent, StartDedent, StartEntry, StartFill, StartGroup, StartIndent,
-            StartIndentIfGroupBreaks, StartLabelled, StartLineSuffix, StartVerbatim,
+            StartIndentIfGroupBreaks, StartLabelled, StartLineSuffix,
         };
 
         match self {
@@ -110,7 +105,6 @@ impl Tag {
             StartFill | EndFill => TagKind::Fill,
             StartEntry | EndEntry => TagKind::Entry,
             StartLineSuffix | EndLineSuffix => TagKind::LineSuffix,
-            StartVerbatim(_) | EndVerbatim => TagKind::Verbatim,
             StartLabelled(_) | EndLabelled => TagKind::Labelled,
         }
     }
@@ -130,7 +124,6 @@ pub enum TagKind {
     Fill,
     Entry,
     LineSuffix,
-    Verbatim,
     Labelled,
 }
 
@@ -278,21 +271,3 @@ pub trait Label {
     /// Returns the name of the label that is shown in debug builds.
     fn debug_name(&self) -> &'static str;
 }
-
-#[derive(Clone, Copy, Eq, PartialEq, Debug)]
-pub enum VerbatimKind {
-    Bogus,
-    Suppressed,
-    /// This was intentionally skipped, not as a result of suppression.
-    Skipped,
-    Verbatim {
-        /// the length of the formatted node
-        length: TextSize,
-    },
-}
-
-impl VerbatimKind {
-    pub const fn is_bogus(self) -> bool {
-        matches!(self, VerbatimKind::Bogus)
-    }
-}
diff --git a/crates/oxc_formatter/src/formatter/mod.rs b/crates/oxc_formatter/src/formatter/mod.rs
@@ -29,8 +29,6 @@ pub mod formatter;
 pub mod group_id;
 pub mod macros;
 pub mod prelude;
-#[cfg(debug_assertions)]
-pub mod printed_tokens;
 pub mod printer;
 pub mod separated;
 mod source_text;
@@ -44,7 +42,6 @@ mod text_range;
 mod text_size;
 pub mod token;
 pub mod trivia;
-mod verbatim;
 
 use std::{
     fmt::{Debug, Display},
@@ -142,17 +139,16 @@ pub type PrintResult<T> = Result<T, PrintError>;
 pub struct Printed {
     code: String,
     range: Option<TextRange>,
-    verbatim_ranges: Vec<TextRange>,
 }
 
 impl Printed {
-    pub fn new(code: String, range: Option<TextRange>, verbatim_source: Vec<TextRange>) -> Self {
-        Self { code, range, verbatim_ranges: verbatim_source }
+    pub fn new(code: String, range: Option<TextRange>) -> Self {
+        Self { code, range }
     }
 
     /// Construct an empty formatter result
     pub fn new_empty() -> Self {
-        Self { code: String::new(), range: None, verbatim_ranges: Vec::new() }
+        Self { code: String::new(), range: None }
     }
 
     /// Range of the input source file covered by this formatted code,
@@ -170,23 +166,6 @@ impl Printed {
     pub fn into_code(self) -> String {
         self.code
     }
-
-    /// The text in the formatted code that has been formatted as verbatim.
-    pub fn verbatim(&self) -> impl Iterator<Item = (TextRange, &str)> {
-        panic!();
-        std::iter::empty()
-        // self.verbatim_ranges.iter().map(|range| (*range, &self.code[*range]))
-    }
-
-    /// Ranges of the formatted code that have been formatted as verbatim.
-    pub fn verbatim_ranges(&self) -> &[TextRange] {
-        &self.verbatim_ranges
-    }
-
-    /// Takes the ranges of nodes that have been formatted as verbatim, replacing them with an empty list.
-    pub fn take_verbatim_ranges(&mut self) -> Vec<TextRange> {
-        std::mem::take(&mut self.verbatim_ranges)
-    }
 }
 
 // Public return type of the formatter
diff --git a/crates/oxc_formatter/src/formatter/prelude.rs b/crates/oxc_formatter/src/formatter/prelude.rs
@@ -1,7 +1,3 @@
-// pub use super::verbatim::{
-// format_bogus_node, format_or_verbatim, format_suppressed_node, format_verbatim_node,
-// format_verbatim_skipped,
-// };
 pub use super::{Buffer as _, BufferExtensions, Format, Format as _, FormatResult};
 pub use super::{
     builders::*,
diff --git a/crates/oxc_formatter/src/formatter/printed_tokens.rs b/crates/oxc_formatter/src/formatter/printed_tokens.rs
diff --git a/crates/oxc_formatter/src/formatter/printer/mod.rs b/crates/oxc_formatter/src/formatter/printer/mod.rs
@@ -67,7 +67,7 @@ impl<'a> Printer<'a> {
             }
         }
 
-        Ok(Printed::new(self.state.buffer, None, self.state.verbatim_markers))
+        Ok(Printed::new(self.state.buffer, None))
     }
 
     /// Prints a single element and push the following elements to queue
@@ -80,9 +80,9 @@ impl<'a> Printer<'a> {
     ) -> PrintResult<()> {
         use Tag::{
             EndAlign, EndConditionalContent, EndDedent, EndEntry, EndFill, EndGroup, EndIndent,
-            EndIndentIfGroupBreaks, EndLabelled, EndLineSuffix, EndVerbatim, StartAlign,
+            EndIndentIfGroupBreaks, EndLabelled, EndLineSuffix, StartAlign,
             StartConditionalContent, StartDedent, StartEntry, StartFill, StartGroup, StartIndent,
-            StartIndentIfGroupBreaks, StartLabelled, StartLineSuffix, StartVerbatim,
+            StartIndentIfGroupBreaks, StartLabelled, StartLineSuffix,
         };
 
         let args = stack.top();
@@ -236,29 +236,11 @@ impl<'a> Printer<'a> {
                 indent_stack.push_suffix(indent_stack.indention());
                 self.state.line_suffixes.extend(args, queue.iter_content(TagKind::LineSuffix));
             }
-
-            FormatElement::Tag(StartVerbatim(kind)) => {
-                todo!()
-                // if let VerbatimKind::Verbatim { length } = kind {
-                // self.state.verbatim_markers.push(TextRange::at(
-                // TextSize::from(self.state.buffer.len() as u32),
-                // *length,
-                // ));
-                // }
-
-                // stack.push(TagKind::Verbatim, args);
-            }
-
             FormatElement::Tag(tag @ (StartLabelled(_) | StartEntry)) => {
                 stack.push(tag.kind(), args);
             }
             FormatElement::Tag(
-                tag @ (EndLabelled
-                | EndEntry
-                | EndGroup
-                | EndConditionalContent
-                | EndVerbatim
-                | EndFill),
+                tag @ (EndLabelled | EndEntry | EndGroup | EndConditionalContent | EndFill),
             ) => {
                 stack.pop(tag.kind())?;
             }
@@ -696,7 +678,6 @@ struct PrinterState<'a> {
     line_width: usize,
     has_empty_line: bool,
     line_suffixes: LineSuffixes<'a>,
-    verbatim_markers: Vec<TextRange>,
     group_modes: GroupModes,
     // Re-used queue to measure if a group fits. Optimisation to avoid re-allocating a new
     // vec everytime a group gets measured
@@ -938,9 +919,9 @@ impl<'a, 'print> FitsMeasurer<'a, 'print> {
     fn fits_element(&mut self, element: &'a FormatElement) -> PrintResult<Fits> {
         use Tag::{
             EndAlign, EndConditionalContent, EndDedent, EndEntry, EndFill, EndGroup, EndIndent,
-            EndIndentIfGroupBreaks, EndLabelled, EndLineSuffix, EndVerbatim, StartAlign,
+            EndIndentIfGroupBreaks, EndLabelled, EndLineSuffix, StartAlign,
             StartConditionalContent, StartDedent, StartEntry, StartFill, StartGroup, StartIndent,
-            StartIndentIfGroupBreaks, StartLabelled, StartLineSuffix, StartVerbatim,
+            StartIndentIfGroupBreaks, StartLabelled, StartLineSuffix,
         };
 
         let args = self.stack.top();
@@ -1124,18 +1105,11 @@ impl<'a, 'print> FitsMeasurer<'a, 'print> {
                 return invalid_end_tag(TagKind::LineSuffix, self.stack.top_kind());
             }
 
-            FormatElement::Tag(
-                tag @ (StartFill | StartVerbatim(_) | StartLabelled(_) | StartEntry),
-            ) => {
+            FormatElement::Tag(tag @ (StartFill | StartLabelled(_) | StartEntry)) => {
                 self.stack.push(tag.kind(), args);
             }
             FormatElement::Tag(
-                tag @ (EndLabelled
-                | EndEntry
-                | EndGroup
-                | EndConditionalContent
-                | EndVerbatim
-                | EndFill),
+                tag @ (EndLabelled | EndEntry | EndGroup | EndConditionalContent | EndFill),
             ) => {
                 self.stack.pop(tag.kind())?;
             }
diff --git a/crates/oxc_formatter/src/formatter/verbatim.rs b/crates/oxc_formatter/src/formatter/verbatim.rs
