`react-doctor/r3f-require-root-unmount`

R3F root without unmount cleanup

Category: Bugs
Severity: warn
Source: oxlint-plugin-react-doctor
Framework: global
Enabled when: react, r3f
Tags: r3f, webgl
Default: Enabled

Validate the diagnostic

Confirm the reported code matches this rule before you edit it.

Confirm the reported code matches react-doctor/r3f-require-root-unmount. Compare it with the Before example and verify the same API, framework, and execution context. Treat it as a false positive only when one of those conditions differs.

Compare the code

The corrected pattern shows a focused way to address the diagnostic.

Reported pattern

useEffect(() => {
  const root = createRoot(canvas);
  root.render(<Scene />);
}, [canvas]);

Corrected pattern

useEffect(() => {
  const root = createRoot(canvas);
  root.render(<Scene />);
  return () => root.unmount();
}, [canvas]);

How to fix

Use the corrected pattern as a reference. Preserve behavior that the rule does not require you to change.

Copyable fix prompt

Copy this self-contained prompt into your coding agent after you confirm the diagnostic.

Fix every confirmed react-doctor/r3f-require-root-unmount diagnostic in the current repository. Required change: - Unmount component-owned R3F roots in React cleanup, or return an exact disposer that unmounts the root.

Reference transformation:Before:

useEffect(() => {
  const root = createRoot(canvas);
  root.render(<Scene />);
}, [canvas]);

After:

useEffect(() => {
  const root = createRoot(canvas);
  root.render(<Scene />);
  return () => root.unmount();
}, [canvas]);

Constraints: - Confirm the reported code matches the Before pattern. - 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, r3f. Verification: - Run focused tests for the changed behavior. - Run React Doctor and confirm this diagnostic no longer appears. - Report the files changed and any checks you could not run.

More Bugs rules from the rules reference:

react-doctor/r3f-webgpu-canvas-prop-compatibility: Incompatible R3F Canvas renderer prop
react-doctor/r3f-webgpu-no-gl-state: WebGPU root reads deprecated gl state
react-doctor/r3f-webgpu-no-js-uniform-branch: JavaScript branch reads a TSL uniform value
react-doctor/r3f-webgpu-no-legacy-effect-composer: Legacy EffectComposer inside an R3F WebGPU Canvas
react-doctor/r3f-webgpu-no-legacy-material-api: Legacy shader material API inside an R3F WebGPU Canvas

react-doctor/r3f-require-root-unmount