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.

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

feat(linter): eslint-plugin-unicorn prefer-reflect-apply(style) #1628

Merged
merged 5 commits into from
Dec 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions crates/oxc_linter/src/rules.rs
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,7 @@ mod unicorn {
pub mod prefer_number_properties;
pub mod prefer_optional_catch_binding;
pub mod prefer_query_selector;
pub mod prefer_reflect_apply;
pub mod prefer_regexp_test;
pub mod prefer_set_size;
pub mod prefer_spread;
Expand Down Expand Up @@ -387,6 +388,7 @@ oxc_macros::declare_all_lint_rules! {
unicorn::prefer_number_properties,
unicorn::prefer_optional_catch_binding,
unicorn::prefer_query_selector,
unicorn::prefer_reflect_apply,
unicorn::prefer_regexp_test,
unicorn::prefer_set_size,
unicorn::prefer_spread,
Expand Down
148 changes: 148 additions & 0 deletions crates/oxc_linter/src/rules/unicorn/prefer_reflect_apply.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,148 @@
use oxc_ast::{
ast::{Argument, Expression, MemberExpression},
AstKind,
};
use oxc_diagnostics::{
miette::{self, Diagnostic},
thiserror::Error,
};
use oxc_macros::declare_oxc_lint;
use oxc_span::Span;

use crate::{context::LintContext, rule::Rule, AstNode};

#[derive(Debug, Error, Diagnostic)]
#[error(
"eslint-plugin-unicorn(prefer-reflect-apply): Prefer Reflect.apply() over Function#apply()"
)]
#[diagnostic(severity(warning), help("Reflect.apply() is less verbose and easier to understand."))]
struct PreferReflectApplyDiagnostic(#[label] pub Span);

#[derive(Debug, Default, Clone)]
pub struct PreferReflectApply;

declare_oxc_lint!(
/// ### What it does
///
///
/// ### Why is this bad?
///
/// Reflect.apply() is arguably less verbose and easier to understand.
/// In addition, when you accept arbitrary methods,
/// it's not safe to assume .apply() exists or is not overridden.
///
/// ### Example
/// ```javascript
/// // Bad
/// foo.apply(null, [42]);
///
/// // Good
/// Reflect.apply(foo, null);
/// ```
PreferReflectApply,
style
);

fn is_apply_signature(argument_1: &Argument, argument_2: &Argument) -> bool {
Ken-HH24 marked this conversation as resolved.
Show resolved Hide resolved
match argument_1 {
Argument::Expression(Expression::ThisExpression(_) | Expression::NullLiteral(_)) => {
matches!(argument_2, Argument::Expression(Expression::ArrayExpression(_)))
|| matches!(argument_2, Argument::Expression(Expression::Identifier(ident)) if ident.name == "arguments")
}
_ => false,
}
}

fn is_static_property_name_equal(expr: &MemberExpression, value: &str) -> bool {
expr.static_property_name().is_some_and(|name| name == value)
}

impl Rule for PreferReflectApply {
fn run<'a>(&self, node: &AstNode<'a>, ctx: &LintContext<'a>) {
let AstKind::CallExpression(call_expr) = node.kind() else {
return;
};

let Expression::MemberExpression(member_expr) = &call_expr.callee else {
return;
};

if call_expr.optional
|| matches!(member_expr.object(), Expression::ArrayExpression(_))
|| matches!(member_expr.object(), Expression::ObjectExpression(_))
|| member_expr.object().is_literal()
{
return;
}

if is_static_property_name_equal(member_expr, "apply")
&& call_expr.arguments.len() == 2
&& is_apply_signature(&call_expr.arguments[0], &call_expr.arguments[1])
{
ctx.diagnostic(PreferReflectApplyDiagnostic(call_expr.span));
return;
}

if is_static_property_name_equal(member_expr, "call") {
Ken-HH24 marked this conversation as resolved.
Show resolved Hide resolved
let Expression::MemberExpression(member_expr_obj) = member_expr.object() else {
return;
};
if is_static_property_name_equal(member_expr_obj, "apply") {
let Expression::MemberExpression(member_expr_obj_obj) = member_expr_obj.object()
else {
return;
};

if is_static_property_name_equal(member_expr_obj_obj, "prototype") {
let Expression::Identifier(iden) = member_expr_obj_obj.object() else {
return;
};
if iden.name == "Function"
&& call_expr.arguments.len() == 3
&& is_apply_signature(&call_expr.arguments[1], &call_expr.arguments[2])
{
ctx.diagnostic(PreferReflectApplyDiagnostic(call_expr.span));
}
}
}
}
}
}

#[test]
fn test() {
use crate::tester::Tester;

let pass = vec![
("foo.apply();", None),
("foo.apply(null);", None),
("foo.apply(this);", None),
("foo.apply(null, 42);", None),
("foo.apply(this, 42);", None),
("foo.apply(bar, arguments);", None),
("[].apply(null, [42]);", None),
("foo.apply(bar);", None),
("foo.apply(bar, []);", None),
("foo.apply;", None),
("apply;", None),
("Reflect.apply(foo, null);", None),
("Reflect.apply(foo, null, [bar]);", None),
("const apply = \"apply\"; foo[apply](null, [42]);", None),
];

let fail = vec![
("foo.apply(null, [42]);", None),
("foo.bar.apply(null, [42]);", None),
("Function.prototype.apply.call(foo, null, [42]);", None),
("Function.prototype.apply.call(foo.bar, null, [42]);", None),
("foo.apply(null, arguments);", None),
("Function.prototype.apply.call(foo, null, arguments);", None),
("foo.apply(this, [42]);", None),
("Function.prototype.apply.call(foo, this, [42]);", None),
("foo.apply(this, arguments);", None),
("Function.prototype.apply.call(foo, this, arguments);", None),
("foo[\"apply\"](null, [42]);", None),
];

Tester::new(PreferReflectApply::NAME, pass, fail).test_and_snapshot();
}
82 changes: 82 additions & 0 deletions crates/oxc_linter/src/snapshots/prefer_reflect_apply.snap
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
source: crates/oxc_linter/src/tester.rs
expression: prefer_reflect_apply
---
⚠ eslint-plugin-unicorn(prefer-reflect-apply): Prefer Reflect.apply() over Function#apply()
╭─[prefer_reflect_apply.tsx:1:1]
1 │ foo.apply(null, [42]);
· ─────────────────────
╰────
help: Reflect.apply() is less verbose and easier to understand.

⚠ eslint-plugin-unicorn(prefer-reflect-apply): Prefer Reflect.apply() over Function#apply()
╭─[prefer_reflect_apply.tsx:1:1]
1 │ foo.bar.apply(null, [42]);
· ─────────────────────────
╰────
help: Reflect.apply() is less verbose and easier to understand.

⚠ eslint-plugin-unicorn(prefer-reflect-apply): Prefer Reflect.apply() over Function#apply()
╭─[prefer_reflect_apply.tsx:1:1]
1 │ Function.prototype.apply.call(foo, null, [42]);
· ──────────────────────────────────────────────
╰────
help: Reflect.apply() is less verbose and easier to understand.

⚠ eslint-plugin-unicorn(prefer-reflect-apply): Prefer Reflect.apply() over Function#apply()
╭─[prefer_reflect_apply.tsx:1:1]
1 │ Function.prototype.apply.call(foo.bar, null, [42]);
· ──────────────────────────────────────────────────
╰────
help: Reflect.apply() is less verbose and easier to understand.

⚠ eslint-plugin-unicorn(prefer-reflect-apply): Prefer Reflect.apply() over Function#apply()
╭─[prefer_reflect_apply.tsx:1:1]
1 │ foo.apply(null, arguments);
· ──────────────────────────
╰────
help: Reflect.apply() is less verbose and easier to understand.

⚠ eslint-plugin-unicorn(prefer-reflect-apply): Prefer Reflect.apply() over Function#apply()
╭─[prefer_reflect_apply.tsx:1:1]
1 │ Function.prototype.apply.call(foo, null, arguments);
· ───────────────────────────────────────────────────
╰────
help: Reflect.apply() is less verbose and easier to understand.

⚠ eslint-plugin-unicorn(prefer-reflect-apply): Prefer Reflect.apply() over Function#apply()
╭─[prefer_reflect_apply.tsx:1:1]
1 │ foo.apply(this, [42]);
· ─────────────────────
╰────
help: Reflect.apply() is less verbose and easier to understand.

⚠ eslint-plugin-unicorn(prefer-reflect-apply): Prefer Reflect.apply() over Function#apply()
╭─[prefer_reflect_apply.tsx:1:1]
1 │ Function.prototype.apply.call(foo, this, [42]);
· ──────────────────────────────────────────────
╰────
help: Reflect.apply() is less verbose and easier to understand.

⚠ eslint-plugin-unicorn(prefer-reflect-apply): Prefer Reflect.apply() over Function#apply()
╭─[prefer_reflect_apply.tsx:1:1]
1 │ foo.apply(this, arguments);
· ──────────────────────────
╰────
help: Reflect.apply() is less verbose and easier to understand.

⚠ eslint-plugin-unicorn(prefer-reflect-apply): Prefer Reflect.apply() over Function#apply()
╭─[prefer_reflect_apply.tsx:1:1]
1 │ Function.prototype.apply.call(foo, this, arguments);
· ───────────────────────────────────────────────────
╰────
help: Reflect.apply() is less verbose and easier to understand.

⚠ eslint-plugin-unicorn(prefer-reflect-apply): Prefer Reflect.apply() over Function#apply()
╭─[prefer_reflect_apply.tsx:1:1]
1 │ foo["apply"](null, [42]);
· ────────────────────────
╰────
help: Reflect.apply() is less verbose and easier to understand.