feat(biome_js_analyze): allow specifying stable object keys in useExhaustiveDependencies configuration

[josh-]

Summary

Closes #6386

Currently Biome supports specifying that React hook results are stable when hook returns either a single value or an array. This PR adds support for specifying stable object keys inside a hook return value as well.

For example, this hook returns a stable setMyState function:

const useCustomHook = () => {
  const [myState, setMyState] = useState(false)
  return {myState, setMyState}
}

const Component = () => {
  const {myState, setMyState} = useCustomHook()
  const toggleMyState = useCallback(() => {
    setMyState(!myState);
  }, [myState]);

  return <button onClick={toggleMyState}>button</button>
}

but when linting with Biome the following error is generated:

file.tsx:26:25 lint/correctness/useExhaustiveDependencies  FIXABLE  
  ✖ This hook does not specify all of its dependencies: setMyState
  
    24 │ const Component = () => {
    25 │   const {myState, setMyState} = useCustomHook()
  > 26 │   const toggleMyState = useCallback(() => {
       │                         ^^^^^^^^^^^
    27 │     setMyState(!myState);
    28 │   }, [myState]);
  
  ℹ This dependency is not specified in the hook dependency list.
  
    25 │   const {myState, setMyState} = useCustomHook()
    26 │   const toggleMyState = useCallback(() => {
  > 27 │     setMyState(!myState);
       │     ^^^^^^^^^^
    28 │   }, [myState]);
    29 │ 
  
  ℹ Unsafe fix: Add the missing dependencies to the list.
  
    28 │ ··},·[myState,·setMyState]);
       │              ++++++++++++

with no ability to specify that this value is stable without suppressing the rule.

This PR adds a new option which allows specifying that such object properties are stable:

"useExhaustiveDependencies": {
    "level": "error",
    "options": {
        "hooks": [{
            "name": "useCustomHook",
            "stableResult": [
                "setMyState"
            ]
        }]
    }
}

Test Plan

Added two tests:

• stableResultKeys validates the new configuration option
• stableResultInvalidKeysIndices validates the new error throw when mixing array indices and object property keys in the configtaiton

[codspeed-hq]

CodSpeed Performance Report

Merging #6398 will degrade performances by 61.17%

_{Comparing josh-:use-exhaustive-dependencies-stable-object-keys (7ad42c8) with next (275cc8b)}

Summary

⚡ 2 improvements
❌ 2 regressions
✅ 110 untouched benchmarks

⚠️ Please fix the performance issues or acknowledge them on CodSpeed.

Benchmarks breakdown

	Benchmark	BASE	HEAD	Change
❌	js_analyzer[index_3894593175024091846.js]	49.4 ms	52.7 ms	-6.18%
⚡	json_formatter[eucjp_1600564308684076393.json]	2.6 ms	2.5 ms	+6.14%
⚡	deserialize_from_json_str[package.json]	1,038.3 µs	930.8 µs	+11.55%
❌	deserialize_from_json_str[tsconfig.json]	218 µs	561.5 µs	-61.17%

[siketyan]

Nice and very clean implementation! I can't believe this is your first time contributing to Biome 🤯 Could you update the outdated snapshots so the failing tests should pass?

[josh-]

@siketyan thank you for the kind words! 😄 appreciate all the effort that's gone into the contributing guide!

[changeset-bot]

🦋 Changeset detected

Latest commit: 7ad42c8

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 14 packages

Name	Type
@biomejs/biome	Minor
@biomejs/cli-win32-x64	Minor
@biomejs/cli-win32-arm64	Minor
@biomejs/cli-darwin-x64	Minor
@biomejs/cli-darwin-arm64	Minor
@biomejs/cli-linux-x64	Minor
@biomejs/cli-linux-arm64	Minor
@biomejs/cli-linux-x64-musl	Minor
@biomejs/cli-linux-arm64-musl	Minor
@biomejs/wasm-web	Minor
@biomejs/wasm-bundler	Minor
@biomejs/wasm-nodejs	Minor
@biomejs/backend-jsonrpc	Patch
@biomejs/js-api	Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[josh-]

@siketyan just pushed a new commit which should hopefully improve perf - let me know what you think!

[arendjr]

Very nice work indeed, thank you!

[arendjr]

I apologise, we had hoped to include this one in the Biome 2.1 release, but overlooked it. Could you please rebase the PR on top of next so we can make sure to include it in the next?

[josh-]

No worries at all @arendjr - just rebased on next

[arendjr]

Thank you!