feat(traverse): introduce TraverseCtx<'a, State>

part of #11742

Author: Boshen

crates/oxc_minifier/src/compressor.rs

@@ -5,6 +5,7 @@ use oxc_traverse::ReusableTraverseCtx;
 
 use crate::{
     CompressOptions,
+    ctx::MinifierState,
     peephole::{
         DeadCodeElimination, LatePeepholeOptimizations, Normalize, NormalizeOptions,
         PeepholeOptimizations,
@@ -27,7 +28,8 @@ impl<'a> Compressor<'a> {
     }
 
     pub fn build_with_scoping(self, scoping: Scoping, program: &mut Program<'a>) {
-        let mut ctx = ReusableTraverseCtx::new(scoping, self.allocator);
+        let state = MinifierState::default();
+        let mut ctx = ReusableTraverseCtx::new(state, scoping, self.allocator);
         let normalize_options =
             NormalizeOptions { convert_while_to_fors: true, convert_const_to_let: true };
         Normalize::new(normalize_options, self.options).build(program, &mut ctx);
@@ -42,7 +44,8 @@ impl<'a> Compressor<'a> {
     }
 
     pub fn dead_code_elimination_with_scoping(self, scoping: Scoping, program: &mut Program<'a>) {
-        let mut ctx = ReusableTraverseCtx::new(scoping, self.allocator);
+        let state = MinifierState::default();
+        let mut ctx = ReusableTraverseCtx::new(state, scoping, self.allocator);
         let normalize_options =
             NormalizeOptions { convert_while_to_fors: false, convert_const_to_let: false };
         Normalize::new(normalize_options, self.options).build(program, &mut ctx);

crates/oxc_minifier/src/ctx.rs

@@ -1,4 +1,4 @@
-use std::ops::Deref;
+use std::{marker::PhantomData, ops::Deref};
 
 use oxc_ast::{AstBuilder, ast::*};
 use oxc_ecmascript::constant_evaluation::{
@@ -7,7 +7,13 @@ use oxc_ecmascript::constant_evaluation::{
 use oxc_ecmascript::side_effects::{MayHaveSideEffects, PropertyReadSideEffects};
 use oxc_semantic::{IsGlobalReference, Scoping};
 use oxc_span::format_atom;
-use oxc_traverse::TraverseCtx;
+
+#[derive(Default)]
+pub struct MinifierState<'a> {
+    data: PhantomData<&'a ()>,
+}
+
+pub type TraverseCtx<'a> = oxc_traverse::TraverseCtx<'a, MinifierState<'a>>;
 
 #[derive(Clone, Copy)]
 pub struct Ctx<'a, 'b>(pub &'b TraverseCtx<'a>);

crates/oxc_minifier/src/peephole/mod.rs

@@ -25,9 +25,12 @@ use oxc_allocator::Vec;
 use oxc_ast::ast::*;
 use oxc_data_structures::stack::NonEmptyStack;
 use oxc_syntax::{es_target::ESTarget, scope::ScopeId};
-use oxc_traverse::{ReusableTraverseCtx, Traverse, TraverseCtx, traverse_mut_with_ctx};
+use oxc_traverse::{ReusableTraverseCtx, Traverse, traverse_mut_with_ctx};
 
-use crate::{ctx::Ctx, options::CompressOptionsKeepNames};
+use crate::{
+    ctx::{Ctx, MinifierState, TraverseCtx},
+    options::CompressOptionsKeepNames,
+};
 
 pub use self::normalize::{Normalize, NormalizeOptions};
 
@@ -64,11 +67,19 @@ impl<'a> PeepholeOptimizations {
         }
     }
 
-    pub fn build(&mut self, program: &mut Program<'a>, ctx: &mut ReusableTraverseCtx<'a>) {
+    pub fn build(
+        &mut self,
+        program: &mut Program<'a>,
+        ctx: &mut ReusableTraverseCtx<'a, MinifierState<'a>>,
+    ) {
         traverse_mut_with_ctx(self, program, ctx);
     }
 
-    pub fn run_in_loop(&mut self, program: &mut Program<'a>, ctx: &mut ReusableTraverseCtx<'a>) {
+    pub fn run_in_loop(
+        &mut self,
+        program: &mut Program<'a>,
+        ctx: &mut ReusableTraverseCtx<'a, MinifierState<'a>>,
+    ) {
         loop {
             self.build(program, ctx);
             if self.functions_changed.is_empty() {
@@ -137,7 +148,7 @@ impl<'a> PeepholeOptimizations {
     }
 }
 
-impl<'a> Traverse<'a> for PeepholeOptimizations {
+impl<'a> Traverse<'a, MinifierState<'a>> for PeepholeOptimizations {
     fn enter_program(&mut self, program: &mut Program<'a>, _ctx: &mut TraverseCtx<'a>) {
         self.enter_program_or_function(program.scope_id());
     }
@@ -391,12 +402,16 @@ impl<'a> LatePeepholeOptimizations {
         Self { target }
     }
 
-    pub fn build(&mut self, program: &mut Program<'a>, ctx: &mut ReusableTraverseCtx<'a>) {
+    pub fn build(
+        &mut self,
+        program: &mut Program<'a>,
+        ctx: &mut ReusableTraverseCtx<'a, MinifierState<'a>>,
+    ) {
         traverse_mut_with_ctx(self, program, ctx);
     }
 }
 
-impl<'a> Traverse<'a> for LatePeepholeOptimizations {
+impl<'a> Traverse<'a, MinifierState<'a>> for LatePeepholeOptimizations {
     fn exit_member_expression(
         &mut self,
         expr: &mut MemberExpression<'a>,
@@ -440,12 +455,16 @@ impl<'a> DeadCodeElimination {
         }
     }
 
-    pub fn build(&mut self, program: &mut Program<'a>, ctx: &mut ReusableTraverseCtx<'a>) {
+    pub fn build(
+        &mut self,
+        program: &mut Program<'a>,
+        ctx: &mut ReusableTraverseCtx<'a, MinifierState<'a>>,
+    ) {
         traverse_mut_with_ctx(self, program, ctx);
     }
 }
 
-impl<'a> Traverse<'a> for DeadCodeElimination {
+impl<'a> Traverse<'a, MinifierState<'a>> for DeadCodeElimination {
     fn exit_statement(&mut self, stmt: &mut Statement<'a>, ctx: &mut TraverseCtx<'a>) {
         let mut state = State::default();
         self.inner.remove_dead_code_exit_statement(stmt, &mut state, Ctx(ctx));

crates/oxc_minifier/src/peephole/normalize.rs

@@ -4,9 +4,12 @@ use oxc_ecmascript::constant_evaluation::{DetermineValueType, ValueType};
 use oxc_semantic::IsGlobalReference;
 use oxc_span::GetSpan;
 use oxc_syntax::scope::ScopeFlags;
-use oxc_traverse::{Ancestor, ReusableTraverseCtx, Traverse, TraverseCtx, traverse_mut_with_ctx};
+use oxc_traverse::{Ancestor, ReusableTraverseCtx, Traverse, traverse_mut_with_ctx};
 
-use crate::{CompressOptions, ctx::Ctx};
+use crate::{
+    CompressOptions,
+    ctx::{Ctx, MinifierState, TraverseCtx},
+};
 
 #[derive(Default)]
 pub struct NormalizeOptions {
@@ -39,12 +42,16 @@ pub struct Normalize {
 }
 
 impl<'a> Normalize {
-    pub fn build(&mut self, program: &mut Program<'a>, ctx: &mut ReusableTraverseCtx<'a>) {
+    pub fn build(
+        &mut self,
+        program: &mut Program<'a>,
+        ctx: &mut ReusableTraverseCtx<'a, MinifierState<'a>>,
+    ) {
         traverse_mut_with_ctx(self, program, ctx);
     }
 }
 
-impl<'a> Traverse<'a> for Normalize {
+impl<'a> Traverse<'a, MinifierState<'a>> for Normalize {
     fn exit_statements(&mut self, stmts: &mut Vec<'a, Statement<'a>>, _ctx: &mut TraverseCtx<'a>) {
         stmts.retain(|stmt| {
             !(matches!(stmt, Statement::EmptyStatement(_))

crates/oxc_transformer/src/common/arrow_function_converter.rs

@@ -101,9 +101,10 @@ use oxc_syntax::{
     scope::{ScopeFlags, ScopeId},
     symbol::SymbolFlags,
 };
-use oxc_traverse::{Ancestor, BoundIdentifier, Traverse, TraverseCtx};
+use oxc_traverse::{Ancestor, BoundIdentifier, Traverse};
 
 use crate::{EnvOptions, utils::ast_builder::wrap_expression_in_arrow_function_iife};
+use crate::{context::TraverseCtx, state::TransformState};
 
 type FxIndexMap<K, V> = IndexMap<K, V, FxBuildHasher>;
 
@@ -172,7 +173,7 @@ impl ArrowFunctionConverter<'_> {
     }
 }
 
-impl<'a> Traverse<'a> for ArrowFunctionConverter<'a> {
+impl<'a> Traverse<'a, TransformState<'a>> for ArrowFunctionConverter<'a> {
     // Note: No visitors for `TSModuleBlock` because `this` is not legal in TS module blocks.
     // <https://www.typescriptlang.org/play/?#code/HYQwtgpgzgDiDGEAEAxA9mpBvAsAKCSXjWCgBckANJAXiQAoBKWgPiTIAsBLKAbnwC++fGDQATAK4AbZACEQAJ2z5CxUhWp0mrdtz6D8QA>
 

crates/oxc_transformer/src/common/computed_key.rs

@@ -2,9 +2,11 @@
 
 use oxc_ast::ast::Expression;
 use oxc_semantic::SymbolFlags;
-use oxc_traverse::TraverseCtx;
 
-use crate::{TransformCtx, utils::ast_builder::create_assignment};
+use crate::{
+    context::{TransformCtx, TraverseCtx},
+    utils::ast_builder::create_assignment,
+};
 
 impl<'a> TransformCtx<'a> {
     /// Check if temp var is required for `key`.

crates/oxc_transformer/src/common/duplicate.rs

@@ -9,9 +9,9 @@ use oxc_allocator::CloneIn;
 use oxc_ast::ast::{AssignmentOperator, Expression};
 use oxc_span::SPAN;
 use oxc_syntax::reference::ReferenceFlags;
-use oxc_traverse::{BoundIdentifier, TraverseCtx};
+use oxc_traverse::BoundIdentifier;
 
-use crate::TransformCtx;
+use crate::context::{TransformCtx, TraverseCtx};
 
 impl<'a> TransformCtx<'a> {
     /// Duplicate expression to be used twice.

crates/oxc_transformer/src/common/helper_loader.rs

@@ -77,9 +77,9 @@ use oxc_ast::{
 };
 use oxc_semantic::{ReferenceFlags, SymbolFlags};
 use oxc_span::{Atom, SPAN, Span};
-use oxc_traverse::{BoundIdentifier, TraverseCtx};
+use oxc_traverse::BoundIdentifier;
 
-use crate::TransformCtx;
+use crate::context::{TransformCtx, TraverseCtx};
 
 /// Defines the mode for loading helper functions.
 #[derive(Default, Clone, Copy, Debug, Deserialize)]

crates/oxc_transformer/src/common/mod.rs

@@ -3,9 +3,13 @@
 use arrow_function_converter::ArrowFunctionConverter;
 use oxc_allocator::Vec as ArenaVec;
 use oxc_ast::ast::*;
-use oxc_traverse::{Traverse, TraverseCtx};
+use oxc_traverse::Traverse;
 
-use crate::{EnvOptions, TransformCtx};
+use crate::{
+    EnvOptions,
+    context::{TransformCtx, TraverseCtx},
+    state::TransformState,
+};
 
 pub mod arrow_function_converter;
 mod computed_key;
@@ -41,7 +45,7 @@ impl<'a, 'ctx> Common<'a, 'ctx> {
     }
 }
 
-impl<'a> Traverse<'a> for Common<'a, '_> {
+impl<'a> Traverse<'a, TransformState<'a>> for Common<'a, '_> {
     fn exit_program(&mut self, program: &mut Program<'a>, ctx: &mut TraverseCtx<'a>) {
         self.module_imports.exit_program(program, ctx);
         self.var_declarations.exit_program(program, ctx);

crates/oxc_transformer/src/common/module_imports.rs

@@ -40,9 +40,12 @@ use oxc_ast::{NONE, ast::*};
 use oxc_semantic::ReferenceFlags;
 use oxc_span::{Atom, SPAN};
 use oxc_syntax::symbol::SymbolId;
-use oxc_traverse::{BoundIdentifier, Traverse, TraverseCtx};
+use oxc_traverse::{BoundIdentifier, Traverse};
 
-use crate::TransformCtx;
+use crate::{
+    context::{TransformCtx, TraverseCtx},
+    state::TransformState,
+};
 
 pub struct ModuleImports<'a, 'ctx> {
     ctx: &'ctx TransformCtx<'a>,
@@ -54,7 +57,7 @@ impl<'a, 'ctx> ModuleImports<'a, 'ctx> {
     }
 }
 
-impl<'a> Traverse<'a> for ModuleImports<'a, '_> {
+impl<'a> Traverse<'a, TransformState<'a>> for ModuleImports<'a, '_> {
     fn exit_program(&mut self, _program: &mut Program<'a>, ctx: &mut TraverseCtx<'a>) {
         self.ctx.module_imports.insert_into_program(self.ctx, ctx);
     }