`react-doctor/three-require-controls-cleanup`

Undisposed imperative Three.js controls

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-controls-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 controls = new OrbitControls(camera, canvas);
  controls.enableDamping = true;
}, [camera, canvas]);

Corrected pattern

useEffect(() => {
  const controls = new OrbitControls(camera, canvas);
  controls.enableDamping = true;
  return () => controls.dispose();
}, [camera, 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/three-require-controls-cleanup diagnostic in the current repository. Required change: - Dispose component-owned Three.js controls in a React cleanup so their DOM listeners are removed.

Reference transformation:Before:

useEffect(() => {
  const controls = new OrbitControls(camera, canvas);
  controls.enableDamping = true;
}, [camera, canvas]);

After:

useEffect(() => {
  const controls = new OrbitControls(camera, canvas);
  controls.enableDamping = true;
  return () => controls.dispose();
}, [camera, 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.

More Bugs rules from the rules reference:

react-doctor/three-require-frame-delta: Frame-rate-dependent Three.js animation
react-doctor/three-require-instanced-buffer-update: Three.js instanced mesh buffer is not marked for upload
react-doctor/three-require-postprocessing-cleanup: Undisposed Three.js postprocessing resource
react-doctor/three-require-projection-matrix-update: Missing Three.js camera projection-matrix update
react-doctor/three-require-render-target-cleanup: Undisposed Three.js render target

react-doctor/three-require-controls-cleanup