|
| 1 | +use biome_analyze::{ |
| 2 | + context::RuleContext, declare_lint_rule, Ast, Rule, RuleDiagnostic, RuleDomain, RuleSource, |
| 3 | + RuleSourceKind, |
| 4 | +}; |
| 5 | +use biome_console::markup; |
| 6 | +use biome_js_syntax::{AnyJsExpression, JsCallExpression}; |
| 7 | +use biome_rowan::{AstNode, AstSeparatedList, TextRange}; |
| 8 | + |
| 9 | +declare_lint_rule! { |
| 10 | + /// Disallow usage of dependency arrays in `createEffect` and `createMemo`. |
| 11 | + /// |
| 12 | + /// In Solid, `createEffect` and `createMemo` track dependencies automatically, it's no need to add dependency arrays. |
| 13 | + /// |
| 14 | + /// ## Examples |
| 15 | + /// |
| 16 | + /// ### Invalid |
| 17 | + /// |
| 18 | + /// ```js,expect_diagnostic |
| 19 | + /// import { createEffect } from "solid-js"; |
| 20 | + /// createEffect(() => { |
| 21 | + /// console.log(signal()); |
| 22 | + /// }, [signal()]); |
| 23 | + /// ``` |
| 24 | + /// |
| 25 | + /// ```js,expect_diagnostic |
| 26 | + /// import { createEffect } from "solid-js"; |
| 27 | + /// createEffect(() => { |
| 28 | + /// console.log(signal()); |
| 29 | + /// }, [signal]); |
| 30 | + /// ``` |
| 31 | + /// |
| 32 | + /// ```js,expect_diagnostic |
| 33 | + /// import { createEffect } from "solid-js"; |
| 34 | + /// const deps = [signal]; |
| 35 | + /// createEffect(() => { |
| 36 | + /// console.log(signal()); |
| 37 | + /// }, deps) |
| 38 | + /// ``` |
| 39 | + /// |
| 40 | + /// ```js,expect_diagnostic |
| 41 | + /// import { createMemo } from "solid-js"; |
| 42 | + /// const value = createMemo(() => computeExpensiveValue(a(), b()), [a(), b()]); |
| 43 | + /// ``` |
| 44 | + /// |
| 45 | + /// ```js,expect_diagnostic |
| 46 | + /// import { createMemo } from "solid-js"; |
| 47 | + /// const value = createMemo(() => computeExpensiveValue(a(), b()), [a, b]); |
| 48 | + /// ``` |
| 49 | + /// |
| 50 | + /// ```js,expect_diagnostic |
| 51 | + /// import { createMemo } from "solid-js"; |
| 52 | + /// const value = createMemo(() => computeExpensiveValue(a(), b()), [a, b()]); |
| 53 | + /// ``` |
| 54 | + /// |
| 55 | + /// ```js,expect_diagnostic |
| 56 | + /// import { createMemo } from "solid-js"; |
| 57 | + /// const deps = [a, b]; |
| 58 | + /// const value = createMemo(() => computeExpensiveValue(a(), b()), deps); |
| 59 | + /// ``` |
| 60 | + /// |
| 61 | + /// ```js,expect_diagnostic |
| 62 | + /// import { createMemo } from "solid-js"; |
| 63 | + /// const deps = [a, b]; |
| 64 | + /// const memoFn = () => computeExpensiveValue(a(), b()); |
| 65 | + /// const value = createMemo(memoFn, deps); |
| 66 | + /// ``` |
| 67 | + /// |
| 68 | + /// ### Valid |
| 69 | + /// |
| 70 | + /// ```js |
| 71 | + /// import { createEffect } from "solid-js"; |
| 72 | + /// createEffect(() => { |
| 73 | + /// console.log(signal()); |
| 74 | + /// }); |
| 75 | + /// ``` |
| 76 | + /// |
| 77 | + /// ```js |
| 78 | + /// import { createEffect } from "solid-js"; |
| 79 | + /// createEffect((prev) => { |
| 80 | + /// console.log(signal()); |
| 81 | + /// return prev + 1; |
| 82 | + /// }, 0); |
| 83 | + /// ``` |
| 84 | + /// |
| 85 | + /// ```js |
| 86 | + /// import { createEffect } from "solid-js"; |
| 87 | + /// createEffect((prev) => { |
| 88 | + /// console.log(signal()); |
| 89 | + /// return (prev || 0) + 1; |
| 90 | + /// }); |
| 91 | + /// ``` |
| 92 | + /// |
| 93 | + /// ```js |
| 94 | + /// import { createEffect } from "solid-js"; |
| 95 | + /// createEffect((prev) => { |
| 96 | + /// console.log(signal()); |
| 97 | + /// return prev ? prev + 1 : 1; |
| 98 | + /// }, undefined); |
| 99 | + /// ``` |
| 100 | + /// |
| 101 | + /// ```js |
| 102 | + /// import { createMemo } from "solid-js"; |
| 103 | + /// const value = createMemo(() => computeExpensiveValue(a(), b())); |
| 104 | + /// ``` |
| 105 | + /// |
| 106 | + /// ```js |
| 107 | + /// import { createMemo } from "solid-js"; |
| 108 | + /// const sum = createMemo((prev) => input() + prev, 0); |
| 109 | + /// ``` |
| 110 | + /// |
| 111 | + /// ```js |
| 112 | + /// import { createEffect } from "solid-js"; |
| 113 | + /// const args = [ |
| 114 | + /// () => { |
| 115 | + /// console.log(signal()); |
| 116 | + /// }, |
| 117 | + /// [signal()], |
| 118 | + /// ]; |
| 119 | + /// createEffect(...args); |
| 120 | + /// ``` |
| 121 | + pub NoReactDeps { |
| 122 | + version: "next", |
| 123 | + name: "noReactDeps", |
| 124 | + language: "js", |
| 125 | + domains: &[RuleDomain::Solid], |
| 126 | + recommended: false, |
| 127 | + sources: &[RuleSource::EslintSolid("no-react-deps")], |
| 128 | + source_kind: RuleSourceKind::Inspired, |
| 129 | + } |
| 130 | +} |
| 131 | + |
| 132 | +impl Rule for NoReactDeps { |
| 133 | + type Query = Ast<JsCallExpression>; |
| 134 | + type State = (String, TextRange); |
| 135 | + type Signals = Option<Self::State>; |
| 136 | + type Options = (); |
| 137 | + |
| 138 | + fn run(ctx: &RuleContext<Self>) -> Self::Signals { |
| 139 | + let node = ctx.query(); |
| 140 | + let callee = node.callee().ok()?; |
| 141 | + let ident = callee.as_js_identifier_expression()?.name().ok()?; |
| 142 | + let callee_name = ident.value_token().ok()?; |
| 143 | + let callee_name = callee_name.text_trimmed(); |
| 144 | + |
| 145 | + if callee_name != "createEffect" && callee_name != "createMemo" { |
| 146 | + return None; |
| 147 | + } |
| 148 | + |
| 149 | + let arguments = node.arguments().ok()?.args(); |
| 150 | + let len = arguments.len(); |
| 151 | + let mut iter = arguments.into_iter(); |
| 152 | + |
| 153 | + let has_spread = iter.all(|arg| arg.is_ok_and(|arg| arg.as_js_spread().is_some())); |
| 154 | + |
| 155 | + if len == 2 && !has_spread { |
| 156 | + let first_argument = iter.next()?.ok()?; |
| 157 | + let first_argument = first_argument.as_any_js_expression()?; |
| 158 | + |
| 159 | + let is_first_arg_function_type = |
| 160 | + first_argument.as_js_arrow_function_expression().is_some() |
| 161 | + || first_argument.as_js_function_expression().is_some(); |
| 162 | + |
| 163 | + let first_arg_parameter_len = match first_argument { |
| 164 | + AnyJsExpression::JsArrowFunctionExpression(node) => node.parameters().ok()?.len(), |
| 165 | + AnyJsExpression::JsFunctionExpression(node) => { |
| 166 | + node.parameters().ok()?.items().len() |
| 167 | + } |
| 168 | + _ => 0, |
| 169 | + }; |
| 170 | + |
| 171 | + let second_argument = iter.next()?.ok()?; |
| 172 | + let second_argument = second_argument.as_any_js_expression()?; |
| 173 | + let is_second_arg_array_type = second_argument.as_js_array_expression().is_some(); |
| 174 | + |
| 175 | + if is_first_arg_function_type |
| 176 | + && first_arg_parameter_len == 0 |
| 177 | + && is_second_arg_array_type |
| 178 | + { |
| 179 | + return Some((callee_name.into(), second_argument.range())); |
| 180 | + } |
| 181 | + } |
| 182 | + |
| 183 | + None |
| 184 | + } |
| 185 | + |
| 186 | + fn diagnostic(_ctx: &RuleContext<Self>, state: &Self::State) -> Option<RuleDiagnostic> { |
| 187 | + let (callee_name, range) = state; |
| 188 | + Some( |
| 189 | + RuleDiagnostic::new( |
| 190 | + rule_category!(), |
| 191 | + range, |
| 192 | + markup! { |
| 193 | + "In Solid, "<Emphasis>{callee_name}</Emphasis>" doesn't accept a dependency array because it automatically tracks its dependencies." |
| 194 | + }, |
| 195 | + ) |
| 196 | + .note(markup! { |
| 197 | + "Please just remove the dependency array parameter here." |
| 198 | + }) |
| 199 | + .note(markup! { |
| 200 | + "If you really need to override the list of dependencies, use \ |
| 201 | + "<Hyperlink href="https://docs.solidjs.com/reference/reactive-utilities/on-util#on">"on"</Hyperlink>"." |
| 202 | + }), |
| 203 | + ) |
| 204 | + } |
| 205 | +} |
0 commit comments