react-doctor/three-require-renderer-cleanup
Undisposed Three.js renderer
- Category: Bugs
- Severity: warn
- Source:
oxlint-plugin-react-doctor - Framework: global
- Enabled when: react, three
- Tags: three, webgl
- Default: Enabled
Validate the diagnostic
Confirm the reported code matches this rule before you edit it.
Confirm the reported code matches react-doctor/three-require-renderer-cleanup. 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 renderer = new WebGLRenderer({ canvas });
renderer.setAnimationLoop(render);
}, [canvas]);Corrected pattern
useEffect(() => {
const renderer = new WebGLRenderer({ canvas });
renderer.setAnimationLoop(render);
return () => {
renderer.setAnimationLoop(null);
renderer.dispose();
};
}, [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
Reference transformation:Before:react-doctor/three-require-renderer-cleanup diagnostic in the current repository.
Required change:
- Dispose component-owned renderers and stop their animation loop or animation frame in matching React cleanup.useEffect(() => {
const renderer = new WebGLRenderer({ canvas });
renderer.setAnimationLoop(render);
}, [canvas]);useEffect(() => {
const renderer = new WebGLRenderer({ canvas });
renderer.setAnimationLoop(render);
return () => {
renderer.setAnimationLoop(null);
renderer.dispose();
};
}, [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, three.
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.Related rules
More Bugs rules from the rules reference:
react-doctor/three-shader-no-constant-out-of-bounds-index: Shader uses a constant out-of-bounds indexreact-doctor/three-shader-no-derivatives-in-nonuniform-flow: Shader derivative runs in non-uniform control flowreact-doctor/three-shader-no-invalid-clamp-bounds: Shader uses invalid clamp boundsreact-doctor/three-shader-no-invalid-constant-bit-operations: Shader uses invalid constant bit operationsreact-doctor/three-shader-no-invalid-constant-math: Shader uses invalid constant math