react-doctor/no-reset-all-state-on-prop-change
Disallow resetting all state in an effect when a prop changes.
- Status
- Active
- Category
- State & Effects
- Assessment
- Evidence-required risk
- Required evidence
- source code
- Default configuration
- Enabled
- Default severity
- warn
Show technical metadata
- Scope
- All supported frameworks
- Active when
- eslint-plugin-react-you-might-not-need-an-effect installed in project
- Requirements
- react
- Tags
- test-noise
- Priority
- 48 (P3)
- Source
- oxlint-plugin-react-doctor
- Rule set
- oxlint-plugin-react-doctor 0.9.3 (prompt schema 2)
- Documentation
- Official documentation
Validation prompt
Confirm the detector match and collect the required evidence before deciding whether an edit is warranted.
Fires when a useEffect resets every useState in the component back to its initial value (the rule counts useState declarations and requires the setter calls to match that count exactly, with each set to the original initial value) in response to a prop in the deps array. Custom hooks are explicitly skipped.
Suppress when: rare: the recommended key-prop fix works in virtually all component shapes.
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.
Hoist the discriminator one level up and remount via key: <UserProfile key={userId} {...rest} />. React unmounts the previous subtree and mounts a fresh one, resetting all state automatically with no setter calls and no wasted render. The rule's error message already names which prop is the candidate for the key. See https://react.dev/learn/you-might-not-need-an-effect#resetting-all-state-when-a-prop-changes
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-reset-all-state-on-prop-change diagnostic in the current repository.
Required change:
- Hoist the discriminator one level up and remount via key: <UserProfile key={userId} {...rest} />. React unmounts the previous subtree and mounts a fresh one, resetting all state automatically with no setter calls and no wasted render. The rule's error message already names which prop is the candidate for the key. See https://react.dev/learn/you-might-not-need-an-effect#resetting-all-state-when-a-prop-changes.
Validation before editing:
Fires when a useEffect resets every useState in the component back to its initial value (the rule counts useState declarations and requires the setter calls to match that count exactly, with each set to the original initial value) in response to a prop in the deps array. Custom hooks are explicitly skipped.
Suppress when: rare: the recommended key-prop fix works in virtually all component shapes.
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:
eslint-plugin-react-you-might-not-need-an-effect installed in project.
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.