feat(useHookAtTopLevel): add ignore option

[dyc3]

Summary

requested here: #7097 (comment)

Test Plan

snapshots

Docs

[changeset-bot]

🦋 Changeset detected

Latest commit: e96b2f5

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

[codspeed-hq]

CodSpeed Performance Report

Merging this PR will not alter performance

_{Comparing dyc3/use-hook-at-top-level-ignore (e96b2f5) with next (d11130b)}

Summary

✅ 58 untouched benchmarks
⏩ 95 skipped benchmarks¹

Footnotes

1. 95 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩

[coderabbitai]

Walkthrough

This PR introduces an ignore configuration option to the useHookAtTopLevel linter rule. The option allows specifying a list of function names that should be excluded from hook-at-top-level analysis, even if they follow the use* naming convention. The implementation adds an early exit in the lint rule when a hook name matches the ignore set, updates the options structure with a new optional ignore field, and includes comprehensive test coverage.

Possibly related PRs

• fix(lint): useHookAtTopLevel should not report issues unrelated to the nested hook call #7406: Modifies the same use_hook_at_top_level lint rule to control when diagnostics are emitted for hook calls.

Suggested reviewers

• arendjr
• ematipico

🚥 Pre-merge checks | ✅ 2

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely describes the main change: adding an ignore option to the useHookAtTopLevel linter rule.
Description check	✅ Passed	The description relates to the changeset, referencing the feature request issue and providing test details, though it could be more detailed about the implementation.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch dyc3/use-hook-at-top-level-ignore

Important

Action Needed: IP Allowlist Update

If your organization protects your Git platform with IP whitelisting, please add the new CodeRabbit IP address to your allowlist:

• ✨ 136.113.208.247/32 (new)
• 34.170.211.100/32
• 35.222.179.152/32

Reviews will stop working after February 8, 2026 if the new IP is not added to your allowlist.

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[ematipico]

Snapshots are incorrect

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In
`@crates/biome_js_analyze/tests/specs/correctness/useHookAtTopLevel/invalid-ignoreOption.js`:
- Around line 1-9: The test file declares it should generate diagnostics but
contains Component3 which calls useIgnoredHook (an ignored hook), so it won't
produce a diagnostic and duplicates the valid-ignoreOption test; either remove
the Component3 function block (lines defining function Component3 and its body)
from this invalid file, or change the hook call to a non-ignored hook name
(e.g., replace useIgnoredHook with a non-ignored symbol like useFooHook) so that
Component3 actually triggers the intended diagnostic; locate the Component3
function and update or delete it accordingly.

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Test case mismatch: Component3 shouldn't be in the invalid file.

The file header states "should generate diagnostics", but Component3 uses useIgnoredHook which is in the ignore list—so it won't produce a diagnostic. This appears to be a duplicate of the same test in valid-ignoreOption.js.

Consider removing lines 3-9, or if you intended to test something different here, update the hook name to a non-ignored one.

🤖 Prompt for AI Agents

In
`@crates/biome_js_analyze/tests/specs/correctness/useHookAtTopLevel/invalid-ignoreOption.js`
around lines 1 - 9, The test file declares it should generate diagnostics but
contains Component3 which calls useIgnoredHook (an ignored hook), so it won't
produce a diagnostic and duplicates the valid-ignoreOption test; either remove
the Component3 function block (lines defining function Component3 and its body)
from this invalid file, or change the hook call to a non-ignored hook name
(e.g., replace useIgnoredHook with a non-ignored symbol like useFooHook) so that
Component3 actually triggers the intended diagnostic; locate the Component3
function and update or delete it accordingly.

[ematipico]

Easy peasy!