Commit 88ee1f5

Browse files
jackpopejackpope
authored
Add reporting modes for react-hooks/exhaustive-effect-dependencies and temporarily enable (#35365)
`react-hooks/exhaustive-effect-dependencies` from `ValidateExhaustiveDeps` reports errors for both missing and extra effect deps. We already have `react-hooks/exhaustive-deps` that errors on missing dependencies. In the future we'd like to consolidate this all to the compiler based error, but for now there's a lot of overlap. Let's enable testing the extra dep warning by splitting out reporting modes. This PR - Creates `on`, `off`, `missing-only`, and `extra-only` reporting modes for the effect dep validation flag - Temporarily enables the new rule with `extra-only` in `eslint-plugin-react-hooks` - Adds additional null checking to `manualMemoLoc` to fix a bug found when running against the fixture
1 parent bcf97c7 commit 88ee1f5

17 files changed

Lines changed: 293 additions & 22 deletions

‎compiler/packages/babel-plugin-react-compiler/src/HIR/Environment.ts‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,8 +225,15 @@ export const EnvironmentConfigSchema = z.object({
225225

226226
/**
227227
* Validate that dependencies supplied to effect hooks are exhaustive.
228+
* Can be:
229+
* - 'off': No validation (default)
230+
* - 'all': Validate and report both missing and extra dependencies
231+
* - 'missing-only': Only report missing dependencies
232+
* - 'extra-only': Only report extra/unnecessary dependencies
228233
*/
229-
validateExhaustiveEffectDependencies: z.boolean().default(false),
234+
validateExhaustiveEffectDependencies: z
235+
.enum(['off','all','missing-only','extra-only'])
236+
.default('off'),
230237

231238
/**
232239
* When this is true, rather than pruning existing manual memoization but ensuring or validating

‎compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateExhaustiveDependencies.ts‎

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,7 @@ export function validateExhaustiveDependencies(
141141
reactive,
142142
startMemo.depsLoc,
143143
ErrorCategory.MemoDependencies,
144+
'all',
144145
);
145146
if(diagnostic!=null){
146147
error.pushDiagnostic(diagnostic);
@@ -159,7 +160,7 @@ export function validateExhaustiveDependencies(
159160
onStartMemoize,
160161
onFinishMemoize,
161162
onEffect: (inferred,manual,manualMemoLoc)=>{
162-
if(env.config.validateExhaustiveEffectDependencies===false){
163+
if(env.config.validateExhaustiveEffectDependencies==='off'){
163164
return;
164165
}
165166
if(DEBUG){
@@ -195,12 +196,17 @@ export function validateExhaustiveDependencies(
195196
});
196197
}
197198
}
199+
consteffectReportMode=
200+
typeofenv.config.validateExhaustiveEffectDependencies==='string'
201+
? env.config.validateExhaustiveEffectDependencies
202+
: 'all';
198203
constdiagnostic=validateDependencies(
199204
Array.from(inferred),
200205
manualDeps,
201206
reactive,
202207
manualMemoLoc,
203208
ErrorCategory.EffectExhaustiveDependencies,
209+
effectReportMode,
204210
);
205211
if(diagnostic!=null){
206212
error.pushDiagnostic(diagnostic);
@@ -220,6 +226,7 @@ function validateDependencies(
220226
category:
221227
|ErrorCategory.MemoDependencies
222228
|ErrorCategory.EffectExhaustiveDependencies,
229+
exhaustiveDepsReportMode: 'all'|'missing-only'|'extra-only',
223230
): CompilerDiagnostic|null{
224231
// Sort dependencies by name and path, with shorter/non-optional paths first
225232
inferred.sort((a,b)=>{
@@ -370,9 +377,20 @@ function validateDependencies(
370377
extra.push(dep);
371378
}
372379

373-
if(missing.length!==0||extra.length!==0){
380+
// Filter based on report mode
381+
constfilteredMissing=
382+
exhaustiveDepsReportMode==='extra-only' ? [] : missing;
383+
constfilteredExtra=
384+
exhaustiveDepsReportMode==='missing-only' ? [] : extra;
385+
386+
if(filteredMissing.length!==0||filteredExtra.length!==0){
374387
letsuggestion: CompilerSuggestion|null=null;
375-
if(manualMemoLoc!=null&&typeofmanualMemoLoc!=='symbol'){
388+
if(
389+
manualMemoLoc!=null&&
390+
typeofmanualMemoLoc!=='symbol'&&
391+
manualMemoLoc.start.index!=null&&
392+
manualMemoLoc.end.index!=null
393+
){
376394
suggestion={
377395
description: 'Update dependencies',
378396
range: [manualMemoLoc.start.index,manualMemoLoc.end.index],
@@ -388,8 +406,13 @@ function validateDependencies(
388406
.join(', ')}]`,
389407
};
390408
}
391-
constdiagnostic=createDiagnostic(category,missing,extra,suggestion);
392-
for(constdepofmissing){
409+
constdiagnostic=createDiagnostic(
410+
category,
411+
filteredMissing,
412+
filteredExtra,
413+
suggestion,
414+
);
415+
for(constdepoffilteredMissing){
393416
letreactiveStableValueHint='';
394417
if(isStableType(dep.identifier)){
395418
reactiveStableValueHint=
@@ -402,7 +425,7 @@ function validateDependencies(
402425
loc: dep.loc,
403426
});
404427
}
405-
for(constdepofextra){
428+
for(constdepoffilteredExtra){
406429
if(dep.root.kind==='Global'){
407430
diagnostic.withDetails({
408431
kind: 'error',

‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.exhaustive-deps-effect-events.expect.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
## Input
33

44
```javascript
5-
// @validateExhaustiveEffectDependencies
5+
// @validateExhaustiveEffectDependencies:"all"
66
import {useEffect, useEffectEvent} from'react';
77

88
functionComponent({x, y, z}) {

‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.exhaustive-deps-effect-events.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// @validateExhaustiveEffectDependencies
1+
// @validateExhaustiveEffectDependencies:"all"
22
import{useEffect,useEffectEvent}from'react';
33

44
functionComponent({x, y, z}){

‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps-extra-only.expect.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
2+
## Input
3+
4+
```javascript
5+
// @validateExhaustiveEffectDependencies:"extra-only"
6+
import {useEffect} from'react';
7+
8+
functionComponent({x, y, z}) {
9+
// no error: missing dep not reported in extra-only mode
10+
useEffect(() => {
11+
log(x);
12+
}, []);
13+
14+
// error: extra dep - y
15+
useEffect(() => {
16+
log(x);
17+
}, [x, y]);
18+
19+
// error: extra dep - y (missing dep - z not reported)
20+
useEffect(() => {
21+
log(x, z);
22+
}, [x, y]);
23+
24+
// error: extra dep - x.y
25+
useEffect(() => {
26+
log(x);
27+
}, [x.y]);
28+
}
29+
30+
```
31+
32+
33+
## Error
34+
35+
```
36+
Found 3 errors:
37+
38+
Error: Found extra effect dependencies
39+
40+
Extra dependencies can cause an effect to fire more often than it should, resulting in performance problems such as excessive renders and side effects.
41+
42+
error.invalid-exhaustive-effect-deps-extra-only.ts:13:9
43+
11 | useEffect(() => {
44+
12 | log(x);
45+
> 13 | }, [x, y]);
46+
| ^ Unnecessary dependency `y`
47+
14 |
48+
15 | // error: extra dep - y (missing dep - z not reported)
49+
16 | useEffect(() => {
50+
51+
Inferred dependencies: `[x]`
52+
53+
Error: Found extra effect dependencies
54+
55+
Extra dependencies can cause an effect to fire more often than it should, resulting in performance problems such as excessive renders and side effects.
56+
57+
error.invalid-exhaustive-effect-deps-extra-only.ts:18:9
58+
16 | useEffect(() => {
59+
17 | log(x, z);
60+
> 18 | }, [x, y]);
61+
| ^ Unnecessary dependency `y`
62+
19 |
63+
20 | // error: extra dep - x.y
64+
21 | useEffect(() => {
65+
66+
Inferred dependencies: `[x, z]`
67+
68+
Error: Found extra effect dependencies
69+
70+
Extra dependencies can cause an effect to fire more often than it should, resulting in performance problems such as excessive renders and side effects.
71+
72+
error.invalid-exhaustive-effect-deps-extra-only.ts:23:6
73+
21 | useEffect(() => {
74+
22 | log(x);
75+
> 23 | }, [x.y]);
76+
| ^^^ Overly precise dependency `x.y`, use `x` instead
77+
24 | }
78+
25 |
79+
80+
Inferred dependencies: `[x]`
81+
```
82+
83+

‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps-extra-only.js‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
// @validateExhaustiveEffectDependencies:"extra-only"
2+
import{useEffect}from'react';
3+
4+
functionComponent({x, y, z}){
5+
// no error: missing dep not reported in extra-only mode
6+
useEffect(()=>{
7+
log(x);
8+
},[]);
9+
10+
// error: extra dep - y
11+
useEffect(()=>{
12+
log(x);
13+
},[x,y]);
14+
15+
// error: extra dep - y (missing dep - z not reported)
16+
useEffect(()=>{
17+
log(x,z);
18+
},[x,y]);
19+
20+
// error: extra dep - x.y
21+
useEffect(()=>{
22+
log(x);
23+
},[x.y]);
24+
}

‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps-missing-only.expect.md‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
2+
## Input
3+
4+
```javascript
5+
// @validateExhaustiveEffectDependencies:"missing-only"
6+
import {useEffect} from'react';
7+
8+
functionComponent({x, y, z}) {
9+
// error: missing dep - x
10+
useEffect(() => {
11+
log(x);
12+
}, []);
13+
14+
// no error: extra dep not reported in missing-only mode
15+
useEffect(() => {
16+
log(x);
17+
}, [x, y]);
18+
19+
// error: missing dep - z (extra dep - y not reported)
20+
useEffect(() => {
21+
log(x, z);
22+
}, [x, y]);
23+
24+
// error: missing dep x
25+
useEffect(() => {
26+
log(x);
27+
}, [x.y]);
28+
}
29+
30+
```
31+
32+
33+
## Error
34+
35+
```
36+
Found 3 errors:
37+
38+
Error: Found missing effect dependencies
39+
40+
Missing dependencies can cause an effect to fire less often than it should.
41+
42+
error.invalid-exhaustive-effect-deps-missing-only.ts:7:8
43+
5 | // error: missing dep - x
44+
6 | useEffect(() => {
45+
> 7 | log(x);
46+
| ^ Missing dependency `x`
47+
8 | }, []);
48+
9 |
49+
10 | // no error: extra dep not reported in missing-only mode
50+
51+
Inferred dependencies: `[x]`
52+
53+
Error: Found missing effect dependencies
54+
55+
Missing dependencies can cause an effect to fire less often than it should.
56+
57+
error.invalid-exhaustive-effect-deps-missing-only.ts:17:11
58+
15 | // error: missing dep - z (extra dep - y not reported)
59+
16 | useEffect(() => {
60+
> 17 | log(x, z);
61+
| ^ Missing dependency `z`
62+
18 | }, [x, y]);
63+
19 |
64+
20 | // error: missing dep x
65+
66+
Inferred dependencies: `[x, z]`
67+
68+
Error: Found missing effect dependencies
69+
70+
Missing dependencies can cause an effect to fire less often than it should.
71+
72+
error.invalid-exhaustive-effect-deps-missing-only.ts:22:8
73+
20 | // error: missing dep x
74+
21 | useEffect(() => {
75+
> 22 | log(x);
76+
| ^ Missing dependency `x`
77+
23 | }, [x.y]);
78+
24 | }
79+
25 |
80+
81+
Inferred dependencies: `[x]`
82+
```
83+
84+

‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps-missing-only.js‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
// @validateExhaustiveEffectDependencies:"missing-only"
2+
import{useEffect}from'react';
3+
4+
functionComponent({x, y, z}){
5+
// error: missing dep - x
6+
useEffect(()=>{
7+
log(x);
8+
},[]);
9+
10+
// no error: extra dep not reported in missing-only mode
11+
useEffect(()=>{
12+
log(x);
13+
},[x,y]);
14+
15+
// error: missing dep - z (extra dep - y not reported)
16+
useEffect(()=>{
17+
log(x,z);
18+
},[x,y]);
19+
20+
// error: missing dep x
21+
useEffect(()=>{
22+
log(x);
23+
},[x.y]);
24+
}

‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps.expect.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
## Input
33

44
```javascript
5-
// @validateExhaustiveEffectDependencies
5+
// @validateExhaustiveEffectDependencies:"all"
66
import {useEffect} from'react';
77

88
functionComponent({x, y, z}) {

‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// @validateExhaustiveEffectDependencies
1+
// @validateExhaustiveEffectDependencies:"all"
22
import{useEffect}from'react';
33

44
functionComponent({x, y, z}){

0 commit comments

Comments
 (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Commit 88ee1f5
Browse files
jackpopejackpope
authored
Add reporting modes for react-hooks/exhaustive-effect-dependencies and temporarily enable (#35365)
`react-hooks/exhaustive-effect-dependencies` from
`ValidateExhaustiveDeps` reports errors for both missing and extra
effect deps. We already have `react-hooks/exhaustive-deps` that errors
on missing dependencies. In the future we'd like to consolidate this all
to the compiler based error, but for now there's a lot of overlap. Let's
enable testing the extra dep warning by splitting out reporting modes.
This PR
- Creates `on`, `off`, `missing-only`, and `extra-only` reporting modes
for the effect dep validation flag
- Temporarily enables the new rule with `extra-only` in
`eslint-plugin-react-hooks`
- Adds additional null checking to `manualMemoLoc` to fix a bug found
when running against the fixture
1 parent bcf97c7 commit 88ee1f5
17 files changed
Lines changed: 293 additions & 22 deletions
‎compiler/packages/babel-plugin-react-compiler/src/HIR/Environment.ts‎
Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,8 +225,15 @@ export const EnvironmentConfigSchema = z.object({
225225

226226
/**
227227
 * Validate that dependencies supplied to effect hooks are exhaustive.
228+
 * Can be:
229+
 * - 'off': No validation (default)
230+
 * - 'all': Validate and report both missing and extra dependencies
231+
 * - 'missing-only': Only report missing dependencies
232+
 * - 'extra-only': Only report extra/unnecessary dependencies
228233
 */
229-
validateExhaustiveEffectDependencies: z.boolean().default(false),
234+
validateExhaustiveEffectDependencies: z
235+
.enum(['off','all','missing-only','extra-only'])
236+
.default('off'),
230237

231238
/**
232239
 * When this is true, rather than pruning existing manual memoization but ensuring or validating
‎compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateExhaustiveDependencies.ts‎
Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,7 @@ export function validateExhaustiveDependencies(
141141
reactive,
142142
startMemo.depsLoc,
143143
ErrorCategory.MemoDependencies,
144+
'all',
144145
);
145146
if(diagnostic!=null){
146147
error.pushDiagnostic(diagnostic);
@@ -159,7 +160,7 @@ export function validateExhaustiveDependencies(
159160
 onStartMemoize,
160161
 onFinishMemoize,
161162
onEffect: (inferred,manual,manualMemoLoc)=>{
162-
if(env.config.validateExhaustiveEffectDependencies===false){
163+
if(env.config.validateExhaustiveEffectDependencies==='off'){
163164
return;
164165
}
165166
if(DEBUG){
@@ -195,12 +196,17 @@ export function validateExhaustiveDependencies(
195196
});
196197
}
197198
}
199+
consteffectReportMode=
200+
typeofenv.config.validateExhaustiveEffectDependencies==='string'
201+
 ? env.config.validateExhaustiveEffectDependencies
202+
 : 'all';
198203
constdiagnostic=validateDependencies(
199204
Array.from(inferred),
200205
manualDeps,
201206
reactive,
202207
manualMemoLoc,
203208
ErrorCategory.EffectExhaustiveDependencies,
209+
effectReportMode,
204210
);
205211
if(diagnostic!=null){
206212
error.pushDiagnostic(diagnostic);
@@ -220,6 +226,7 @@ function validateDependencies(
220226
category:
221227
|ErrorCategory.MemoDependencies
222228
|ErrorCategory.EffectExhaustiveDependencies,
229+
exhaustiveDepsReportMode: 'all'|'missing-only'|'extra-only',
223230
): CompilerDiagnostic|null{
224231
// Sort dependencies by name and path, with shorter/non-optional paths first
225232
inferred.sort((a,b)=>{
@@ -370,9 +377,20 @@ function validateDependencies(
370377
extra.push(dep);
371378
}
372379

373-
if(missing.length!==0||extra.length!==0){
380+
// Filter based on report mode
381+
constfilteredMissing=
382+
exhaustiveDepsReportMode==='extra-only' ? [] : missing;
383+
constfilteredExtra=
384+
exhaustiveDepsReportMode==='missing-only' ? [] : extra;
385+
386+
if(filteredMissing.length!==0||filteredExtra.length!==0){
374387
letsuggestion: CompilerSuggestion|null=null;
375-
if(manualMemoLoc!=null&&typeofmanualMemoLoc!=='symbol'){
388+
if(
389+
manualMemoLoc!=null&&
390+
typeofmanualMemoLoc!=='symbol'&&
391+
manualMemoLoc.start.index!=null&&
392+
manualMemoLoc.end.index!=null
393+
){
376394
suggestion={
377395
description: 'Update dependencies',
378396
range: [manualMemoLoc.start.index,manualMemoLoc.end.index],
@@ -388,8 +406,13 @@ function validateDependencies(
388406
.join(', ')}]`,
389407
};
390408
}
391-
constdiagnostic=createDiagnostic(category,missing,extra,suggestion);
392-
for(constdepofmissing){
409+
constdiagnostic=createDiagnostic(
410+
category,
411+
filteredMissing,
412+
filteredExtra,
413+
suggestion,
414+
);
415+
for(constdepoffilteredMissing){
393416
letreactiveStableValueHint='';
394417
if(isStableType(dep.identifier)){
395418
reactiveStableValueHint=
@@ -402,7 +425,7 @@ function validateDependencies(
402425
loc: dep.loc,
403426
});
404427
}
405-
for(constdepofextra){
428+
for(constdepoffilteredExtra){
406429
if(dep.root.kind==='Global'){
407430
diagnostic.withDetails({
408431
kind: 'error',
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.exhaustive-deps-effect-events.expect.md‎
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
## Input
33

44
```javascript
5-
// @validateExhaustiveEffectDependencies
5+
// @validateExhaustiveEffectDependencies:"all"
66
import {useEffect, useEffectEvent} from'react';
77

88
functionComponent({x, y, z}) {
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.exhaustive-deps-effect-events.js‎
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// @validateExhaustiveEffectDependencies
1+
// @validateExhaustiveEffectDependencies:"all"
22
import{useEffect,useEffectEvent}from'react';
33

44
functionComponent({x, y, z}){
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps-extra-only.expect.md‎
Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
2+
## Input
3+
4+
```javascript
5+
// @validateExhaustiveEffectDependencies:"extra-only"
6+
import {useEffect} from'react';
7+
8+
functionComponent({x, y, z}) {
9+
// no error: missing dep not reported in extra-only mode
10+
useEffect(() => {
11+
log(x);
12+
 }, []);
13+
14+
// error: extra dep - y
15+
useEffect(() => {
16+
log(x);
17+
 }, [x, y]);
18+
19+
// error: extra dep - y (missing dep - z not reported)
20+
useEffect(() => {
21+
log(x, z);
22+
 }, [x, y]);
23+
24+
// error: extra dep - x.y
25+
useEffect(() => {
26+
log(x);
27+
 }, [x.y]);
28+
}
29+
30+
```
31+
32+
33+
## Error
34+
35+
```
36+
Found 3 errors:
37+
38+
Error: Found extra effect dependencies
39+
40+
Extra dependencies can cause an effect to fire more often than it should, resulting in performance problems such as excessive renders and side effects.
41+
42+
error.invalid-exhaustive-effect-deps-extra-only.ts:13:9
43+
 11 | useEffect(() => {
44+
 12 | log(x);
45+
> 13 | }, [x, y]);
46+
 | ^ Unnecessary dependency `y`
47+
 14 |
48+
 15 | // error: extra dep - y (missing dep - z not reported)
49+
 16 | useEffect(() => {
50+
51+
Inferred dependencies: `[x]`
52+
53+
Error: Found extra effect dependencies
54+
55+
Extra dependencies can cause an effect to fire more often than it should, resulting in performance problems such as excessive renders and side effects.
56+
57+
error.invalid-exhaustive-effect-deps-extra-only.ts:18:9
58+
 16 | useEffect(() => {
59+
 17 | log(x, z);
60+
> 18 | }, [x, y]);
61+
 | ^ Unnecessary dependency `y`
62+
 19 |
63+
 20 | // error: extra dep - x.y
64+
 21 | useEffect(() => {
65+
66+
Inferred dependencies: `[x, z]`
67+
68+
Error: Found extra effect dependencies
69+
70+
Extra dependencies can cause an effect to fire more often than it should, resulting in performance problems such as excessive renders and side effects.
71+
72+
error.invalid-exhaustive-effect-deps-extra-only.ts:23:6
73+
 21 | useEffect(() => {
74+
 22 | log(x);
75+
> 23 | }, [x.y]);
76+
 | ^^^ Overly precise dependency `x.y`, use `x` instead
77+
 24 | }
78+
 25 |
79+
80+
Inferred dependencies: `[x]`
81+
```
82+
83+
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps-extra-only.js‎
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
// @validateExhaustiveEffectDependencies:"extra-only"
2+
import{useEffect}from'react';
3+
4+
functionComponent({x, y, z}){
5+
// no error: missing dep not reported in extra-only mode
6+
useEffect(()=>{
7+
log(x);
8+
},[]);
9+
10+
// error: extra dep - y
11+
useEffect(()=>{
12+
log(x);
13+
},[x,y]);
14+
15+
// error: extra dep - y (missing dep - z not reported)
16+
useEffect(()=>{
17+
log(x,z);
18+
},[x,y]);
19+
20+
// error: extra dep - x.y
21+
useEffect(()=>{
22+
log(x);
23+
},[x.y]);
24+
}
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps-missing-only.expect.md‎
Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
2+
## Input
3+
4+
```javascript
5+
// @validateExhaustiveEffectDependencies:"missing-only"
6+
import {useEffect} from'react';
7+
8+
functionComponent({x, y, z}) {
9+
// error: missing dep - x
10+
useEffect(() => {
11+
log(x);
12+
 }, []);
13+
14+
// no error: extra dep not reported in missing-only mode
15+
useEffect(() => {
16+
log(x);
17+
 }, [x, y]);
18+
19+
// error: missing dep - z (extra dep - y not reported)
20+
useEffect(() => {
21+
log(x, z);
22+
 }, [x, y]);
23+
24+
// error: missing dep x
25+
useEffect(() => {
26+
log(x);
27+
 }, [x.y]);
28+
}
29+
30+
```
31+
32+
33+
## Error
34+
35+
```
36+
Found 3 errors:
37+
38+
Error: Found missing effect dependencies
39+
40+
Missing dependencies can cause an effect to fire less often than it should.
41+
42+
error.invalid-exhaustive-effect-deps-missing-only.ts:7:8
43+
 5 | // error: missing dep - x
44+
 6 | useEffect(() => {
45+
> 7 | log(x);
46+
 | ^ Missing dependency `x`
47+
 8 | }, []);
48+
 9 |
49+
 10 | // no error: extra dep not reported in missing-only mode
50+
51+
Inferred dependencies: `[x]`
52+
53+
Error: Found missing effect dependencies
54+
55+
Missing dependencies can cause an effect to fire less often than it should.
56+
57+
error.invalid-exhaustive-effect-deps-missing-only.ts:17:11
58+
 15 | // error: missing dep - z (extra dep - y not reported)
59+
 16 | useEffect(() => {
60+
> 17 | log(x, z);
61+
 | ^ Missing dependency `z`
62+
 18 | }, [x, y]);
63+
 19 |
64+
 20 | // error: missing dep x
65+
66+
Inferred dependencies: `[x, z]`
67+
68+
Error: Found missing effect dependencies
69+
70+
Missing dependencies can cause an effect to fire less often than it should.
71+
72+
error.invalid-exhaustive-effect-deps-missing-only.ts:22:8
73+
 20 | // error: missing dep x
74+
 21 | useEffect(() => {
75+
> 22 | log(x);
76+
 | ^ Missing dependency `x`
77+
 23 | }, [x.y]);
78+
 24 | }
79+
 25 |
80+
81+
Inferred dependencies: `[x]`
82+
```
83+
84+
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps-missing-only.js‎
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
// @validateExhaustiveEffectDependencies:"missing-only"
2+
import{useEffect}from'react';
3+
4+
functionComponent({x, y, z}){
5+
// error: missing dep - x
6+
useEffect(()=>{
7+
log(x);
8+
},[]);
9+
10+
// no error: extra dep not reported in missing-only mode
11+
useEffect(()=>{
12+
log(x);
13+
},[x,y]);
14+
15+
// error: missing dep - z (extra dep - y not reported)
16+
useEffect(()=>{
17+
log(x,z);
18+
},[x,y]);
19+
20+
// error: missing dep x
21+
useEffect(()=>{
22+
log(x);
23+
},[x.y]);
24+
}
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps.expect.md‎
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
## Input
33

44
```javascript
5-
// @validateExhaustiveEffectDependencies
5+
// @validateExhaustiveEffectDependencies:"all"
66
import {useEffect} from'react';
77

88
functionComponent({x, y, z}) {
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps.js‎
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// @validateExhaustiveEffectDependencies
1+
// @validateExhaustiveEffectDependencies:"all"
22
import{useEffect}from'react';
33

44
functionComponent({x, y, z}){
0 commit comments
Comments
 (0)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Commit 88ee1f5
Browse files
jackpopejackpope
authored
Add reporting modes for react-hooks/exhaustive-effect-dependencies and temporarily enable (#35365)
`react-hooks/exhaustive-effect-dependencies` from
`ValidateExhaustiveDeps` reports errors for both missing and extra
effect deps. We already have `react-hooks/exhaustive-deps` that errors
on missing dependencies. In the future we'd like to consolidate this all
to the compiler based error, but for now there's a lot of overlap. Let's
enable testing the extra dep warning by splitting out reporting modes.
This PR
- Creates `on`, `off`, `missing-only`, and `extra-only` reporting modes
for the effect dep validation flag
- Temporarily enables the new rule with `extra-only` in
`eslint-plugin-react-hooks`
- Adds additional null checking to `manualMemoLoc` to fix a bug found
when running against the fixture
1 parent bcf97c7 commit 88ee1f5
17 files changed
Lines changed: 293 additions & 22 deletions
‎compiler/packages/babel-plugin-react-compiler/src/HIR/Environment.ts‎
Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,8 +225,15 @@ export const EnvironmentConfigSchema = z.object({
225225

226226
/**
227227
 * Validate that dependencies supplied to effect hooks are exhaustive.
228+
 * Can be:
229+
 * - 'off': No validation (default)
230+
 * - 'all': Validate and report both missing and extra dependencies
231+
 * - 'missing-only': Only report missing dependencies
232+
 * - 'extra-only': Only report extra/unnecessary dependencies
228233
 */
229-
validateExhaustiveEffectDependencies: z.boolean().default(false),
234+
validateExhaustiveEffectDependencies: z
235+
.enum(['off','all','missing-only','extra-only'])
236+
.default('off'),
230237

231238
/**
232239
 * When this is true, rather than pruning existing manual memoization but ensuring or validating
‎compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateExhaustiveDependencies.ts‎
Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,7 @@ export function validateExhaustiveDependencies(
141141
reactive,
142142
startMemo.depsLoc,
143143
ErrorCategory.MemoDependencies,
144+
'all',
144145
);
145146
if(diagnostic!=null){
146147
error.pushDiagnostic(diagnostic);
@@ -159,7 +160,7 @@ export function validateExhaustiveDependencies(
159160
 onStartMemoize,
160161
 onFinishMemoize,
161162
onEffect: (inferred,manual,manualMemoLoc)=>{
162-
if(env.config.validateExhaustiveEffectDependencies===false){
163+
if(env.config.validateExhaustiveEffectDependencies==='off'){
163164
return;
164165
}
165166
if(DEBUG){
@@ -195,12 +196,17 @@ export function validateExhaustiveDependencies(
195196
});
196197
}
197198
}
199+
consteffectReportMode=
200+
typeofenv.config.validateExhaustiveEffectDependencies==='string'
201+
 ? env.config.validateExhaustiveEffectDependencies
202+
 : 'all';
198203
constdiagnostic=validateDependencies(
199204
Array.from(inferred),
200205
manualDeps,
201206
reactive,
202207
manualMemoLoc,
203208
ErrorCategory.EffectExhaustiveDependencies,
209+
effectReportMode,
204210
);
205211
if(diagnostic!=null){
206212
error.pushDiagnostic(diagnostic);
@@ -220,6 +226,7 @@ function validateDependencies(
220226
category:
221227
|ErrorCategory.MemoDependencies
222228
|ErrorCategory.EffectExhaustiveDependencies,
229+
exhaustiveDepsReportMode: 'all'|'missing-only'|'extra-only',
223230
): CompilerDiagnostic|null{
224231
// Sort dependencies by name and path, with shorter/non-optional paths first
225232
inferred.sort((a,b)=>{
@@ -370,9 +377,20 @@ function validateDependencies(
370377
extra.push(dep);
371378
}
372379

373-
if(missing.length!==0||extra.length!==0){
380+
// Filter based on report mode
381+
constfilteredMissing=
382+
exhaustiveDepsReportMode==='extra-only' ? [] : missing;
383+
constfilteredExtra=
384+
exhaustiveDepsReportMode==='missing-only' ? [] : extra;
385+
386+
if(filteredMissing.length!==0||filteredExtra.length!==0){
374387
letsuggestion: CompilerSuggestion|null=null;
375-
if(manualMemoLoc!=null&&typeofmanualMemoLoc!=='symbol'){
388+
if(
389+
manualMemoLoc!=null&&
390+
typeofmanualMemoLoc!=='symbol'&&
391+
manualMemoLoc.start.index!=null&&
392+
manualMemoLoc.end.index!=null
393+
){
376394
suggestion={
377395
description: 'Update dependencies',
378396
range: [manualMemoLoc.start.index,manualMemoLoc.end.index],
@@ -388,8 +406,13 @@ function validateDependencies(
388406
.join(', ')}]`,
389407
};
390408
}
391-
constdiagnostic=createDiagnostic(category,missing,extra,suggestion);
392-
for(constdepofmissing){
409+
constdiagnostic=createDiagnostic(
410+
category,
411+
filteredMissing,
412+
filteredExtra,
413+
suggestion,
414+
);
415+
for(constdepoffilteredMissing){
393416
letreactiveStableValueHint='';
394417
if(isStableType(dep.identifier)){
395418
reactiveStableValueHint=
@@ -402,7 +425,7 @@ function validateDependencies(
402425
loc: dep.loc,
403426
});
404427
}
405-
for(constdepofextra){
428+
for(constdepoffilteredExtra){
406429
if(dep.root.kind==='Global'){
407430
diagnostic.withDetails({
408431
kind: 'error',
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.exhaustive-deps-effect-events.expect.md‎
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
## Input
33

44
```javascript
5-
// @validateExhaustiveEffectDependencies
5+
// @validateExhaustiveEffectDependencies:"all"
66
import {useEffect, useEffectEvent} from'react';
77

88
functionComponent({x, y, z}) {
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.exhaustive-deps-effect-events.js‎
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// @validateExhaustiveEffectDependencies
1+
// @validateExhaustiveEffectDependencies:"all"
22
import{useEffect,useEffectEvent}from'react';
33

44
functionComponent({x, y, z}){
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps-extra-only.expect.md‎
Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
2+
## Input
3+
4+
```javascript
5+
// @validateExhaustiveEffectDependencies:"extra-only"
6+
import {useEffect} from'react';
7+
8+
functionComponent({x, y, z}) {
9+
// no error: missing dep not reported in extra-only mode
10+
useEffect(() => {
11+
log(x);
12+
 }, []);
13+
14+
// error: extra dep - y
15+
useEffect(() => {
16+
log(x);
17+
 }, [x, y]);
18+
19+
// error: extra dep - y (missing dep - z not reported)
20+
useEffect(() => {
21+
log(x, z);
22+
 }, [x, y]);
23+
24+
// error: extra dep - x.y
25+
useEffect(() => {
26+
log(x);
27+
 }, [x.y]);
28+
}
29+
30+
```
31+
32+
33+
## Error
34+
35+
```
36+
Found 3 errors:
37+
38+
Error: Found extra effect dependencies
39+
40+
Extra dependencies can cause an effect to fire more often than it should, resulting in performance problems such as excessive renders and side effects.
41+
42+
error.invalid-exhaustive-effect-deps-extra-only.ts:13:9
43+
 11 | useEffect(() => {
44+
 12 | log(x);
45+
> 13 | }, [x, y]);
46+
 | ^ Unnecessary dependency `y`
47+
 14 |
48+
 15 | // error: extra dep - y (missing dep - z not reported)
49+
 16 | useEffect(() => {
50+
51+
Inferred dependencies: `[x]`
52+
53+
Error: Found extra effect dependencies
54+
55+
Extra dependencies can cause an effect to fire more often than it should, resulting in performance problems such as excessive renders and side effects.
56+
57+
error.invalid-exhaustive-effect-deps-extra-only.ts:18:9
58+
 16 | useEffect(() => {
59+
 17 | log(x, z);
60+
> 18 | }, [x, y]);
61+
 | ^ Unnecessary dependency `y`
62+
 19 |
63+
 20 | // error: extra dep - x.y
64+
 21 | useEffect(() => {
65+
66+
Inferred dependencies: `[x, z]`
67+
68+
Error: Found extra effect dependencies
69+
70+
Extra dependencies can cause an effect to fire more often than it should, resulting in performance problems such as excessive renders and side effects.
71+
72+
error.invalid-exhaustive-effect-deps-extra-only.ts:23:6
73+
 21 | useEffect(() => {
74+
 22 | log(x);
75+
> 23 | }, [x.y]);
76+
 | ^^^ Overly precise dependency `x.y`, use `x` instead
77+
 24 | }
78+
 25 |
79+
80+
Inferred dependencies: `[x]`
81+
```
82+
83+
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps-extra-only.js‎
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
// @validateExhaustiveEffectDependencies:"extra-only"
2+
import{useEffect}from'react';
3+
4+
functionComponent({x, y, z}){
5+
// no error: missing dep not reported in extra-only mode
6+
useEffect(()=>{
7+
log(x);
8+
},[]);
9+
10+
// error: extra dep - y
11+
useEffect(()=>{
12+
log(x);
13+
},[x,y]);
14+
15+
// error: extra dep - y (missing dep - z not reported)
16+
useEffect(()=>{
17+
log(x,z);
18+
},[x,y]);
19+
20+
// error: extra dep - x.y
21+
useEffect(()=>{
22+
log(x);
23+
},[x.y]);
24+
}
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps-missing-only.expect.md‎
Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
2+
## Input
3+
4+
```javascript
5+
// @validateExhaustiveEffectDependencies:"missing-only"
6+
import {useEffect} from'react';
7+
8+
functionComponent({x, y, z}) {
9+
// error: missing dep - x
10+
useEffect(() => {
11+
log(x);
12+
 }, []);
13+
14+
// no error: extra dep not reported in missing-only mode
15+
useEffect(() => {
16+
log(x);
17+
 }, [x, y]);
18+
19+
// error: missing dep - z (extra dep - y not reported)
20+
useEffect(() => {
21+
log(x, z);
22+
 }, [x, y]);
23+
24+
// error: missing dep x
25+
useEffect(() => {
26+
log(x);
27+
 }, [x.y]);
28+
}
29+
30+
```
31+
32+
33+
## Error
34+
35+
```
36+
Found 3 errors:
37+
38+
Error: Found missing effect dependencies
39+
40+
Missing dependencies can cause an effect to fire less often than it should.
41+
42+
error.invalid-exhaustive-effect-deps-missing-only.ts:7:8
43+
 5 | // error: missing dep - x
44+
 6 | useEffect(() => {
45+
> 7 | log(x);
46+
 | ^ Missing dependency `x`
47+
 8 | }, []);
48+
 9 |
49+
 10 | // no error: extra dep not reported in missing-only mode
50+
51+
Inferred dependencies: `[x]`
52+
53+
Error: Found missing effect dependencies
54+
55+
Missing dependencies can cause an effect to fire less often than it should.
56+
57+
error.invalid-exhaustive-effect-deps-missing-only.ts:17:11
58+
 15 | // error: missing dep - z (extra dep - y not reported)
59+
 16 | useEffect(() => {
60+
> 17 | log(x, z);
61+
 | ^ Missing dependency `z`
62+
 18 | }, [x, y]);
63+
 19 |
64+
 20 | // error: missing dep x
65+
66+
Inferred dependencies: `[x, z]`
67+
68+
Error: Found missing effect dependencies
69+
70+
Missing dependencies can cause an effect to fire less often than it should.
71+
72+
error.invalid-exhaustive-effect-deps-missing-only.ts:22:8
73+
 20 | // error: missing dep x
74+
 21 | useEffect(() => {
75+
> 22 | log(x);
76+
 | ^ Missing dependency `x`
77+
 23 | }, [x.y]);
78+
 24 | }
79+
 25 |
80+
81+
Inferred dependencies: `[x]`
82+
```
83+
84+
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps-missing-only.js‎
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
// @validateExhaustiveEffectDependencies:"missing-only"
2+
import{useEffect}from'react';
3+
4+
functionComponent({x, y, z}){
5+
// error: missing dep - x
6+
useEffect(()=>{
7+
log(x);
8+
},[]);
9+
10+
// no error: extra dep not reported in missing-only mode
11+
useEffect(()=>{
12+
log(x);
13+
},[x,y]);
14+
15+
// error: missing dep - z (extra dep - y not reported)
16+
useEffect(()=>{
17+
log(x,z);
18+
},[x,y]);
19+
20+
// error: missing dep x
21+
useEffect(()=>{
22+
log(x);
23+
},[x.y]);
24+
}
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps.expect.md‎
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
## Input
33

44
```javascript
5-
// @validateExhaustiveEffectDependencies
5+
// @validateExhaustiveEffectDependencies:"all"
66
import {useEffect} from'react';
77

88
functionComponent({x, y, z}) {
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps.js‎
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// @validateExhaustiveEffectDependencies
1+
// @validateExhaustiveEffectDependencies:"all"
22
import{useEffect}from'react';
33

44
functionComponent({x, y, z}){
0 commit comments
Comments
 (0)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Commit 88ee1f5
Browse files
jackpopejackpope
authored
Add reporting modes for react-hooks/exhaustive-effect-dependencies and temporarily enable (#35365)
`react-hooks/exhaustive-effect-dependencies` from
`ValidateExhaustiveDeps` reports errors for both missing and extra
effect deps. We already have `react-hooks/exhaustive-deps` that errors
on missing dependencies. In the future we'd like to consolidate this all
to the compiler based error, but for now there's a lot of overlap. Let's
enable testing the extra dep warning by splitting out reporting modes.
This PR
- Creates `on`, `off`, `missing-only`, and `extra-only` reporting modes
for the effect dep validation flag
- Temporarily enables the new rule with `extra-only` in
`eslint-plugin-react-hooks`
- Adds additional null checking to `manualMemoLoc` to fix a bug found
when running against the fixture
1 parent bcf97c7 commit 88ee1f5
17 files changed
Lines changed: 293 additions & 22 deletions
‎compiler/packages/babel-plugin-react-compiler/src/HIR/Environment.ts‎
Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,8 +225,15 @@ export const EnvironmentConfigSchema = z.object({
225225

226226
/**
227227
 * Validate that dependencies supplied to effect hooks are exhaustive.
228+
 * Can be:
229+
 * - 'off': No validation (default)
230+
 * - 'all': Validate and report both missing and extra dependencies
231+
 * - 'missing-only': Only report missing dependencies
232+
 * - 'extra-only': Only report extra/unnecessary dependencies
228233
 */
229-
validateExhaustiveEffectDependencies: z.boolean().default(false),
234+
validateExhaustiveEffectDependencies: z
235+
.enum(['off','all','missing-only','extra-only'])
236+
.default('off'),
230237

231238
/**
232239
 * When this is true, rather than pruning existing manual memoization but ensuring or validating
‎compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateExhaustiveDependencies.ts‎
Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,7 @@ export function validateExhaustiveDependencies(
141141
reactive,
142142
startMemo.depsLoc,
143143
ErrorCategory.MemoDependencies,
144+
'all',
144145
);
145146
if(diagnostic!=null){
146147
error.pushDiagnostic(diagnostic);
@@ -159,7 +160,7 @@ export function validateExhaustiveDependencies(
159160
 onStartMemoize,
160161
 onFinishMemoize,
161162
onEffect: (inferred,manual,manualMemoLoc)=>{
162-
if(env.config.validateExhaustiveEffectDependencies===false){
163+
if(env.config.validateExhaustiveEffectDependencies==='off'){
163164
return;
164165
}
165166
if(DEBUG){
@@ -195,12 +196,17 @@ export function validateExhaustiveDependencies(
195196
});
196197
}
197198
}
199+
consteffectReportMode=
200+
typeofenv.config.validateExhaustiveEffectDependencies==='string'
201+
 ? env.config.validateExhaustiveEffectDependencies
202+
 : 'all';
198203
constdiagnostic=validateDependencies(
199204
Array.from(inferred),
200205
manualDeps,
201206
reactive,
202207
manualMemoLoc,
203208
ErrorCategory.EffectExhaustiveDependencies,
209+
effectReportMode,
204210
);
205211
if(diagnostic!=null){
206212
error.pushDiagnostic(diagnostic);
@@ -220,6 +226,7 @@ function validateDependencies(
220226
category:
221227
|ErrorCategory.MemoDependencies
222228
|ErrorCategory.EffectExhaustiveDependencies,
229+
exhaustiveDepsReportMode: 'all'|'missing-only'|'extra-only',
223230
): CompilerDiagnostic|null{
224231
// Sort dependencies by name and path, with shorter/non-optional paths first
225232
inferred.sort((a,b)=>{
@@ -370,9 +377,20 @@ function validateDependencies(
370377
extra.push(dep);
371378
}
372379

373-
if(missing.length!==0||extra.length!==0){
380+
// Filter based on report mode
381+
constfilteredMissing=
382+
exhaustiveDepsReportMode==='extra-only' ? [] : missing;
383+
constfilteredExtra=
384+
exhaustiveDepsReportMode==='missing-only' ? [] : extra;
385+
386+
if(filteredMissing.length!==0||filteredExtra.length!==0){
374387
letsuggestion: CompilerSuggestion|null=null;
375-
if(manualMemoLoc!=null&&typeofmanualMemoLoc!=='symbol'){
388+
if(
389+
manualMemoLoc!=null&&
390+
typeofmanualMemoLoc!=='symbol'&&
391+
manualMemoLoc.start.index!=null&&
392+
manualMemoLoc.end.index!=null
393+
){
376394
suggestion={
377395
description: 'Update dependencies',
378396
range: [manualMemoLoc.start.index,manualMemoLoc.end.index],
@@ -388,8 +406,13 @@ function validateDependencies(
388406
.join(', ')}]`,
389407
};
390408
}
391-
constdiagnostic=createDiagnostic(category,missing,extra,suggestion);
392-
for(constdepofmissing){
409+
constdiagnostic=createDiagnostic(
410+
category,
411+
filteredMissing,
412+
filteredExtra,
413+
suggestion,
414+
);
415+
for(constdepoffilteredMissing){
393416
letreactiveStableValueHint='';
394417
if(isStableType(dep.identifier)){
395418
reactiveStableValueHint=
@@ -402,7 +425,7 @@ function validateDependencies(
402425
loc: dep.loc,
403426
});
404427
}
405-
for(constdepofextra){
428+
for(constdepoffilteredExtra){
406429
if(dep.root.kind==='Global'){
407430
diagnostic.withDetails({
408431
kind: 'error',
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.exhaustive-deps-effect-events.expect.md‎
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
## Input
33

44
```javascript
5-
// @validateExhaustiveEffectDependencies
5+
// @validateExhaustiveEffectDependencies:"all"
66
import {useEffect, useEffectEvent} from'react';
77

88
functionComponent({x, y, z}) {
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.exhaustive-deps-effect-events.js‎
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// @validateExhaustiveEffectDependencies
1+
// @validateExhaustiveEffectDependencies:"all"
22
import{useEffect,useEffectEvent}from'react';
33

44
functionComponent({x, y, z}){
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps-extra-only.expect.md‎
Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
2+
## Input
3+
4+
```javascript
5+
// @validateExhaustiveEffectDependencies:"extra-only"
6+
import {useEffect} from'react';
7+
8+
functionComponent({x, y, z}) {
9+
// no error: missing dep not reported in extra-only mode
10+
useEffect(() => {
11+
log(x);
12+
 }, []);
13+
14+
// error: extra dep - y
15+
useEffect(() => {
16+
log(x);
17+
 }, [x, y]);
18+
19+
// error: extra dep - y (missing dep - z not reported)
20+
useEffect(() => {
21+
log(x, z);
22+
 }, [x, y]);
23+
24+
// error: extra dep - x.y
25+
useEffect(() => {
26+
log(x);
27+
 }, [x.y]);
28+
}
29+
30+
```
31+
32+
33+
## Error
34+
35+
```
36+
Found 3 errors:
37+
38+
Error: Found extra effect dependencies
39+
40+
Extra dependencies can cause an effect to fire more often than it should, resulting in performance problems such as excessive renders and side effects.
41+
42+
error.invalid-exhaustive-effect-deps-extra-only.ts:13:9
43+
 11 | useEffect(() => {
44+
 12 | log(x);
45+
> 13 | }, [x, y]);
46+
 | ^ Unnecessary dependency `y`
47+
 14 |
48+
 15 | // error: extra dep - y (missing dep - z not reported)
49+
 16 | useEffect(() => {
50+
51+
Inferred dependencies: `[x]`
52+
53+
Error: Found extra effect dependencies
54+
55+
Extra dependencies can cause an effect to fire more often than it should, resulting in performance problems such as excessive renders and side effects.
56+
57+
error.invalid-exhaustive-effect-deps-extra-only.ts:18:9
58+
 16 | useEffect(() => {
59+
 17 | log(x, z);
60+
> 18 | }, [x, y]);
61+
 | ^ Unnecessary dependency `y`
62+
 19 |
63+
 20 | // error: extra dep - x.y
64+
 21 | useEffect(() => {
65+
66+
Inferred dependencies: `[x, z]`
67+
68+
Error: Found extra effect dependencies
69+
70+
Extra dependencies can cause an effect to fire more often than it should, resulting in performance problems such as excessive renders and side effects.
71+
72+
error.invalid-exhaustive-effect-deps-extra-only.ts:23:6
73+
 21 | useEffect(() => {
74+
 22 | log(x);
75+
> 23 | }, [x.y]);
76+
 | ^^^ Overly precise dependency `x.y`, use `x` instead
77+
 24 | }
78+
 25 |
79+
80+
Inferred dependencies: `[x]`
81+
```
82+
83+
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps-extra-only.js‎
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
// @validateExhaustiveEffectDependencies:"extra-only"
2+
import{useEffect}from'react';
3+
4+
functionComponent({x, y, z}){
5+
// no error: missing dep not reported in extra-only mode
6+
useEffect(()=>{
7+
log(x);
8+
},[]);
9+
10+
// error: extra dep - y
11+
useEffect(()=>{
12+
log(x);
13+
},[x,y]);
14+
15+
// error: extra dep - y (missing dep - z not reported)
16+
useEffect(()=>{
17+
log(x,z);
18+
},[x,y]);
19+
20+
// error: extra dep - x.y
21+
useEffect(()=>{
22+
log(x);
23+
},[x.y]);
24+
}
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps-missing-only.expect.md‎
Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
2+
## Input
3+
4+
```javascript
5+
// @validateExhaustiveEffectDependencies:"missing-only"
6+
import {useEffect} from'react';
7+
8+
functionComponent({x, y, z}) {
9+
// error: missing dep - x
10+
useEffect(() => {
11+
log(x);
12+
 }, []);
13+
14+
// no error: extra dep not reported in missing-only mode
15+
useEffect(() => {
16+
log(x);
17+
 }, [x, y]);
18+
19+
// error: missing dep - z (extra dep - y not reported)
20+
useEffect(() => {
21+
log(x, z);
22+
 }, [x, y]);
23+
24+
// error: missing dep x
25+
useEffect(() => {
26+
log(x);
27+
 }, [x.y]);
28+
}
29+
30+
```
31+
32+
33+
## Error
34+
35+
```
36+
Found 3 errors:
37+
38+
Error: Found missing effect dependencies
39+
40+
Missing dependencies can cause an effect to fire less often than it should.
41+
42+
error.invalid-exhaustive-effect-deps-missing-only.ts:7:8
43+
 5 | // error: missing dep - x
44+
 6 | useEffect(() => {
45+
> 7 | log(x);
46+
 | ^ Missing dependency `x`
47+
 8 | }, []);
48+
 9 |
49+
 10 | // no error: extra dep not reported in missing-only mode
50+
51+
Inferred dependencies: `[x]`
52+
53+
Error: Found missing effect dependencies
54+
55+
Missing dependencies can cause an effect to fire less often than it should.
56+
57+
error.invalid-exhaustive-effect-deps-missing-only.ts:17:11
58+
 15 | // error: missing dep - z (extra dep - y not reported)
59+
 16 | useEffect(() => {
60+
> 17 | log(x, z);
61+
 | ^ Missing dependency `z`
62+
 18 | }, [x, y]);
63+
 19 |
64+
 20 | // error: missing dep x
65+
66+
Inferred dependencies: `[x, z]`
67+
68+
Error: Found missing effect dependencies
69+
70+
Missing dependencies can cause an effect to fire less often than it should.
71+
72+
error.invalid-exhaustive-effect-deps-missing-only.ts:22:8
73+
 20 | // error: missing dep x
74+
 21 | useEffect(() => {
75+
> 22 | log(x);
76+
 | ^ Missing dependency `x`
77+
 23 | }, [x.y]);
78+
 24 | }
79+
 25 |
80+
81+
Inferred dependencies: `[x]`
82+
```
83+
84+
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps-missing-only.js‎
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
// @validateExhaustiveEffectDependencies:"missing-only"
2+
import{useEffect}from'react';
3+
4+
functionComponent({x, y, z}){
5+
// error: missing dep - x
6+
useEffect(()=>{
7+
log(x);
8+
},[]);
9+
10+
// no error: extra dep not reported in missing-only mode
11+
useEffect(()=>{
12+
log(x);
13+
},[x,y]);
14+
15+
// error: missing dep - z (extra dep - y not reported)
16+
useEffect(()=>{
17+
log(x,z);
18+
},[x,y]);
19+
20+
// error: missing dep x
21+
useEffect(()=>{
22+
log(x);
23+
},[x.y]);
24+
}
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps.expect.md‎
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
## Input
33

44
```javascript
5-
// @validateExhaustiveEffectDependencies
5+
// @validateExhaustiveEffectDependencies:"all"
66
import {useEffect} from'react';
77

88
functionComponent({x, y, z}) {
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps.js‎
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// @validateExhaustiveEffectDependencies
1+
// @validateExhaustiveEffectDependencies:"all"
22
import{useEffect}from'react';
33

44
functionComponent({x, y, z}){
0 commit comments
Comments
 (0)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Commit 88ee1f5
Browse files
jackpopejackpope
authored
Add reporting modes for react-hooks/exhaustive-effect-dependencies and temporarily enable (#35365)
`react-hooks/exhaustive-effect-dependencies` from
`ValidateExhaustiveDeps` reports errors for both missing and extra
effect deps. We already have `react-hooks/exhaustive-deps` that errors
on missing dependencies. In the future we'd like to consolidate this all
to the compiler based error, but for now there's a lot of overlap. Let's
enable testing the extra dep warning by splitting out reporting modes.
This PR
- Creates `on`, `off`, `missing-only`, and `extra-only` reporting modes
for the effect dep validation flag
- Temporarily enables the new rule with `extra-only` in
`eslint-plugin-react-hooks`
- Adds additional null checking to `manualMemoLoc` to fix a bug found
when running against the fixture
1 parent bcf97c7 commit 88ee1f5
17 files changed
Lines changed: 293 additions & 22 deletions
‎compiler/packages/babel-plugin-react-compiler/src/HIR/Environment.ts‎
Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,8 +225,15 @@ export const EnvironmentConfigSchema = z.object({
225225

226226
/**
227227
 * Validate that dependencies supplied to effect hooks are exhaustive.
228+
 * Can be:
229+
 * - 'off': No validation (default)
230+
 * - 'all': Validate and report both missing and extra dependencies
231+
 * - 'missing-only': Only report missing dependencies
232+
 * - 'extra-only': Only report extra/unnecessary dependencies
228233
 */
229-
validateExhaustiveEffectDependencies: z.boolean().default(false),
234+
validateExhaustiveEffectDependencies: z
235+
.enum(['off','all','missing-only','extra-only'])
236+
.default('off'),
230237

231238
/**
232239
 * When this is true, rather than pruning existing manual memoization but ensuring or validating
‎compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateExhaustiveDependencies.ts‎
Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,7 @@ export function validateExhaustiveDependencies(
141141
reactive,
142142
startMemo.depsLoc,
143143
ErrorCategory.MemoDependencies,
144+
'all',
144145
);
145146
if(diagnostic!=null){
146147
error.pushDiagnostic(diagnostic);
@@ -159,7 +160,7 @@ export function validateExhaustiveDependencies(
159160
 onStartMemoize,
160161
 onFinishMemoize,
161162
onEffect: (inferred,manual,manualMemoLoc)=>{
162-
if(env.config.validateExhaustiveEffectDependencies===false){
163+
if(env.config.validateExhaustiveEffectDependencies==='off'){
163164
return;
164165
}
165166
if(DEBUG){
@@ -195,12 +196,17 @@ export function validateExhaustiveDependencies(
195196
});
196197
}
197198
}
199+
consteffectReportMode=
200+
typeofenv.config.validateExhaustiveEffectDependencies==='string'
201+
 ? env.config.validateExhaustiveEffectDependencies
202+
 : 'all';
198203
constdiagnostic=validateDependencies(
199204
Array.from(inferred),
200205
manualDeps,
201206
reactive,
202207
manualMemoLoc,
203208
ErrorCategory.EffectExhaustiveDependencies,
209+
effectReportMode,
204210
);
205211
if(diagnostic!=null){
206212
error.pushDiagnostic(diagnostic);
@@ -220,6 +226,7 @@ function validateDependencies(
220226
category:
221227
|ErrorCategory.MemoDependencies
222228
|ErrorCategory.EffectExhaustiveDependencies,
229+
exhaustiveDepsReportMode: 'all'|'missing-only'|'extra-only',
223230
): CompilerDiagnostic|null{
224231
// Sort dependencies by name and path, with shorter/non-optional paths first
225232
inferred.sort((a,b)=>{
@@ -370,9 +377,20 @@ function validateDependencies(
370377
extra.push(dep);
371378
}
372379

373-
if(missing.length!==0||extra.length!==0){
380+
// Filter based on report mode
381+
constfilteredMissing=
382+
exhaustiveDepsReportMode==='extra-only' ? [] : missing;
383+
constfilteredExtra=
384+
exhaustiveDepsReportMode==='missing-only' ? [] : extra;
385+
386+
if(filteredMissing.length!==0||filteredExtra.length!==0){
374387
letsuggestion: CompilerSuggestion|null=null;
375-
if(manualMemoLoc!=null&&typeofmanualMemoLoc!=='symbol'){
388+
if(
389+
manualMemoLoc!=null&&
390+
typeofmanualMemoLoc!=='symbol'&&
391+
manualMemoLoc.start.index!=null&&
392+
manualMemoLoc.end.index!=null
393+
){
376394
suggestion={
377395
description: 'Update dependencies',
378396
range: [manualMemoLoc.start.index,manualMemoLoc.end.index],
@@ -388,8 +406,13 @@ function validateDependencies(
388406
.join(', ')}]`,
389407
};
390408
}
391-
constdiagnostic=createDiagnostic(category,missing,extra,suggestion);
392-
for(constdepofmissing){
409+
constdiagnostic=createDiagnostic(
410+
category,
411+
filteredMissing,
412+
filteredExtra,
413+
suggestion,
414+
);
415+
for(constdepoffilteredMissing){
393416
letreactiveStableValueHint='';
394417
if(isStableType(dep.identifier)){
395418
reactiveStableValueHint=
@@ -402,7 +425,7 @@ function validateDependencies(
402425
loc: dep.loc,
403426
});
404427
}
405-
for(constdepofextra){
428+
for(constdepoffilteredExtra){
406429
if(dep.root.kind==='Global'){
407430
diagnostic.withDetails({
408431
kind: 'error',
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.exhaustive-deps-effect-events.expect.md‎
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
## Input
33

44
```javascript
5-
// @validateExhaustiveEffectDependencies
5+
// @validateExhaustiveEffectDependencies:"all"
66
import {useEffect, useEffectEvent} from'react';
77

88
functionComponent({x, y, z}) {
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.exhaustive-deps-effect-events.js‎
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// @validateExhaustiveEffectDependencies
1+
// @validateExhaustiveEffectDependencies:"all"
22
import{useEffect,useEffectEvent}from'react';
33

44
functionComponent({x, y, z}){
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps-extra-only.expect.md‎
Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
2+
## Input
3+
4+
```javascript
5+
// @validateExhaustiveEffectDependencies:"extra-only"
6+
import {useEffect} from'react';
7+
8+
functionComponent({x, y, z}) {
9+
// no error: missing dep not reported in extra-only mode
10+
useEffect(() => {
11+
log(x);
12+
 }, []);
13+
14+
// error: extra dep - y
15+
useEffect(() => {
16+
log(x);
17+
 }, [x, y]);
18+
19+
// error: extra dep - y (missing dep - z not reported)
20+
useEffect(() => {
21+
log(x, z);
22+
 }, [x, y]);
23+
24+
// error: extra dep - x.y
25+
useEffect(() => {
26+
log(x);
27+
 }, [x.y]);
28+
}
29+
30+
```
31+
32+
33+
## Error
34+
35+
```
36+
Found 3 errors:
37+
38+
Error: Found extra effect dependencies
39+
40+
Extra dependencies can cause an effect to fire more often than it should, resulting in performance problems such as excessive renders and side effects.
41+
42+
error.invalid-exhaustive-effect-deps-extra-only.ts:13:9
43+
 11 | useEffect(() => {
44+
 12 | log(x);
45+
> 13 | }, [x, y]);
46+
 | ^ Unnecessary dependency `y`
47+
 14 |
48+
 15 | // error: extra dep - y (missing dep - z not reported)
49+
 16 | useEffect(() => {
50+
51+
Inferred dependencies: `[x]`
52+
53+
Error: Found extra effect dependencies
54+
55+
Extra dependencies can cause an effect to fire more often than it should, resulting in performance problems such as excessive renders and side effects.
56+
57+
error.invalid-exhaustive-effect-deps-extra-only.ts:18:9
58+
 16 | useEffect(() => {
59+
 17 | log(x, z);
60+
> 18 | }, [x, y]);
61+
 | ^ Unnecessary dependency `y`
62+
 19 |
63+
 20 | // error: extra dep - x.y
64+
 21 | useEffect(() => {
65+
66+
Inferred dependencies: `[x, z]`
67+
68+
Error: Found extra effect dependencies
69+
70+
Extra dependencies can cause an effect to fire more often than it should, resulting in performance problems such as excessive renders and side effects.
71+
72+
error.invalid-exhaustive-effect-deps-extra-only.ts:23:6
73+
 21 | useEffect(() => {
74+
 22 | log(x);
75+
> 23 | }, [x.y]);
76+
 | ^^^ Overly precise dependency `x.y`, use `x` instead
77+
 24 | }
78+
 25 |
79+
80+
Inferred dependencies: `[x]`
81+
```
82+
83+
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps-extra-only.js‎
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
// @validateExhaustiveEffectDependencies:"extra-only"
2+
import{useEffect}from'react';
3+
4+
functionComponent({x, y, z}){
5+
// no error: missing dep not reported in extra-only mode
6+
useEffect(()=>{
7+
log(x);
8+
},[]);
9+
10+
// error: extra dep - y
11+
useEffect(()=>{
12+
log(x);
13+
},[x,y]);
14+
15+
// error: extra dep - y (missing dep - z not reported)
16+
useEffect(()=>{
17+
log(x,z);
18+
},[x,y]);
19+
20+
// error: extra dep - x.y
21+
useEffect(()=>{
22+
log(x);
23+
},[x.y]);
24+
}
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps-missing-only.expect.md‎
Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
2+
## Input
3+
4+
```javascript
5+
// @validateExhaustiveEffectDependencies:"missing-only"
6+
import {useEffect} from'react';
7+
8+
functionComponent({x, y, z}) {
9+
// error: missing dep - x
10+
useEffect(() => {
11+
log(x);
12+
 }, []);
13+
14+
// no error: extra dep not reported in missing-only mode
15+
useEffect(() => {
16+
log(x);
17+
 }, [x, y]);
18+
19+
// error: missing dep - z (extra dep - y not reported)
20+
useEffect(() => {
21+
log(x, z);
22+
 }, [x, y]);
23+
24+
// error: missing dep x
25+
useEffect(() => {
26+
log(x);
27+
 }, [x.y]);
28+
}
29+
30+
```
31+
32+
33+
## Error
34+
35+
```
36+
Found 3 errors:
37+
38+
Error: Found missing effect dependencies
39+
40+
Missing dependencies can cause an effect to fire less often than it should.
41+
42+
error.invalid-exhaustive-effect-deps-missing-only.ts:7:8
43+
 5 | // error: missing dep - x
44+
 6 | useEffect(() => {
45+
> 7 | log(x);
46+
 | ^ Missing dependency `x`
47+
 8 | }, []);
48+
 9 |
49+
 10 | // no error: extra dep not reported in missing-only mode
50+
51+
Inferred dependencies: `[x]`
52+
53+
Error: Found missing effect dependencies
54+
55+
Missing dependencies can cause an effect to fire less often than it should.
56+
57+
error.invalid-exhaustive-effect-deps-missing-only.ts:17:11
58+
 15 | // error: missing dep - z (extra dep - y not reported)
59+
 16 | useEffect(() => {
60+
> 17 | log(x, z);
61+
 | ^ Missing dependency `z`
62+
 18 | }, [x, y]);
63+
 19 |
64+
 20 | // error: missing dep x
65+
66+
Inferred dependencies: `[x, z]`
67+
68+
Error: Found missing effect dependencies
69+
70+
Missing dependencies can cause an effect to fire less often than it should.
71+
72+
error.invalid-exhaustive-effect-deps-missing-only.ts:22:8
73+
 20 | // error: missing dep x
74+
 21 | useEffect(() => {
75+
> 22 | log(x);
76+
 | ^ Missing dependency `x`
77+
 23 | }, [x.y]);
78+
 24 | }
79+
 25 |
80+
81+
Inferred dependencies: `[x]`
82+
```
83+
84+
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps-missing-only.js‎
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
// @validateExhaustiveEffectDependencies:"missing-only"
2+
import{useEffect}from'react';
3+
4+
functionComponent({x, y, z}){
5+
// error: missing dep - x
6+
useEffect(()=>{
7+
log(x);
8+
},[]);
9+
10+
// no error: extra dep not reported in missing-only mode
11+
useEffect(()=>{
12+
log(x);
13+
},[x,y]);
14+
15+
// error: missing dep - z (extra dep - y not reported)
16+
useEffect(()=>{
17+
log(x,z);
18+
},[x,y]);
19+
20+
// error: missing dep x
21+
useEffect(()=>{
22+
log(x);
23+
},[x.y]);
24+
}
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps.expect.md‎
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
## Input
33

44
```javascript
5-
// @validateExhaustiveEffectDependencies
5+
// @validateExhaustiveEffectDependencies:"all"
66
import {useEffect} from'react';
77

88
functionComponent({x, y, z}) {
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps.js‎
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// @validateExhaustiveEffectDependencies
1+
// @validateExhaustiveEffectDependencies:"all"
22
import{useEffect}from'react';
33

44
functionComponent({x, y, z}){
0 commit comments
Comments
 (0)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Commit 88ee1f5
Browse files
jackpopejackpope
authored
Add reporting modes for react-hooks/exhaustive-effect-dependencies and temporarily enable (#35365)
`react-hooks/exhaustive-effect-dependencies` from
`ValidateExhaustiveDeps` reports errors for both missing and extra
effect deps. We already have `react-hooks/exhaustive-deps` that errors
on missing dependencies. In the future we'd like to consolidate this all
to the compiler based error, but for now there's a lot of overlap. Let's
enable testing the extra dep warning by splitting out reporting modes.
This PR
- Creates `on`, `off`, `missing-only`, and `extra-only` reporting modes
for the effect dep validation flag
- Temporarily enables the new rule with `extra-only` in
`eslint-plugin-react-hooks`
- Adds additional null checking to `manualMemoLoc` to fix a bug found
when running against the fixture
1 parent bcf97c7 commit 88ee1f5
17 files changed
Lines changed: 293 additions & 22 deletions
‎compiler/packages/babel-plugin-react-compiler/src/HIR/Environment.ts‎
Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,8 +225,15 @@ export const EnvironmentConfigSchema = z.object({
225225

226226
/**
227227
 * Validate that dependencies supplied to effect hooks are exhaustive.
228+
 * Can be:
229+
 * - 'off': No validation (default)
230+
 * - 'all': Validate and report both missing and extra dependencies
231+
 * - 'missing-only': Only report missing dependencies
232+
 * - 'extra-only': Only report extra/unnecessary dependencies
228233
 */
229-
validateExhaustiveEffectDependencies: z.boolean().default(false),
234+
validateExhaustiveEffectDependencies: z
235+
.enum(['off','all','missing-only','extra-only'])
236+
.default('off'),
230237

231238
/**
232239
 * When this is true, rather than pruning existing manual memoization but ensuring or validating
‎compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateExhaustiveDependencies.ts‎
Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,7 @@ export function validateExhaustiveDependencies(
141141
reactive,
142142
startMemo.depsLoc,
143143
ErrorCategory.MemoDependencies,
144+
'all',
144145
);
145146
if(diagnostic!=null){
146147
error.pushDiagnostic(diagnostic);
@@ -159,7 +160,7 @@ export function validateExhaustiveDependencies(
159160
 onStartMemoize,
160161
 onFinishMemoize,
161162
onEffect: (inferred,manual,manualMemoLoc)=>{
162-
if(env.config.validateExhaustiveEffectDependencies===false){
163+
if(env.config.validateExhaustiveEffectDependencies==='off'){
163164
return;
164165
}
165166
if(DEBUG){
@@ -195,12 +196,17 @@ export function validateExhaustiveDependencies(
195196
});
196197
}
197198
}
199+
consteffectReportMode=
200+
typeofenv.config.validateExhaustiveEffectDependencies==='string'
201+
 ? env.config.validateExhaustiveEffectDependencies
202+
 : 'all';
198203
constdiagnostic=validateDependencies(
199204
Array.from(inferred),
200205
manualDeps,
201206
reactive,
202207
manualMemoLoc,
203208
ErrorCategory.EffectExhaustiveDependencies,
209+
effectReportMode,
204210
);
205211
if(diagnostic!=null){
206212
error.pushDiagnostic(diagnostic);
@@ -220,6 +226,7 @@ function validateDependencies(
220226
category:
221227
|ErrorCategory.MemoDependencies
222228
|ErrorCategory.EffectExhaustiveDependencies,
229+
exhaustiveDepsReportMode: 'all'|'missing-only'|'extra-only',
223230
): CompilerDiagnostic|null{
224231
// Sort dependencies by name and path, with shorter/non-optional paths first
225232
inferred.sort((a,b)=>{
@@ -370,9 +377,20 @@ function validateDependencies(
370377
extra.push(dep);
371378
}
372379

373-
if(missing.length!==0||extra.length!==0){
380+
// Filter based on report mode
381+
constfilteredMissing=
382+
exhaustiveDepsReportMode==='extra-only' ? [] : missing;
383+
constfilteredExtra=
384+
exhaustiveDepsReportMode==='missing-only' ? [] : extra;
385+
386+
if(filteredMissing.length!==0||filteredExtra.length!==0){
374387
letsuggestion: CompilerSuggestion|null=null;
375-
if(manualMemoLoc!=null&&typeofmanualMemoLoc!=='symbol'){
388+
if(
389+
manualMemoLoc!=null&&
390+
typeofmanualMemoLoc!=='symbol'&&
391+
manualMemoLoc.start.index!=null&&
392+
manualMemoLoc.end.index!=null
393+
){
376394
suggestion={
377395
description: 'Update dependencies',
378396
range: [manualMemoLoc.start.index,manualMemoLoc.end.index],
@@ -388,8 +406,13 @@ function validateDependencies(
388406
.join(', ')}]`,
389407
};
390408
}
391-
constdiagnostic=createDiagnostic(category,missing,extra,suggestion);
392-
for(constdepofmissing){
409+
constdiagnostic=createDiagnostic(
410+
category,
411+
filteredMissing,
412+
filteredExtra,
413+
suggestion,
414+
);
415+
for(constdepoffilteredMissing){
393416
letreactiveStableValueHint='';
394417
if(isStableType(dep.identifier)){
395418
reactiveStableValueHint=
@@ -402,7 +425,7 @@ function validateDependencies(
402425
loc: dep.loc,
403426
});
404427
}
405-
for(constdepofextra){
428+
for(constdepoffilteredExtra){
406429
if(dep.root.kind==='Global'){
407430
diagnostic.withDetails({
408431
kind: 'error',
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.exhaustive-deps-effect-events.expect.md‎
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
## Input
33

44
```javascript
5-
// @validateExhaustiveEffectDependencies
5+
// @validateExhaustiveEffectDependencies:"all"
66
import {useEffect, useEffectEvent} from'react';
77

88
functionComponent({x, y, z}) {
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.exhaustive-deps-effect-events.js‎
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// @validateExhaustiveEffectDependencies
1+
// @validateExhaustiveEffectDependencies:"all"
22
import{useEffect,useEffectEvent}from'react';
33

44
functionComponent({x, y, z}){
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps-extra-only.expect.md‎
Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
2+
## Input
3+
4+
```javascript
5+
// @validateExhaustiveEffectDependencies:"extra-only"
6+
import {useEffect} from'react';
7+
8+
functionComponent({x, y, z}) {
9+
// no error: missing dep not reported in extra-only mode
10+
useEffect(() => {
11+
log(x);
12+
 }, []);
13+
14+
// error: extra dep - y
15+
useEffect(() => {
16+
log(x);
17+
 }, [x, y]);
18+
19+
// error: extra dep - y (missing dep - z not reported)
20+
useEffect(() => {
21+
log(x, z);
22+
 }, [x, y]);
23+
24+
// error: extra dep - x.y
25+
useEffect(() => {
26+
log(x);
27+
 }, [x.y]);
28+
}
29+
30+
```
31+
32+
33+
## Error
34+
35+
```
36+
Found 3 errors:
37+
38+
Error: Found extra effect dependencies
39+
40+
Extra dependencies can cause an effect to fire more often than it should, resulting in performance problems such as excessive renders and side effects.
41+
42+
error.invalid-exhaustive-effect-deps-extra-only.ts:13:9
43+
 11 | useEffect(() => {
44+
 12 | log(x);
45+
> 13 | }, [x, y]);
46+
 | ^ Unnecessary dependency `y`
47+
 14 |
48+
 15 | // error: extra dep - y (missing dep - z not reported)
49+
 16 | useEffect(() => {
50+
51+
Inferred dependencies: `[x]`
52+
53+
Error: Found extra effect dependencies
54+
55+
Extra dependencies can cause an effect to fire more often than it should, resulting in performance problems such as excessive renders and side effects.
56+
57+
error.invalid-exhaustive-effect-deps-extra-only.ts:18:9
58+
 16 | useEffect(() => {
59+
 17 | log(x, z);
60+
> 18 | }, [x, y]);
61+
 | ^ Unnecessary dependency `y`
62+
 19 |
63+
 20 | // error: extra dep - x.y
64+
 21 | useEffect(() => {
65+
66+
Inferred dependencies: `[x, z]`
67+
68+
Error: Found extra effect dependencies
69+
70+
Extra dependencies can cause an effect to fire more often than it should, resulting in performance problems such as excessive renders and side effects.
71+
72+
error.invalid-exhaustive-effect-deps-extra-only.ts:23:6
73+
 21 | useEffect(() => {
74+
 22 | log(x);
75+
> 23 | }, [x.y]);
76+
 | ^^^ Overly precise dependency `x.y`, use `x` instead
77+
 24 | }
78+
 25 |
79+
80+
Inferred dependencies: `[x]`
81+
```
82+
83+
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps-extra-only.js‎
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
// @validateExhaustiveEffectDependencies:"extra-only"
2+
import{useEffect}from'react';
3+
4+
functionComponent({x, y, z}){
5+
// no error: missing dep not reported in extra-only mode
6+
useEffect(()=>{
7+
log(x);
8+
},[]);
9+
10+
// error: extra dep - y
11+
useEffect(()=>{
12+
log(x);
13+
},[x,y]);
14+
15+
// error: extra dep - y (missing dep - z not reported)
16+
useEffect(()=>{
17+
log(x,z);
18+
},[x,y]);
19+
20+
// error: extra dep - x.y
21+
useEffect(()=>{
22+
log(x);
23+
},[x.y]);
24+
}
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps-missing-only.expect.md‎
Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
2+
## Input
3+
4+
```javascript
5+
// @validateExhaustiveEffectDependencies:"missing-only"
6+
import {useEffect} from'react';
7+
8+
functionComponent({x, y, z}) {
9+
// error: missing dep - x
10+
useEffect(() => {
11+
log(x);
12+
 }, []);
13+
14+
// no error: extra dep not reported in missing-only mode
15+
useEffect(() => {
16+
log(x);
17+
 }, [x, y]);
18+
19+
// error: missing dep - z (extra dep - y not reported)
20+
useEffect(() => {
21+
log(x, z);
22+
 }, [x, y]);
23+
24+
// error: missing dep x
25+
useEffect(() => {
26+
log(x);
27+
 }, [x.y]);
28+
}
29+
30+
```
31+
32+
33+
## Error
34+
35+
```
36+
Found 3 errors:
37+
38+
Error: Found missing effect dependencies
39+
40+
Missing dependencies can cause an effect to fire less often than it should.
41+
42+
error.invalid-exhaustive-effect-deps-missing-only.ts:7:8
43+
 5 | // error: missing dep - x
44+
 6 | useEffect(() => {
45+
> 7 | log(x);
46+
 | ^ Missing dependency `x`
47+
 8 | }, []);
48+
 9 |
49+
 10 | // no error: extra dep not reported in missing-only mode
50+
51+
Inferred dependencies: `[x]`
52+
53+
Error: Found missing effect dependencies
54+
55+
Missing dependencies can cause an effect to fire less often than it should.
56+
57+
error.invalid-exhaustive-effect-deps-missing-only.ts:17:11
58+
 15 | // error: missing dep - z (extra dep - y not reported)
59+
 16 | useEffect(() => {
60+
> 17 | log(x, z);
61+
 | ^ Missing dependency `z`
62+
 18 | }, [x, y]);
63+
 19 |
64+
 20 | // error: missing dep x
65+
66+
Inferred dependencies: `[x, z]`
67+
68+
Error: Found missing effect dependencies
69+
70+
Missing dependencies can cause an effect to fire less often than it should.
71+
72+
error.invalid-exhaustive-effect-deps-missing-only.ts:22:8
73+
 20 | // error: missing dep x
74+
 21 | useEffect(() => {
75+
> 22 | log(x);
76+
 | ^ Missing dependency `x`
77+
 23 | }, [x.y]);
78+
 24 | }
79+
 25 |
80+
81+
Inferred dependencies: `[x]`
82+
```
83+
84+
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps-missing-only.js‎
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
// @validateExhaustiveEffectDependencies:"missing-only"
2+
import{useEffect}from'react';
3+
4+
functionComponent({x, y, z}){
5+
// error: missing dep - x
6+
useEffect(()=>{
7+
log(x);
8+
},[]);
9+
10+
// no error: extra dep not reported in missing-only mode
11+
useEffect(()=>{
12+
log(x);
13+
},[x,y]);
14+
15+
// error: missing dep - z (extra dep - y not reported)
16+
useEffect(()=>{
17+
log(x,z);
18+
},[x,y]);
19+
20+
// error: missing dep x
21+
useEffect(()=>{
22+
log(x);
23+
},[x.y]);
24+
}
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps.expect.md‎
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
## Input
33

44
```javascript
5-
// @validateExhaustiveEffectDependencies
5+
// @validateExhaustiveEffectDependencies:"all"
66
import {useEffect} from'react';
77

88
functionComponent({x, y, z}) {
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps.js‎
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// @validateExhaustiveEffectDependencies
1+
// @validateExhaustiveEffectDependencies:"all"
22
import{useEffect}from'react';
33

44
functionComponent({x, y, z}){
0 commit comments
Comments
 (0)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Commit 88ee1f5
Browse files
jackpopejackpope
authored
Add reporting modes for react-hooks/exhaustive-effect-dependencies and temporarily enable (#35365)
`react-hooks/exhaustive-effect-dependencies` from
`ValidateExhaustiveDeps` reports errors for both missing and extra
effect deps. We already have `react-hooks/exhaustive-deps` that errors
on missing dependencies. In the future we'd like to consolidate this all
to the compiler based error, but for now there's a lot of overlap. Let's
enable testing the extra dep warning by splitting out reporting modes.
This PR
- Creates `on`, `off`, `missing-only`, and `extra-only` reporting modes
for the effect dep validation flag
- Temporarily enables the new rule with `extra-only` in
`eslint-plugin-react-hooks`
- Adds additional null checking to `manualMemoLoc` to fix a bug found
when running against the fixture
1 parent bcf97c7 commit 88ee1f5
17 files changed
Lines changed: 293 additions & 22 deletions
‎compiler/packages/babel-plugin-react-compiler/src/HIR/Environment.ts‎
Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,8 +225,15 @@ export const EnvironmentConfigSchema = z.object({
225225

226226
/**
227227
 * Validate that dependencies supplied to effect hooks are exhaustive.
228+
 * Can be:
229+
 * - 'off': No validation (default)
230+
 * - 'all': Validate and report both missing and extra dependencies
231+
 * - 'missing-only': Only report missing dependencies
232+
 * - 'extra-only': Only report extra/unnecessary dependencies
228233
 */
229-
validateExhaustiveEffectDependencies: z.boolean().default(false),
234+
validateExhaustiveEffectDependencies: z
235+
.enum(['off','all','missing-only','extra-only'])
236+
.default('off'),
230237

231238
/**
232239
 * When this is true, rather than pruning existing manual memoization but ensuring or validating
‎compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateExhaustiveDependencies.ts‎
Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,7 @@ export function validateExhaustiveDependencies(
141141
reactive,
142142
startMemo.depsLoc,
143143
ErrorCategory.MemoDependencies,
144+
'all',
144145
);
145146
if(diagnostic!=null){
146147
error.pushDiagnostic(diagnostic);
@@ -159,7 +160,7 @@ export function validateExhaustiveDependencies(
159160
 onStartMemoize,
160161
 onFinishMemoize,
161162
onEffect: (inferred,manual,manualMemoLoc)=>{
162-
if(env.config.validateExhaustiveEffectDependencies===false){
163+
if(env.config.validateExhaustiveEffectDependencies==='off'){
163164
return;
164165
}
165166
if(DEBUG){
@@ -195,12 +196,17 @@ export function validateExhaustiveDependencies(
195196
});
196197
}
197198
}
199+
consteffectReportMode=
200+
typeofenv.config.validateExhaustiveEffectDependencies==='string'
201+
 ? env.config.validateExhaustiveEffectDependencies
202+
 : 'all';
198203
constdiagnostic=validateDependencies(
199204
Array.from(inferred),
200205
manualDeps,
201206
reactive,
202207
manualMemoLoc,
203208
ErrorCategory.EffectExhaustiveDependencies,
209+
effectReportMode,
204210
);
205211
if(diagnostic!=null){
206212
error.pushDiagnostic(diagnostic);
@@ -220,6 +226,7 @@ function validateDependencies(
220226
category:
221227
|ErrorCategory.MemoDependencies
222228
|ErrorCategory.EffectExhaustiveDependencies,
229+
exhaustiveDepsReportMode: 'all'|'missing-only'|'extra-only',
223230
): CompilerDiagnostic|null{
224231
// Sort dependencies by name and path, with shorter/non-optional paths first
225232
inferred.sort((a,b)=>{
@@ -370,9 +377,20 @@ function validateDependencies(
370377
extra.push(dep);
371378
}
372379

373-
if(missing.length!==0||extra.length!==0){
380+
// Filter based on report mode
381+
constfilteredMissing=
382+
exhaustiveDepsReportMode==='extra-only' ? [] : missing;
383+
constfilteredExtra=
384+
exhaustiveDepsReportMode==='missing-only' ? [] : extra;
385+
386+
if(filteredMissing.length!==0||filteredExtra.length!==0){
374387
letsuggestion: CompilerSuggestion|null=null;
375-
if(manualMemoLoc!=null&&typeofmanualMemoLoc!=='symbol'){
388+
if(
389+
manualMemoLoc!=null&&
390+
typeofmanualMemoLoc!=='symbol'&&
391+
manualMemoLoc.start.index!=null&&
392+
manualMemoLoc.end.index!=null
393+
){
376394
suggestion={
377395
description: 'Update dependencies',
378396
range: [manualMemoLoc.start.index,manualMemoLoc.end.index],
@@ -388,8 +406,13 @@ function validateDependencies(
388406
.join(', ')}]`,
389407
};
390408
}
391-
constdiagnostic=createDiagnostic(category,missing,extra,suggestion);
392-
for(constdepofmissing){
409+
constdiagnostic=createDiagnostic(
410+
category,
411+
filteredMissing,
412+
filteredExtra,
413+
suggestion,
414+
);
415+
for(constdepoffilteredMissing){
393416
letreactiveStableValueHint='';
394417
if(isStableType(dep.identifier)){
395418
reactiveStableValueHint=
@@ -402,7 +425,7 @@ function validateDependencies(
402425
loc: dep.loc,
403426
});
404427
}
405-
for(constdepofextra){
428+
for(constdepoffilteredExtra){
406429
if(dep.root.kind==='Global'){
407430
diagnostic.withDetails({
408431
kind: 'error',
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.exhaustive-deps-effect-events.expect.md‎
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
## Input
33

44
```javascript
5-
// @validateExhaustiveEffectDependencies
5+
// @validateExhaustiveEffectDependencies:"all"
66
import {useEffect, useEffectEvent} from'react';
77

88
functionComponent({x, y, z}) {
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.exhaustive-deps-effect-events.js‎
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// @validateExhaustiveEffectDependencies
1+
// @validateExhaustiveEffectDependencies:"all"
22
import{useEffect,useEffectEvent}from'react';
33

44
functionComponent({x, y, z}){
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps-extra-only.expect.md‎
Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
2+
## Input
3+
4+
```javascript
5+
// @validateExhaustiveEffectDependencies:"extra-only"
6+
import {useEffect} from'react';
7+
8+
functionComponent({x, y, z}) {
9+
// no error: missing dep not reported in extra-only mode
10+
useEffect(() => {
11+
log(x);
12+
 }, []);
13+
14+
// error: extra dep - y
15+
useEffect(() => {
16+
log(x);
17+
 }, [x, y]);
18+
19+
// error: extra dep - y (missing dep - z not reported)
20+
useEffect(() => {
21+
log(x, z);
22+
 }, [x, y]);
23+
24+
// error: extra dep - x.y
25+
useEffect(() => {
26+
log(x);
27+
 }, [x.y]);
28+
}
29+
30+
```
31+
32+
33+
## Error
34+
35+
```
36+
Found 3 errors:
37+
38+
Error: Found extra effect dependencies
39+
40+
Extra dependencies can cause an effect to fire more often than it should, resulting in performance problems such as excessive renders and side effects.
41+
42+
error.invalid-exhaustive-effect-deps-extra-only.ts:13:9
43+
 11 | useEffect(() => {
44+
 12 | log(x);
45+
> 13 | }, [x, y]);
46+
 | ^ Unnecessary dependency `y`
47+
 14 |
48+
 15 | // error: extra dep - y (missing dep - z not reported)
49+
 16 | useEffect(() => {
50+
51+
Inferred dependencies: `[x]`
52+
53+
Error: Found extra effect dependencies
54+
55+
Extra dependencies can cause an effect to fire more often than it should, resulting in performance problems such as excessive renders and side effects.
56+
57+
error.invalid-exhaustive-effect-deps-extra-only.ts:18:9
58+
 16 | useEffect(() => {
59+
 17 | log(x, z);
60+
> 18 | }, [x, y]);
61+
 | ^ Unnecessary dependency `y`
62+
 19 |
63+
 20 | // error: extra dep - x.y
64+
 21 | useEffect(() => {
65+
66+
Inferred dependencies: `[x, z]`
67+
68+
Error: Found extra effect dependencies
69+
70+
Extra dependencies can cause an effect to fire more often than it should, resulting in performance problems such as excessive renders and side effects.
71+
72+
error.invalid-exhaustive-effect-deps-extra-only.ts:23:6
73+
 21 | useEffect(() => {
74+
 22 | log(x);
75+
> 23 | }, [x.y]);
76+
 | ^^^ Overly precise dependency `x.y`, use `x` instead
77+
 24 | }
78+
 25 |
79+
80+
Inferred dependencies: `[x]`
81+
```
82+
83+
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps-extra-only.js‎
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
// @validateExhaustiveEffectDependencies:"extra-only"
2+
import{useEffect}from'react';
3+
4+
functionComponent({x, y, z}){
5+
// no error: missing dep not reported in extra-only mode
6+
useEffect(()=>{
7+
log(x);
8+
},[]);
9+
10+
// error: extra dep - y
11+
useEffect(()=>{
12+
log(x);
13+
},[x,y]);
14+
15+
// error: extra dep - y (missing dep - z not reported)
16+
useEffect(()=>{
17+
log(x,z);
18+
},[x,y]);
19+
20+
// error: extra dep - x.y
21+
useEffect(()=>{
22+
log(x);
23+
},[x.y]);
24+
}
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps-missing-only.expect.md‎
Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
2+
## Input
3+
4+
```javascript
5+
// @validateExhaustiveEffectDependencies:"missing-only"
6+
import {useEffect} from'react';
7+
8+
functionComponent({x, y, z}) {
9+
// error: missing dep - x
10+
useEffect(() => {
11+
log(x);
12+
 }, []);
13+
14+
// no error: extra dep not reported in missing-only mode
15+
useEffect(() => {
16+
log(x);
17+
 }, [x, y]);
18+
19+
// error: missing dep - z (extra dep - y not reported)
20+
useEffect(() => {
21+
log(x, z);
22+
 }, [x, y]);
23+
24+
// error: missing dep x
25+
useEffect(() => {
26+
log(x);
27+
 }, [x.y]);
28+
}
29+
30+
```
31+
32+
33+
## Error
34+
35+
```
36+
Found 3 errors:
37+
38+
Error: Found missing effect dependencies
39+
40+
Missing dependencies can cause an effect to fire less often than it should.
41+
42+
error.invalid-exhaustive-effect-deps-missing-only.ts:7:8
43+
 5 | // error: missing dep - x
44+
 6 | useEffect(() => {
45+
> 7 | log(x);
46+
 | ^ Missing dependency `x`
47+
 8 | }, []);
48+
 9 |
49+
 10 | // no error: extra dep not reported in missing-only mode
50+
51+
Inferred dependencies: `[x]`
52+
53+
Error: Found missing effect dependencies
54+
55+
Missing dependencies can cause an effect to fire less often than it should.
56+
57+
error.invalid-exhaustive-effect-deps-missing-only.ts:17:11
58+
 15 | // error: missing dep - z (extra dep - y not reported)
59+
 16 | useEffect(() => {
60+
> 17 | log(x, z);
61+
 | ^ Missing dependency `z`
62+
 18 | }, [x, y]);
63+
 19 |
64+
 20 | // error: missing dep x
65+
66+
Inferred dependencies: `[x, z]`
67+
68+
Error: Found missing effect dependencies
69+
70+
Missing dependencies can cause an effect to fire less often than it should.
71+
72+
error.invalid-exhaustive-effect-deps-missing-only.ts:22:8
73+
 20 | // error: missing dep x
74+
 21 | useEffect(() => {
75+
> 22 | log(x);
76+
 | ^ Missing dependency `x`
77+
 23 | }, [x.y]);
78+
 24 | }
79+
 25 |
80+
81+
Inferred dependencies: `[x]`
82+
```
83+
84+
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps-missing-only.js‎
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
// @validateExhaustiveEffectDependencies:"missing-only"
2+
import{useEffect}from'react';
3+
4+
functionComponent({x, y, z}){
5+
// error: missing dep - x
6+
useEffect(()=>{
7+
log(x);
8+
},[]);
9+
10+
// no error: extra dep not reported in missing-only mode
11+
useEffect(()=>{
12+
log(x);
13+
},[x,y]);
14+
15+
// error: missing dep - z (extra dep - y not reported)
16+
useEffect(()=>{
17+
log(x,z);
18+
},[x,y]);
19+
20+
// error: missing dep x
21+
useEffect(()=>{
22+
log(x);
23+
},[x.y]);
24+
}
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps.expect.md‎
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
## Input
33

44
```javascript
5-
// @validateExhaustiveEffectDependencies
5+
// @validateExhaustiveEffectDependencies:"all"
66
import {useEffect} from'react';
77

88
functionComponent({x, y, z}) {
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps.js‎
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// @validateExhaustiveEffectDependencies
1+
// @validateExhaustiveEffectDependencies:"all"
22
import{useEffect}from'react';
33

44
functionComponent({x, y, z}){
0 commit comments
Comments
 (0)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Commit 88ee1f5
Browse files
jackpopejackpope
authored
Add reporting modes for react-hooks/exhaustive-effect-dependencies and temporarily enable (#35365)
`react-hooks/exhaustive-effect-dependencies` from
`ValidateExhaustiveDeps` reports errors for both missing and extra
effect deps. We already have `react-hooks/exhaustive-deps` that errors
on missing dependencies. In the future we'd like to consolidate this all
to the compiler based error, but for now there's a lot of overlap. Let's
enable testing the extra dep warning by splitting out reporting modes.
This PR
- Creates `on`, `off`, `missing-only`, and `extra-only` reporting modes
for the effect dep validation flag
- Temporarily enables the new rule with `extra-only` in
`eslint-plugin-react-hooks`
- Adds additional null checking to `manualMemoLoc` to fix a bug found
when running against the fixture
1 parent bcf97c7 commit 88ee1f5
17 files changed
Lines changed: 293 additions & 22 deletions
‎compiler/packages/babel-plugin-react-compiler/src/HIR/Environment.ts‎
Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,8 +225,15 @@ export const EnvironmentConfigSchema = z.object({
225225

226226
/**
227227
 * Validate that dependencies supplied to effect hooks are exhaustive.
228+
 * Can be:
229+
 * - 'off': No validation (default)
230+
 * - 'all': Validate and report both missing and extra dependencies
231+
 * - 'missing-only': Only report missing dependencies
232+
 * - 'extra-only': Only report extra/unnecessary dependencies
228233
 */
229-
validateExhaustiveEffectDependencies: z.boolean().default(false),
234+
validateExhaustiveEffectDependencies: z
235+
.enum(['off','all','missing-only','extra-only'])
236+
.default('off'),
230237

231238
/**
232239
 * When this is true, rather than pruning existing manual memoization but ensuring or validating
‎compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateExhaustiveDependencies.ts‎
Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,7 @@ export function validateExhaustiveDependencies(
141141
reactive,
142142
startMemo.depsLoc,
143143
ErrorCategory.MemoDependencies,
144+
'all',
144145
);
145146
if(diagnostic!=null){
146147
error.pushDiagnostic(diagnostic);
@@ -159,7 +160,7 @@ export function validateExhaustiveDependencies(
159160
 onStartMemoize,
160161
 onFinishMemoize,
161162
onEffect: (inferred,manual,manualMemoLoc)=>{
162-
if(env.config.validateExhaustiveEffectDependencies===false){
163+
if(env.config.validateExhaustiveEffectDependencies==='off'){
163164
return;
164165
}
165166
if(DEBUG){
@@ -195,12 +196,17 @@ export function validateExhaustiveDependencies(
195196
});
196197
}
197198
}
199+
consteffectReportMode=
200+
typeofenv.config.validateExhaustiveEffectDependencies==='string'
201+
 ? env.config.validateExhaustiveEffectDependencies
202+
 : 'all';
198203
constdiagnostic=validateDependencies(
199204
Array.from(inferred),
200205
manualDeps,
201206
reactive,
202207
manualMemoLoc,
203208
ErrorCategory.EffectExhaustiveDependencies,
209+
effectReportMode,
204210
);
205211
if(diagnostic!=null){
206212
error.pushDiagnostic(diagnostic);
@@ -220,6 +226,7 @@ function validateDependencies(
220226
category:
221227
|ErrorCategory.MemoDependencies
222228
|ErrorCategory.EffectExhaustiveDependencies,
229+
exhaustiveDepsReportMode: 'all'|'missing-only'|'extra-only',
223230
): CompilerDiagnostic|null{
224231
// Sort dependencies by name and path, with shorter/non-optional paths first
225232
inferred.sort((a,b)=>{
@@ -370,9 +377,20 @@ function validateDependencies(
370377
extra.push(dep);
371378
}
372379

373-
if(missing.length!==0||extra.length!==0){
380+
// Filter based on report mode
381+
constfilteredMissing=
382+
exhaustiveDepsReportMode==='extra-only' ? [] : missing;
383+
constfilteredExtra=
384+
exhaustiveDepsReportMode==='missing-only' ? [] : extra;
385+
386+
if(filteredMissing.length!==0||filteredExtra.length!==0){
374387
letsuggestion: CompilerSuggestion|null=null;
375-
if(manualMemoLoc!=null&&typeofmanualMemoLoc!=='symbol'){
388+
if(
389+
manualMemoLoc!=null&&
390+
typeofmanualMemoLoc!=='symbol'&&
391+
manualMemoLoc.start.index!=null&&
392+
manualMemoLoc.end.index!=null
393+
){
376394
suggestion={
377395
description: 'Update dependencies',
378396
range: [manualMemoLoc.start.index,manualMemoLoc.end.index],
@@ -388,8 +406,13 @@ function validateDependencies(
388406
.join(', ')}]`,
389407
};
390408
}
391-
constdiagnostic=createDiagnostic(category,missing,extra,suggestion);
392-
for(constdepofmissing){
409+
constdiagnostic=createDiagnostic(
410+
category,
411+
filteredMissing,
412+
filteredExtra,
413+
suggestion,
414+
);
415+
for(constdepoffilteredMissing){
393416
letreactiveStableValueHint='';
394417
if(isStableType(dep.identifier)){
395418
reactiveStableValueHint=
@@ -402,7 +425,7 @@ function validateDependencies(
402425
loc: dep.loc,
403426
});
404427
}
405-
for(constdepofextra){
428+
for(constdepoffilteredExtra){
406429
if(dep.root.kind==='Global'){
407430
diagnostic.withDetails({
408431
kind: 'error',
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.exhaustive-deps-effect-events.expect.md‎
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
## Input
33

44
```javascript
5-
// @validateExhaustiveEffectDependencies
5+
// @validateExhaustiveEffectDependencies:"all"
66
import {useEffect, useEffectEvent} from'react';
77

88
functionComponent({x, y, z}) {
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.exhaustive-deps-effect-events.js‎
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// @validateExhaustiveEffectDependencies
1+
// @validateExhaustiveEffectDependencies:"all"
22
import{useEffect,useEffectEvent}from'react';
33

44
functionComponent({x, y, z}){
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps-extra-only.expect.md‎
Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
2+
## Input
3+
4+
```javascript
5+
// @validateExhaustiveEffectDependencies:"extra-only"
6+
import {useEffect} from'react';
7+
8+
functionComponent({x, y, z}) {
9+
// no error: missing dep not reported in extra-only mode
10+
useEffect(() => {
11+
log(x);
12+
 }, []);
13+
14+
// error: extra dep - y
15+
useEffect(() => {
16+
log(x);
17+
 }, [x, y]);
18+
19+
// error: extra dep - y (missing dep - z not reported)
20+
useEffect(() => {
21+
log(x, z);
22+
 }, [x, y]);
23+
24+
// error: extra dep - x.y
25+
useEffect(() => {
26+
log(x);
27+
 }, [x.y]);
28+
}
29+
30+
```
31+
32+
33+
## Error
34+
35+
```
36+
Found 3 errors:
37+
38+
Error: Found extra effect dependencies
39+
40+
Extra dependencies can cause an effect to fire more often than it should, resulting in performance problems such as excessive renders and side effects.
41+
42+
error.invalid-exhaustive-effect-deps-extra-only.ts:13:9
43+
 11 | useEffect(() => {
44+
 12 | log(x);
45+
> 13 | }, [x, y]);
46+
 | ^ Unnecessary dependency `y`
47+
 14 |
48+
 15 | // error: extra dep - y (missing dep - z not reported)
49+
 16 | useEffect(() => {
50+
51+
Inferred dependencies: `[x]`
52+
53+
Error: Found extra effect dependencies
54+
55+
Extra dependencies can cause an effect to fire more often than it should, resulting in performance problems such as excessive renders and side effects.
56+
57+
error.invalid-exhaustive-effect-deps-extra-only.ts:18:9
58+
 16 | useEffect(() => {
59+
 17 | log(x, z);
60+
> 18 | }, [x, y]);
61+
 | ^ Unnecessary dependency `y`
62+
 19 |
63+
 20 | // error: extra dep - x.y
64+
 21 | useEffect(() => {
65+
66+
Inferred dependencies: `[x, z]`
67+
68+
Error: Found extra effect dependencies
69+
70+
Extra dependencies can cause an effect to fire more often than it should, resulting in performance problems such as excessive renders and side effects.
71+
72+
error.invalid-exhaustive-effect-deps-extra-only.ts:23:6
73+
 21 | useEffect(() => {
74+
 22 | log(x);
75+
> 23 | }, [x.y]);
76+
 | ^^^ Overly precise dependency `x.y`, use `x` instead
77+
 24 | }
78+
 25 |
79+
80+
Inferred dependencies: `[x]`
81+
```
82+
83+
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps-extra-only.js‎
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
// @validateExhaustiveEffectDependencies:"extra-only"
2+
import{useEffect}from'react';
3+
4+
functionComponent({x, y, z}){
5+
// no error: missing dep not reported in extra-only mode
6+
useEffect(()=>{
7+
log(x);
8+
},[]);
9+
10+
// error: extra dep - y
11+
useEffect(()=>{
12+
log(x);
13+
},[x,y]);
14+
15+
// error: extra dep - y (missing dep - z not reported)
16+
useEffect(()=>{
17+
log(x,z);
18+
},[x,y]);
19+
20+
// error: extra dep - x.y
21+
useEffect(()=>{
22+
log(x);
23+
},[x.y]);
24+
}
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps-missing-only.expect.md‎
Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
2+
## Input
3+
4+
```javascript
5+
// @validateExhaustiveEffectDependencies:"missing-only"
6+
import {useEffect} from'react';
7+
8+
functionComponent({x, y, z}) {
9+
// error: missing dep - x
10+
useEffect(() => {
11+
log(x);
12+
 }, []);
13+
14+
// no error: extra dep not reported in missing-only mode
15+
useEffect(() => {
16+
log(x);
17+
 }, [x, y]);
18+
19+
// error: missing dep - z (extra dep - y not reported)
20+
useEffect(() => {
21+
log(x, z);
22+
 }, [x, y]);
23+
24+
// error: missing dep x
25+
useEffect(() => {
26+
log(x);
27+
 }, [x.y]);
28+
}
29+
30+
```
31+
32+
33+
## Error
34+
35+
```
36+
Found 3 errors:
37+
38+
Error: Found missing effect dependencies
39+
40+
Missing dependencies can cause an effect to fire less often than it should.
41+
42+
error.invalid-exhaustive-effect-deps-missing-only.ts:7:8
43+
 5 | // error: missing dep - x
44+
 6 | useEffect(() => {
45+
> 7 | log(x);
46+
 | ^ Missing dependency `x`
47+
 8 | }, []);
48+
 9 |
49+
 10 | // no error: extra dep not reported in missing-only mode
50+
51+
Inferred dependencies: `[x]`
52+
53+
Error: Found missing effect dependencies
54+
55+
Missing dependencies can cause an effect to fire less often than it should.
56+
57+
error.invalid-exhaustive-effect-deps-missing-only.ts:17:11
58+
 15 | // error: missing dep - z (extra dep - y not reported)
59+
 16 | useEffect(() => {
60+
> 17 | log(x, z);
61+
 | ^ Missing dependency `z`
62+
 18 | }, [x, y]);
63+
 19 |
64+
 20 | // error: missing dep x
65+
66+
Inferred dependencies: `[x, z]`
67+
68+
Error: Found missing effect dependencies
69+
70+
Missing dependencies can cause an effect to fire less often than it should.
71+
72+
error.invalid-exhaustive-effect-deps-missing-only.ts:22:8
73+
 20 | // error: missing dep x
74+
 21 | useEffect(() => {
75+
> 22 | log(x);
76+
 | ^ Missing dependency `x`
77+
 23 | }, [x.y]);
78+
 24 | }
79+
 25 |
80+
81+
Inferred dependencies: `[x]`
82+
```
83+
84+
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps-missing-only.js‎
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
// @validateExhaustiveEffectDependencies:"missing-only"
2+
import{useEffect}from'react';
3+
4+
functionComponent({x, y, z}){
5+
// error: missing dep - x
6+
useEffect(()=>{
7+
log(x);
8+
},[]);
9+
10+
// no error: extra dep not reported in missing-only mode
11+
useEffect(()=>{
12+
log(x);
13+
},[x,y]);
14+
15+
// error: missing dep - z (extra dep - y not reported)
16+
useEffect(()=>{
17+
log(x,z);
18+
},[x,y]);
19+
20+
// error: missing dep x
21+
useEffect(()=>{
22+
log(x);
23+
},[x.y]);
24+
}
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps.expect.md‎
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
## Input
33

44
```javascript
5-
// @validateExhaustiveEffectDependencies
5+
// @validateExhaustiveEffectDependencies:"all"
66
import {useEffect} from'react';
77

88
functionComponent({x, y, z}) {
‎compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-effect-deps.js‎
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// @validateExhaustiveEffectDependencies
1+
// @validateExhaustiveEffectDependencies:"all"
22
import{useEffect}from'react';
33

44
functionComponent({x, y, z}){
0 commit comments
Comments
 (0)