Skip to content

feat(react-transform): add removeCall support #2423

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
HuJean merged 1 commit into from
Apr 7, 2026
Merged

feat(react-transform): add removeCall support #2423

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .changeset/feat-react-transform-remove-call.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
"@lynx-js/react": minor
"@lynx-js/react-webpack-plugin": minor
"@lynx-js/react-rsbuild-plugin": minor
---

Add `removeCall` for shake function calls. Its initial default value matches the hooks that were previously in `removeCallParams`, and `removeCallParams` now defaults to empty.

`removeCall` removes matched runtime hook calls entirely, replacing them with `undefined` in expression positions and dropping them in statement positions. `removeCallParams` keeps the existing behavior of preserving the call while stripping its arguments.
164 changes: 145 additions & 19 deletions packages/react/transform/crates/swc_plugin_shake/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
use serde::Deserialize;
use std::collections::HashMap;
use swc_core::{
common::DUMMY_SP,
ecma::ast::*,
ecma::visit::{VisitMut, VisitMutWith, VisitWith},
};
Expand Down Expand Up @@ -63,6 +64,31 @@ pub struct ShakeVisitorConfig {
/// @public
pub retain_prop: Vec<String>,

/// Function names whose calls should be replaced with `undefined` during transformation
///
/// @example
/// ```js
/// import { defineConfig } from '@lynx-js/rspeedy'
/// import { pluginReactLynx } from '@lynx-js/react-rsbuild-plugin'
///
/// export default defineConfig({
/// plugins: [
/// pluginReactLynx({
/// shake: {
/// removeCall: ['useMyCustomEffect']
/// }
/// })
/// ]
/// })
/// ```
///
/// @remarks
/// Default value: `['useEffect', 'useLayoutEffect', '__runInJS', 'useLynxGlobalEventListener', 'useImperativeHandle']`
/// The provided values will be merged with the default values instead of replacing them.
///
Comment thread
HuJean marked this conversation as resolved.
/// @public
pub remove_call: Vec<String>,

/// Function names whose parameters should be removed during transformation
///
/// @example
Expand All @@ -82,7 +108,7 @@ pub struct ShakeVisitorConfig {
/// ```
///
/// @remarks
/// Default value: `['useEffect', 'useLayoutEffect', '__runInJS', 'useLynxGlobalEventListener', 'useImperativeHandle']`
/// Default value: `[]`
/// The provided values will be merged with the default values instead of replacing them.
///
/// @public
Expand All @@ -102,7 +128,7 @@ impl Default for ShakeVisitorConfig {
"contextType",
"defaultProps",
];
let default_remove_call_params = [
let default_remove_call = [
"useEffect",
"useLayoutEffect",
"__runInJS",
Expand All @@ -112,10 +138,8 @@ impl Default for ShakeVisitorConfig {
ShakeVisitorConfig {
pkg_name: default_pkg_name.iter().map(|x| x.to_string()).collect(),
retain_prop: default_retain_prop.iter().map(|x| x.to_string()).collect(),
remove_call_params: default_remove_call_params
.iter()
.map(|x| x.to_string())
.collect(),
remove_call: default_remove_call.iter().map(|x| x.to_string()).collect(),
remove_call_params: Vec::new(),
}
}
}
Expand All @@ -138,6 +162,19 @@ impl ShakeVisitor {
import_ids: Vec::new(),
}
}

/// Returns true when the call targets a configured runtime import.
///
/// This shared check is used by both:
/// - `remove_call`, where the whole call expression is removed/replaced
/// - `remove_call_params`, where only the call arguments are cleared
fn should_remove_call(&self, n: &CallExpr, target_calls: &[String]) -> bool {
if let Some(fn_name) = n.callee.as_expr().and_then(|s| s.as_ident()) {
self.import_ids.contains(&fn_name.to_id()) && target_calls.contains(&fn_name.sym.to_string())
Comment thread
upupming marked this conversation as resolved.
} else {
false
}
}
}

impl Default for ShakeVisitor {
Expand All @@ -147,6 +184,28 @@ impl Default for ShakeVisitor {
}

impl VisitMut for ShakeVisitor {
fn visit_mut_stmt(&mut self, n: &mut Stmt) {
if let Stmt::Expr(expr_stmt) = n {
if let Expr::Call(call_expr) = &*expr_stmt.expr {
if self.should_remove_call(call_expr, &self.opts.remove_call) {
*n = Stmt::Empty(EmptyStmt { span: DUMMY_SP });
return;
}
}
}
n.visit_mut_children_with(self);
}

fn visit_mut_expr(&mut self, n: &mut Expr) {
if let Expr::Call(call_expr) = n {
if self.should_remove_call(call_expr, &self.opts.remove_call) {
*n = Expr::Ident(Ident::new("undefined".into(), DUMMY_SP, Default::default()));
return;
Comment thread
HuJean marked this conversation as resolved.
}
}
n.visit_mut_children_with(self);
}

/**
* labeling import stmt
*/
Expand Down Expand Up @@ -176,15 +235,8 @@ impl VisitMut for ShakeVisitor {
* labeling function call
*/
fn visit_mut_call_expr(&mut self, n: &mut CallExpr) {
if let Some(fn_name) = n.callee.as_expr().and_then(|s| s.as_ident()) {
if self.import_ids.contains(&fn_name.to_id())
&& self
.opts
.remove_call_params
.contains(&fn_name.sym.to_string())
{
n.args.clear();
}
if self.should_remove_call(n, &self.opts.remove_call_params) {
n.args.clear();
}
n.visit_mut_children_with(self);
}
Expand Down Expand Up @@ -302,7 +354,7 @@ mod tests {
ecma::{transforms::base::resolver, visit::visit_mut_pass},
};

use crate::ShakeVisitor;
use crate::{ShakeVisitor, ShakeVisitorConfig};

test!(
module,
Expand All @@ -322,6 +374,68 @@ mod tests {
"#
);

test!(
Syntax::Es(EsSyntax {
jsx: true,
..Default::default()
}),
|_| (
resolver(Mark::new(), Mark::new(), true),
visit_mut_pass(ShakeVisitor::new(Default::default())),
),
should_remove_use_effect_call,
r#"
import { useEffect } from "@lynx-js/react-runtime";
const myUseEffect = useEffect;
export function A () {
useEffect(()=>{
console.log("remove useEffect")
})
myUseEffect(()=>{
console.log("remove myUseEffect")
})
}
"#
);

test!(
module,
Syntax::Es(EsSyntax {
jsx: true,
..Default::default()
}),
|_| (
resolver(Mark::new(), Mark::new(), true),
visit_mut_pass(ShakeVisitor::new(Default::default())),
),
should_not_remove_call_in_scope_id,
r#"
import { useEffect } from '@lynx-js/react-runtime'
{
const useEffect = () => {};
useEffect(() => {});
}
useEffect(() => {});
"#
);

test!(
module,
Syntax::Es(EsSyntax {
jsx: true,
..Default::default()
}),
|_| (
resolver(Mark::new(), Mark::new(), true),
visit_mut_pass(ShakeVisitor::new(Default::default())),
),
should_replace_use_effect_call_with_undefined,
r#"
import { useEffect } from '@lynx-js/react-runtime'
const a = useEffect(() => {});
"#
);

test!(
module,
Syntax::Es(EsSyntax {
Expand Down Expand Up @@ -484,13 +598,21 @@ mod tests {

test!(
Default::default(),
|_| visit_mut_pass(ShakeVisitor::default()),
|_| visit_mut_pass(ShakeVisitor::new(ShakeVisitorConfig {
remove_call: Vec::new(),
remove_call_params: vec!["useEffect".to_string()],
..Default::default()
})),
should_remove_use_effect_param,
r#"
import { useEffect } from "@lynx-js/react-runtime";
const myUseEffect = useEffect;
export function A () {
useEffect(()=>{
console.log("remove")
console.log("remove useEffect")
})
myUseEffect(()=>{
console.log("remove myUseEffect")
})
}
"#
Expand All @@ -504,7 +626,11 @@ mod tests {
}),
|_| (
resolver(Mark::new(), Mark::new(), true),
visit_mut_pass(ShakeVisitor::new(Default::default())),
visit_mut_pass(ShakeVisitor::new(ShakeVisitorConfig {
remove_call_params: vec!["useEffect".to_string()],
remove_call: Vec::new(),
..Default::default()
})),
),
should_not_remove_in_scope_id,
r#"
Expand Down
45 changes: 39 additions & 6 deletions packages/react/transform/crates/swc_plugin_shake/napi.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,31 @@ pub struct ShakeVisitorConfig {
/// @public
pub retain_prop: Vec<String>,

/// Function names whose calls should be replaced with `undefined` during transformation
///
/// @example
/// ```js
/// import { defineConfig } from '@lynx-js/rspeedy'
/// import { pluginReactLynx } from '@lynx-js/react-rsbuild-plugin'
///
/// export default defineConfig({
/// plugins: [
/// pluginReactLynx({
/// shake: {
/// removeCall: ['useMyCustomEffect']
/// }
/// })
/// ]
/// })
/// ```
///
/// @remarks
/// Default value: `['useEffect', 'useLayoutEffect', '__runInJS', 'useLynxGlobalEventListener', 'useImperativeHandle']`
/// The provided values will be merged with the default values instead of replacing them.
///
/// @public
pub remove_call: Vec<String>,

/// Function names whose parameters should be removed during transformation
///
/// @example
Expand All @@ -76,7 +101,7 @@ pub struct ShakeVisitorConfig {
/// ```
///
/// @remarks
/// Default value: `['useEffect', 'useLayoutEffect', '__runInJS', 'useLynxGlobalEventListener', 'useImperativeHandle']`
/// Default value: `[]`
/// The provided values will be merged with the default values instead of replacing them.
///
/// @public
Expand All @@ -96,7 +121,7 @@ impl Default for ShakeVisitorConfig {
"contextType",
"defaultProps",
];
let default_remove_call_params = [
let default_remove_call = [
"useEffect",
"useLayoutEffect",
"__runInJS",
Expand All @@ -106,10 +131,8 @@ impl Default for ShakeVisitorConfig {
ShakeVisitorConfig {
pkg_name: default_pkg_name.iter().map(|x| x.to_string()).collect(),
retain_prop: default_retain_prop.iter().map(|x| x.to_string()).collect(),
remove_call_params: default_remove_call_params
.iter()
.map(|x| x.to_string())
.collect(),
remove_call: default_remove_call.iter().map(|x| x.to_string()).collect(),
remove_call_params: Vec::new(),
}
}
}
Expand All @@ -119,6 +142,7 @@ impl From<ShakeVisitorConfig> for CoreConfig {
CoreConfig {
pkg_name: val.pkg_name,
retain_prop: val.retain_prop,
remove_call: val.remove_call,
remove_call_params: val.remove_call_params,
}
}
Expand All @@ -129,6 +153,7 @@ impl From<CoreConfig> for ShakeVisitorConfig {
ShakeVisitorConfig {
pkg_name: val.pkg_name,
retain_prop: val.retain_prop,
remove_call: val.remove_call,
remove_call_params: val.remove_call_params,
}
}
Expand All @@ -152,6 +177,14 @@ impl Default for ShakeVisitor {
}

impl VisitMut for ShakeVisitor {
fn visit_mut_stmt(&mut self, n: &mut Stmt) {
self.inner.visit_mut_stmt(n);
}

fn visit_mut_expr(&mut self, n: &mut Expr) {
self.inner.visit_mut_expr(n);
}

fn visit_mut_import_decl(&mut self, n: &mut ImportDecl) {
self.inner.visit_mut_import_decl(n);
}
Expand Down
5 changes: 5 additions & 0 deletions ...tes/swc_plugin_shake/tests/__swc_snapshots__/lib.rs/should_not_remove_call_in_scope_id.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import { useEffect } from '@lynx-js/react-runtime';
{
const useEffect = ()=>{};
useEffect(()=>{});
};
8 changes: 8 additions & 0 deletions ...m/crates/swc_plugin_shake/tests/__swc_snapshots__/lib.rs/should_remove_use_effect_call.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import { useEffect } from "@lynx-js/react-runtime";
const myUseEffect = useEffect;
export function A() {
;
myUseEffect(()=>{
console.log("remove myUseEffect");
});
}
4 changes: 4 additions & 0 deletions .../crates/swc_plugin_shake/tests/__swc_snapshots__/lib.rs/should_remove_use_effect_param.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
import { useEffect } from "@lynx-js/react-runtime";
const myUseEffect = useEffect;
export function A() {
useEffect();
myUseEffect(()=>{
console.log("remove myUseEffect");
});
}
2 changes: 2 additions & 0 deletions ...gin_shake/tests/__swc_snapshots__/lib.rs/should_replace_use_effect_call_with_undefined.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
import { useEffect } from '@lynx-js/react-runtime';
const a = undefined;
Loading
Loading