From 9493fbef2c30a378c55e07d4c2e6c6566776bfe0 Mon Sep 17 00:00:00 2001 From: mysteryven <33973865+mysteryven@users.noreply.github.com> Date: Mon, 17 Jun 2024 08:28:49 +0000 Subject: [PATCH] feat(linter): add `oxc/no-optional-chaining` rule (#3700) To support: https://github.com/vuejs/core/pull/10919 --- crates/oxc_linter/src/rules.rs | 2 + .../src/rules/oxc/no_optional_chaining.rs | 111 ++++++++++++++++++ .../src/snapshots/no_optional_chaining.snap | 64 ++++++++++ 3 files changed, 177 insertions(+) create mode 100644 crates/oxc_linter/src/rules/oxc/no_optional_chaining.rs create mode 100644 crates/oxc_linter/src/snapshots/no_optional_chaining.snap diff --git a/crates/oxc_linter/src/rules.rs b/crates/oxc_linter/src/rules.rs index b8843c146362d..1adec6038e6e3 100644 --- a/crates/oxc_linter/src/rules.rs +++ b/crates/oxc_linter/src/rules.rs @@ -360,6 +360,7 @@ mod oxc { pub mod no_async_await; pub mod no_barrel_file; pub mod no_const_enum; + pub mod no_optional_chaining; pub mod no_rest_spread_properties; pub mod number_arg_out_of_range; pub mod only_used_in_recursion; @@ -739,6 +740,7 @@ oxc_macros::declare_all_lint_rules! { oxc::const_comparisons, oxc::double_comparisons, oxc::erasing_op, + oxc::no_optional_chaining, oxc::no_rest_spread_properties, oxc::misrefactored_assign_op, oxc::missing_throw, diff --git a/crates/oxc_linter/src/rules/oxc/no_optional_chaining.rs b/crates/oxc_linter/src/rules/oxc/no_optional_chaining.rs new file mode 100644 index 0000000000000..1061ea8ceacbf --- /dev/null +++ b/crates/oxc_linter/src/rules/oxc/no_optional_chaining.rs @@ -0,0 +1,111 @@ +use oxc_ast::AstKind; +use oxc_diagnostics::OxcDiagnostic; +use oxc_macros::declare_oxc_lint; +use oxc_span::Span; + +use crate::{context::LintContext, rule::Rule, AstNode}; + +fn no_optional_chaining_diagnostic(span0: Span, x1: &str) -> OxcDiagnostic { + if x1.is_empty() { + OxcDiagnostic::warn("oxc(no-optional-chaining): Optional chaining is not allowed.") + .with_labels([span0.into()]) + } else { + OxcDiagnostic::warn("oxc(no-optional-chaining): Optional chaining is not allowed.") + .with_help(x1) + .with_labels([span0.into()]) + } +} + +#[derive(Debug, Default, Clone)] +pub struct NoOptionalChaining(Box); + +#[derive(Debug, Default, Clone)] +pub struct NoOptionalChainingConfig { + message: String, +} + +impl std::ops::Deref for NoOptionalChaining { + type Target = NoOptionalChainingConfig; + + fn deref(&self) -> &Self::Target { + &self.0 + } +} + +declare_oxc_lint!( + /// ### What it does + /// + /// Disallow [optional chaining](https://github.com/tc39/proposal-optional-chaining). + /// + /// ### Example + /// + /// ```javascript + /// const foo = obj?.foo; + /// obj.fn?.(); + /// ``` + /// + /// ### Options + /// + /// ```json + /// { + /// "rules": { + /// "no-optional-chaining": [ + /// "error", + /// { + /// "message": "Our output target is ES2016, and optional chaining results in verbose + /// helpers and should be avoided.", + /// } + /// ] + /// } + /// } + /// ``` + /// + /// - `message`: A custom help message to display when optional chaining is found. + /// + NoOptionalChaining, + restriction, +); + +impl Rule for NoOptionalChaining { + fn from_configuration(value: serde_json::Value) -> Self { + let config = value.get(0); + let message = config + .and_then(|v| v.get("message")) + .and_then(serde_json::Value::as_str) + .unwrap_or_default(); + + Self(Box::new(NoOptionalChainingConfig { message: message.to_string() })) + } + + fn run<'a>(&self, node: &AstNode<'a>, ctx: &LintContext<'a>) { + if let AstKind::ChainExpression(expr) = node.kind() { + ctx.diagnostic(no_optional_chaining_diagnostic(expr.span, &self.message)); + } + } +} + +// Test cases port from: https://github.com/mysticatea/eslint-plugin-es/blob/v4.1.0/tests/lib/rules/no-optional-chaining.js +#[test] +fn test() { + use crate::tester::Tester; + + let pass = vec![("var x = a.b", None), ("var x = a[b]", None), ("foo()", None)]; + + let fail = vec![ + ("var x = a?.b", None), + ("var x = a?.[b]", None), + ("foo?.()", None), + ("var x = ((a?.b)?.c)?.()", None), + ("var x = a/*?.*/?.b", None), + ("var x = '?.'?.['?.']", None), + ("var x = '?.'?.['?.']", None), + ( + "var x = a?.b", + Some(serde_json::json!([{ + "message": "Our output target is ES2016, and optional chaining results in verbose helpers and should be avoided." + }])), + ), + ]; + + Tester::new(NoOptionalChaining::NAME, pass, fail).test_and_snapshot(); +} diff --git a/crates/oxc_linter/src/snapshots/no_optional_chaining.snap b/crates/oxc_linter/src/snapshots/no_optional_chaining.snap new file mode 100644 index 0000000000000..628ef7371b371 --- /dev/null +++ b/crates/oxc_linter/src/snapshots/no_optional_chaining.snap @@ -0,0 +1,64 @@ +--- +source: crates/oxc_linter/src/tester.rs +expression: no_optional_chaining +--- + ⚠ oxc(no-optional-chaining): Optional chaining is not allowed. + ╭─[no_optional_chaining.tsx:1:9] + 1 │ var x = a?.b + · ──── + ╰──── + + ⚠ oxc(no-optional-chaining): Optional chaining is not allowed. + ╭─[no_optional_chaining.tsx:1:9] + 1 │ var x = a?.[b] + · ────── + ╰──── + + ⚠ oxc(no-optional-chaining): Optional chaining is not allowed. + ╭─[no_optional_chaining.tsx:1:1] + 1 │ foo?.() + · ─────── + ╰──── + + ⚠ oxc(no-optional-chaining): Optional chaining is not allowed. + ╭─[no_optional_chaining.tsx:1:9] + 1 │ var x = ((a?.b)?.c)?.() + · ─────────────── + ╰──── + + ⚠ oxc(no-optional-chaining): Optional chaining is not allowed. + ╭─[no_optional_chaining.tsx:1:10] + 1 │ var x = ((a?.b)?.c)?.() + · ───────── + ╰──── + + ⚠ oxc(no-optional-chaining): Optional chaining is not allowed. + ╭─[no_optional_chaining.tsx:1:11] + 1 │ var x = ((a?.b)?.c)?.() + · ──── + ╰──── + + ⚠ oxc(no-optional-chaining): Optional chaining is not allowed. + ╭─[no_optional_chaining.tsx:1:9] + 1 │ var x = a/*?.*/?.b + · ────────── + ╰──── + + ⚠ oxc(no-optional-chaining): Optional chaining is not allowed. + ╭─[no_optional_chaining.tsx:1:9] + 1 │ var x = '?.'?.['?.'] + · ──────────── + ╰──── + + ⚠ oxc(no-optional-chaining): Optional chaining is not allowed. + ╭─[no_optional_chaining.tsx:1:9] + 1 │ var x = '?.'?.['?.'] + · ──────────── + ╰──── + + ⚠ oxc(no-optional-chaining): Optional chaining is not allowed. + ╭─[no_optional_chaining.tsx:1:9] + 1 │ var x = a?.b + · ──── + ╰──── + help: Our output target is ES2016, and optional chaining results in verbose helpers and should be avoided.