New
Introducing React Bench, see how different models perform on React code

react-doctor/no-hydration-branch-on-browser-global

Render the same initial branch on the server and client instead of branching on a browser global during hydration.

Status
Active
Category
Bugs
Assessment
Evidence-required risk
Required evidence
source code
Default configuration
Enabled
Default severity
error
Show technical metadata
Scope
All supported frameworks
Active when
React projects with server-side rendering
Requirements
react, ssr
Priority
76 (P1)
Source
oxlint-plugin-react-doctor
Rule set
oxlint-plugin-react-doctor 0.9.3 (prompt schema 2)
On this page

Validation prompt

Confirm the detector match and collect the required evidence before deciding whether an edit is warranted.

Fires when initial rendered output branches on browser-only state such as window, document, navigator, storage, media queries, or a local helper or useMemo value derived from those globals. Confirm that the branch runs during render and can select different server and client output. The detector excludes branches under suppressHydrationWarning, but that is only safe for an unavoidable one-level text or attribute mismatch: it does not suppress structural hydration errors or make React patch mismatched content.

Evidence boundary

The diagnostic proves only that the detector’s modeled source pattern matched. It does not prove runtime impact, product intent, rendered failure, or that one remediation is correct.

Establish the environment, repository policy, exceptions, and required rendered or runtime evidence before deciding the occurrence.

Record one outcome:

  • Confirmed failure: The required evidence establishes the violation.
  • Rejected: A documented exception or false-positive predicate applies.
  • Needs evidence: Named evidence can still be collected.
  • Unavailable: Required evidence cannot be collected in this run.
  • Waived with evidence: An authorized, scoped exception applies to an established failure.
  • Observation: The review records an optional tradeoff without claiming a defect.

A waiver records its scope, authority, evidence, and review condition. It is not a pass or false positive.

Default severity is registry metadata. Use the occurrence’s JSON severity after repository configuration when ordering real findings.

Fix prompt

Apply this candidate correction only after the required evidence confirms the risk.

Render one stable initial structure on both the server and first client render. For a subscribable browser value, use useSyncExternalStore(subscribe, getSnapshot, getServerSnapshot) with an explicit server snapshot. Use suppressHydrationWarning only on the exact element with an unavoidable text or attribute mismatch, never to excuse different elements, child structure, or missing nodes. Use a mount gate only when no stable snapshot or server-compatible initial output can express the behavior.

Repository-wide copy prompt

Use this repository-wide prompt only after validating each occurrence. For one occurrence, use the guidance above.

Show repository-wide prompt

Fix every confirmed react-doctor/no-hydration-branch-on-browser-global diagnostic in the current repository.

Required change:

  • Render one stable initial structure on both the server and first client render. For a subscribable browser value, use useSyncExternalStore(subscribe, getSnapshot, getServerSnapshot) with an explicit server snapshot. Use suppressHydrationWarning only on the exact element with an unavoidable text or attribute mismatch, never to excuse different elements, child structure, or missing nodes. Use a mount gate only when no stable snapshot or server-compatible initial output can express the behavior.

Validation before editing:

Fires when initial rendered output branches on browser-only state such as window, document, navigator, storage, media queries, or a local helper or useMemo value derived from those globals. Confirm that the branch runs during render and can select different server and client output. The detector excludes branches under suppressHydrationWarning, but that is only safe for an unavoidable one-level text or attribute mismatch: it does not suppress structural hydration errors or make React patch mismatched content.

Constraints:

  • Make the smallest change that fixes the root cause.
  • Preserve behavior and interfaces unrelated to this diagnostic.
  • Reuse existing project components, utilities, and conventions.
  • Do not introduce render-phase side effects, render-phase state updates, or Hooks rule violations.
  • Adapt identifiers and framework details instead of copying blindly.
  • Do not disable the rule or suppress matching code.
  • Confirm this rule is enabled for the project: React projects with server-side rendering.

Assessment:

  • Record detector evidence, applicability facts, assumptions, missing evidence, and the rule class for this occurrence.
  • Return one outcome: Confirmed failure, Rejected, Needs evidence, Unavailable, Waived with evidence, or Observation.
  • A waiver records the established failure, scope, authority, evidence, and review or expiry condition. It is not a pass or false positive.

Verification:

  • Run focused tests for the changed behavior.
  • Run React Doctor and confirm this diagnostic no longer appears from changed code.
  • Run an unfiltered scan of the affected scope before claiming no cross-category regression.
  • Report the files changed and any checks you could not run.