From bf7682ec5719d47f552ab92125018ea80797aea8 Mon Sep 17 00:00:00 2001 From: Emanuele Stoppa Date: Thu, 19 Sep 2024 16:30:25 +0100 Subject: [PATCH] docs: improve documentation of rule --- .../src/lint/correctness/use_exhaustive_dependencies.rs | 2 ++ .../src/lint/correctness/use_hook_at_top_level.rs | 2 ++ 2 files changed, 4 insertions(+) diff --git a/crates/biome_js_analyze/src/lint/correctness/use_exhaustive_dependencies.rs b/crates/biome_js_analyze/src/lint/correctness/use_exhaustive_dependencies.rs index e6dfb3de72a9..32e116d7fc37 100644 --- a/crates/biome_js_analyze/src/lint/correctness/use_exhaustive_dependencies.rs +++ b/crates/biome_js_analyze/src/lint/correctness/use_exhaustive_dependencies.rs @@ -22,6 +22,8 @@ use schemars::JsonSchema; declare_lint_rule! { /// Enforce all dependencies are correctly specified in a React hook. /// + /// _This rule should be used only in **React** projects._ + /// /// This rule is a port of the rule [react-hooks/exhaustive-deps](https://legacy.reactjs.org/docs/hooks-rules.html#eslint-plugin), and it's meant to target projects that uses React. /// /// If your project _doesn't_ use React (or Preact), **you shouldn't use this rule**. diff --git a/crates/biome_js_analyze/src/lint/correctness/use_hook_at_top_level.rs b/crates/biome_js_analyze/src/lint/correctness/use_hook_at_top_level.rs index 45143c60e88c..7d2c335dee7a 100644 --- a/crates/biome_js_analyze/src/lint/correctness/use_hook_at_top_level.rs +++ b/crates/biome_js_analyze/src/lint/correctness/use_hook_at_top_level.rs @@ -30,6 +30,8 @@ use schemars::JsonSchema; declare_lint_rule! { /// Enforce that all React hooks are being called from the Top Level component functions. /// + /// _This rule should be used only in **React** projects._ + /// /// To understand why this required see https://reactjs.org/docs/hooks-rules.html#only-call-hooks-at-the-top-level /// /// ## Examples