Skip to content
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

Jump to bottom

feat(linter/tree-shaking): pass CallExpression cases #2839

Merged
merged 1 commit into from
Mar 28, 2024
Merged

feat(linter/tree-shaking): pass CallExpression cases #2839

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
88 changes: 78 additions & 10 deletions crates/oxc_linter/src/rules/tree_shaking/no_side_effects_in_initialization/listener_map.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ use std::cell::RefCell;

use oxc_ast::{
ast::{
Argument, ArrayExpressionElement, AssignmentTarget, CallExpression,
ComputedMemberExpression, Expression, IdentifierReference, MemberExpression,
ModuleDeclaration, PrivateFieldExpression, Program, SimpleAssignmentTarget, Statement,
StaticMemberExpression,
Argument, ArrayExpressionElement, ArrowFunctionExpression, AssignmentTarget,
CallExpression, ComputedMemberExpression, Expression, FormalParameter, Function,
IdentifierReference, MemberExpression, ModuleDeclaration, ParenthesizedExpression,
PrivateFieldExpression, Program, SimpleAssignmentTarget, Statement, StaticMemberExpression,
},
AstKind,
};
Expand Down Expand Up @@ -91,6 +91,17 @@ impl<'a> ListenerMap for AstNode<'a> {
_ => {}
}
}
fn report_effects_when_mutated(&self, options: &NodeListenerOptions) {
#[allow(clippy::single_match)]
match self.kind() {
AstKind::VariableDeclarator(decl) => {
if let Some(init) = &decl.init {
init.report_effects_when_mutated(options);
}
}
_ => {}
}
}
}

impl<'a> ListenerMap for Expression<'a> {
Expand All @@ -106,6 +117,9 @@ impl<'a> ListenerMap for Expression<'a> {
Self::CallExpression(call_expr) => {
call_expr.report_effects(options);
}
Self::ParenthesizedExpression(expr) => {
expr.report_effects(options);
}
Self::ArrowFunctionExpression(_)
| Self::FunctionExpression(_)
| Self::Identifier(_)
Expand All @@ -122,6 +136,12 @@ impl<'a> ListenerMap for Expression<'a> {
ident.report_effects_when_mutated(options);
}
Self::ArrowFunctionExpression(_) | Self::ObjectExpression(_) => no_effects(),
Self::ParenthesizedExpression(expr) => {
expr.report_effects_when_mutated(options);
}
Self::CallExpression(expr) => {
expr.report_effects_when_mutated(options);
}
_ => {
// Default behavior
options.ctx.diagnostic(NoSideEffectsDiagnostic::Mutation(self.span()));
Expand All @@ -136,6 +156,15 @@ impl<'a> ListenerMap for Expression<'a> {
Self::Identifier(expr) => {
expr.report_effects_when_called(options);
}
Self::FunctionExpression(expr) => {
expr.report_effects_when_called(options);
}
Self::ArrowFunctionExpression(expr) => {
expr.report_effects_when_called(options);
}
Self::ParenthesizedExpression(expr) => {
expr.report_effects_when_called(options);
}
_ => {
// Default behavior
options.ctx.diagnostic(NoSideEffectsDiagnostic::Call(self.span()));
Expand All @@ -147,7 +176,7 @@ impl<'a> ListenerMap for Expression<'a> {
// which kind of Expression defines `report_effects_when_called` method.
fn defined_custom_report_effects_when_called(expr: &Expression) -> bool {
matches!(
expr,
expr.get_inner_expression(),
Expression::ArrowFunctionExpression(_)
| Expression::CallExpression(_)
| Expression::ClassExpression(_)
Expand All @@ -158,6 +187,46 @@ fn defined_custom_report_effects_when_called(expr: &Expression) -> bool {
)
}

impl<'a> ListenerMap for ParenthesizedExpression<'a> {
fn report_effects(&self, options: &NodeListenerOptions) {
self.expression.report_effects(options);
}
fn report_effects_when_assigned(&self, options: &NodeListenerOptions) {
self.expression.report_effects_when_assigned(options);
}
fn report_effects_when_called(&self, options: &NodeListenerOptions) {
self.expression.report_effects_when_called(options);
}
fn report_effects_when_mutated(&self, options: &NodeListenerOptions) {
self.expression.report_effects_when_mutated(options);
}
fn get_value_and_report_effects(&self, options: &NodeListenerOptions) -> Option<Value> {
self.expression.get_value_and_report_effects(options)
}
}

impl<'a> ListenerMap for ArrowFunctionExpression<'a> {
fn report_effects_when_called(&self, options: &NodeListenerOptions) {
self.params.items.iter().for_each(|param| param.report_effects(options));
self.body.statements.iter().for_each(|stmt| stmt.report_effects(options));
}
}

impl<'a> ListenerMap for Function<'a> {
fn report_effects_when_called(&self, options: &NodeListenerOptions) {
self.params.items.iter().for_each(|param| param.report_effects(options));
if let Some(body) = &self.body {
body.statements.iter().for_each(|stmt| stmt.report_effects(options));
}
}
}

impl<'a> ListenerMap for FormalParameter<'a> {
fn report_effects(&self, _options: &NodeListenerOptions) {
// TODO: Not work now, need report side effects.
}
}

impl<'a> ListenerMap for CallExpression<'a> {
fn report_effects(&self, options: &NodeListenerOptions) {
self.arguments.iter().for_each(|arg| arg.report_effects(options));
Expand Down Expand Up @@ -274,13 +343,12 @@ impl<'a> ListenerMap for IdentifierReference<'a> {
if let Some(expr) = get_write_expr(node_id, ctx) {
expr.report_effects_when_mutated(options);
}

ctx.diagnostic(NoSideEffectsDiagnostic::MutationWithName(
self.name.to_compact_str(),
self.span,
));
}
}

let symbol_table = ctx.semantic().symbols();
let node = ctx.nodes().get_node(symbol_table.get_declaration(symbol_id));
node.report_effects_when_mutated(options);
}
} else {
ctx.diagnostic(NoSideEffectsDiagnostic::MutationWithName(
Expand Down
10 changes: 5 additions & 5 deletions crates/oxc_linter/src/rules/tree_shaking/no_side_effects_in_initialization/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,8 @@ fn test() {
// // BreakStatement
// "while(true){break}",
// // CallExpression
// "(a=>{const y = a})(ext, ext)",
// "const x = ()=>{}, y = ()=>{}; x(y())",
"(a=>{const y = a})(ext, ext)",
"const x = ()=>{}, y = ()=>{}; x(y())",
// // CatchClause
// "try {} catch (error) {}",
// "const x = ()=>{}; try {} catch (error) {const x = ext}; x()",
Expand Down Expand Up @@ -388,12 +388,12 @@ fn test() {
// "var x=()=>{};{var x=ext}x()",
// "var x=ext;{x(); var x=()=>{}}",
// // CallExpression
// "(()=>{})(ext(), 1)",
// "(()=>{})(1, ext())",
"(()=>{})(ext(), 1)",
"(()=>{})(1, ext())",
// // CallExpression when called
"const x = ()=>ext; const y = x(); y()",
// // CallExpression when mutated
// "const x = ()=>ext; const y = x(); y.z = 1",
"const x = ()=>ext; const y = x(); y.z = 1",
// // CatchClause
// "try {} catch (error) {ext()}",
// "var x=()=>{}; try {} catch (error) {var x=ext}; x()",
Expand Down
18 changes: 18 additions & 0 deletions crates/oxc_linter/src/snapshots/no_side_effects_in_initialization.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,26 @@ expression: no_side_effects_in_initialization
· ───
╰────

⚠ eslint-plugin-tree-shaking(no-side-effects-in-initialization): Cannot determine side-effects of calling global function `ext`
╭─[no_side_effects_in_initialization.tsx:1:10]
1 │ (()=>{})(ext(), 1)
· ───
╰────

⚠ eslint-plugin-tree-shaking(no-side-effects-in-initialization): Cannot determine side-effects of calling global function `ext`
╭─[no_side_effects_in_initialization.tsx:1:13]
1 │ (()=>{})(1, ext())
· ───
╰────

⚠ eslint-plugin-tree-shaking(no-side-effects-in-initialization): Cannot determine side-effects of calling function return value
╭─[no_side_effects_in_initialization.tsx:1:30]
1 │ const x = ()=>ext; const y = x(); y()
· ───
╰────

⚠ eslint-plugin-tree-shaking(no-side-effects-in-initialization): Cannot determine side-effects of mutating function return value
╭─[no_side_effects_in_initialization.tsx:1:30]
1 │ const x = ()=>ext; const y = x(); y.z = 1
· ───
╰────
Loading