refactor(formatter): remove all the todo! implementations (#15928)

Remove todo! implementations as they are not used

Author: Dunqing

crates/oxc_formatter/src/formatter/comments.rs

@@ -107,7 +107,7 @@ use oxc_ast::{
 use oxc_span::{GetSpan, Span};
 
 use crate::{
-    Format, FormatResult, SyntaxTriviaPieceComments,
+    Format, FormatResult,
     formatter::{Formatter, SourceText},
 };
 

crates/oxc_formatter/src/formatter/formatter.rs

@@ -6,8 +6,7 @@ use oxc_ast::AstKind;
 use crate::options::FormatOptions;
 
 use super::{
-    Arguments, Buffer, Comments, FormatContext, FormatState, FormatStateSnapshot, GroupId,
-    SourceText, VecBuffer,
+    Arguments, Buffer, Comments, FormatContext, FormatState, GroupId, SourceText, VecBuffer,
     buffer::BufferSnapshot,
     builders::{FillBuilder, JoinBuilder, JoinNodesBuilder, Line},
     prelude::*,
@@ -256,21 +255,6 @@ impl<'buf, 'ast> Formatter<'buf, 'ast> {
     }
 }
 
-impl Formatter<'_, '_> {
-    /// Take a snapshot of the state of the formatter
-    #[inline]
-    pub fn state_snapshot(&self) -> FormatterSnapshot {
-        FormatterSnapshot { buffer: self.buffer.snapshot(), state: self.state().snapshot() }
-    }
-
-    #[inline]
-    /// Restore the state of the formatter to a previous snapshot
-    pub fn restore_state_snapshot(&mut self, snapshot: FormatterSnapshot) {
-        self.state_mut().restore_snapshot(snapshot.state);
-        self.buffer.restore_snapshot(snapshot.buffer);
-    }
-}
-
 impl<'ast> Buffer<'ast> for Formatter<'_, 'ast> {
     #[inline(always)]
     fn write_element(&mut self, element: FormatElement<'ast>) -> FormatResult<()> {
@@ -305,14 +289,3 @@ impl<'ast> Buffer<'ast> for Formatter<'_, 'ast> {
         self.buffer.restore_snapshot(snapshot);
     }
 }
-
-/// Snapshot of the formatter state  used to handle backtracking if
-/// errors are encountered in the formatting process and the formatter
-/// has to fallback to printing raw tokens
-///
-/// In practice this only saves the set of printed tokens in debug
-/// mode and compiled to nothing in release mode
-pub struct FormatterSnapshot {
-    buffer: BufferSnapshot,
-    state: FormatStateSnapshot,
-}

crates/oxc_formatter/src/formatter/mod.rs

@@ -36,7 +36,6 @@ mod state;
 mod syntax_element_key;
 mod syntax_node;
 mod syntax_token;
-mod syntax_trivia_piece_comments;
 mod text_len;
 mod text_range;
 mod text_size;
@@ -63,10 +62,9 @@ pub use self::{
     diagnostics::{ActualStart, FormatError, InvalidDocumentError, PrintError},
     formatter::Formatter,
     source_text::SourceText,
-    state::{FormatState, FormatStateSnapshot},
+    state::FormatState,
     syntax_node::SyntaxNode,
     syntax_token::SyntaxToken,
-    syntax_trivia_piece_comments::SyntaxTriviaPieceComments,
     text_len::TextLen,
     text_range::TextRange,
     text_size::TextSize,
@@ -112,25 +110,14 @@ impl Formatted<'_> {
 
         let printed = Printer::new(print_options).print(&self.document)?;
 
-        // let printed = match self.context.source_map() {
-        // Some(source_map) => source_map.map_printed(printed),
-        // None => printed,
-        // };
-
         Ok(printed)
     }
 
     pub fn print_with_indent(&self, indent: u16) -> PrintResult<Printed> {
-        todo!()
-        // let print_options = self.context.options().as_print_options();
-        // let printed = Printer::new(print_options).print_with_indent(&self.document, indent)?;
-
-        // let printed = match self.context.source_map() {
-        // Some(source_map) => source_map.map_printed(printed),
-        // None => printed,
-        // };
+        let print_options = self.context.options().as_print_options();
+        let printed = Printer::new(print_options).print_with_indent(&self.document, indent)?;
 
-        // Ok(printed)
+        Ok(printed)
     }
 }
 pub type PrintResult<T> = Result<T, PrintError>;

crates/oxc_formatter/src/formatter/state.rs

@@ -16,10 +16,6 @@ pub struct FormatState<'ast> {
     // For the document IR printing process
     /// The interned elements that have been printed to this point
     printed_interned_elements: FxHashMap<Interned<'ast>, usize>,
-    // This is using a RefCell as it only exists in debug mode,
-    // the Formatter is still completely immutable in release builds
-    // #[cfg(debug_assertions)]
-    // pub printed_tokens: PrintedTokens,
 }
 
 impl std::fmt::Debug for FormatState<'_> {
@@ -35,8 +31,6 @@ impl<'ast> FormatState<'ast> {
             context,
             group_id_builder: UniqueGroupIdBuilder::default(),
             printed_interned_elements: FxHashMap::default(),
-            // #[cfg(debug_assertions)]
-            // printed_tokens: Default::default(),
         }
     }
 
@@ -65,81 +59,4 @@ impl<'ast> FormatState<'ast> {
     pub fn printed_interned_elements(&mut self) -> &mut FxHashMap<Interned<'ast>, usize> {
         &mut self.printed_interned_elements
     }
-
-    #[cfg(not(debug_assertions))]
-    #[inline]
-    pub fn track_token(&mut self, span: Span) {}
-
-    /// Tracks the given token as formatted
-    #[cfg(debug_assertions)]
-    #[inline]
-    pub fn track_token(&mut self, span: Span) {
-        // self.printed_tokens.track_token(token);
-    }
-
-    #[cfg(not(debug_assertions))]
-    #[inline]
-    pub fn set_token_tracking_disabled(&mut self, _: bool) {}
-
-    /// Disables or enables token tracking for a portion of the code.
-    ///
-    /// It can be useful to disable the token tracking when it is necessary to re-format a node with different parameters.
-    #[cfg(debug_assertions)]
-    pub fn set_token_tracking_disabled(&mut self, enabled: bool) {
-        todo!()
-        // self.printed_tokens.set_disabled(enabled)
-    }
-
-    #[cfg(not(debug_assertions))]
-    #[inline]
-    pub fn is_token_tracking_disabled(&self) -> bool {
-        false
-    }
-
-    /// Returns `true` if token tracking is currently disabled.
-    #[cfg(debug_assertions)]
-    pub fn is_token_tracking_disabled(&self) -> bool {
-        todo!()
-        // self.printed_tokens.is_disabled()
-    }
-
-    #[cfg(not(debug_assertions))]
-    #[inline]
-    pub fn assert_formatted_all_tokens(&self, _root: &SyntaxNode) {}
-
-    /// Asserts in debug builds that all tokens have been printed.
-    #[cfg(debug_assertions)]
-    #[inline]
-    pub fn assert_formatted_all_tokens(&self, root: &SyntaxNode) {
-        todo!()
-        // self.printed_tokens.assert_all_tracked(root);
-    }
-}
-
-impl FormatState<'_> {
-    pub fn snapshot(&self) -> FormatStateSnapshot {
-        todo!()
-        // FormatStateSnapshot {
-        // #[cfg(debug_assertions)]
-        // printed_tokens: self.printed_tokens.snapshot(),
-        // }
-    }
-
-    pub fn restore_snapshot(&mut self, _snapshot: FormatStateSnapshot) {
-        todo!()
-        // let FormatStateSnapshot {
-        // #[cfg(debug_assertions)]
-        // printed_tokens,
-        // } = snapshot;
-
-        // cfg_if::cfg_if! {
-        // if #[cfg(debug_assertions)] {
-        // self.printed_tokens.restore(printed_tokens);
-        // }
-        // }
-    }
 }
-
-pub struct FormatStateSnapshot;
-// #[cfg(debug_assertions)]
-// printed_tokens: printed_tokens::PrintedTokensSnapshot,

crates/oxc_formatter/src/formatter/syntax_trivia_piece_comments.rs

@@ -3,7 +3,6 @@
     clippy::inline_always,
     clippy::missing_panics_doc,
     clippy::needless_pass_by_ref_mut,
-    clippy::todo,
     clippy::unused_self,
     clippy::enum_variant_names,
     clippy::struct_field_names

crates/oxc_formatter/src/lib.rs

@@ -1,8 +1,6 @@
 use std::{fmt, num::ParseIntError, str::FromStr};
 
-pub use crate::formatter::{
-    Buffer, Format, FormatResult, SyntaxTriviaPieceComments, token::string::Quote,
-};
+pub use crate::formatter::{Buffer, Format, FormatResult, token::string::Quote};
 use crate::{
     formatter::{
         formatter::Formatter,