`react-doctor/three-on-before-compile-require-program-cache-key`

onBeforeCompile variant lacks a program cache key

Category: Bugs
Severity: error
Source: oxlint-plugin-react-doctor
Framework: global
Enabled when: 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-on-before-compile-require-program-cache-key. 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

material.onBeforeCompile = (shader) => patch(shader, variant);

Corrected pattern

material.onBeforeCompile = (shader) => patch(shader, variant);
material.customProgramCacheKey = () => String(variant);

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-on-before-compile-require-program-cache-key diagnostic in the current repository. Required change: - Return every mutable shader-patch variant from customProgramCacheKey on the same material.

Reference transformation:Before:

material.onBeforeCompile = (shader) => patch(shader, variant);

After:

material.onBeforeCompile = (shader) => patch(shader, variant);
material.customProgramCacheKey = () => String(variant);

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: 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-raw-shader-require-fragment-float-precision: Raw fragment shader lacks float precision
react-doctor/three-raw-shader-require-glsl3-version: Raw shader uses GLSL 3 syntax without GLSL3
react-doctor/three-require-animation-mixer-cleanup: Unreleased Three.js animation mixer actions
react-doctor/three-require-controls-cleanup: Undisposed imperative Three.js controls
react-doctor/three-require-frame-delta: Frame-rate-dependent Three.js animation

react-doctor/three-on-before-compile-require-program-cache-key