react-doctor/client-localstorage-no-version
Bake a version into the storage key (e.g. "myKey:v1"); a future schema change can ignore old data instead of crashing on it
- Status
- Active
- Category
- Correctness
- Assessment
- Evidence-required risk
- Required evidence
- source code
- Default configuration
- Enabled
- Default severity
- warn
Show technical metadata
- Scope
- All supported frameworks
- Active when
- always
- Requirements
- react
- Tags
- test-noise
- Priority
- 26 (P3)
- Source
- oxlint-plugin-react-doctor
- Rule set
- oxlint-plugin-react-doctor 0.9.3 (prompt schema 2)
Validation prompt
Confirm the detector match and collect the required evidence before deciding whether an edit is warranted.
Confirm the call is localStorage.setItem or sessionStorage.setItem with a string-literal key that lacks a version suffix: the rule's regex /(?:[._:-]v\d+|@\d+|\bv\d+\b)/i already accepts keys like "prefs:v1", "cache@1", or "stateV2": AND whose second argument is a literal JSON.stringify(...) call.
Suppress when: the serialized payload itself already encodes a schema version field.
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.
Append a version suffix to the storage key (e.g. "prefs" becomes "prefs:v1") and, on read, drop or migrate data from older keys so a future shape change skips stale entries instead of crashing JSON.parse. Bump the suffix anytime the stored shape changes. See https://developer.mozilla.org/en-US/docs/Web/API/Web_Storage_API/Using_the_Web_Storage_API
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/client-localstorage-no-version diagnostic in the current repository.
Required change:
- Append a version suffix to the storage key (e.g. "prefs" becomes "prefs:v1") and, on read, drop or migrate data from older keys so a future shape change skips stale entries instead of crashing JSON.parse. Bump the suffix anytime the stored shape changes. See https://developer.mozilla.org/en-US/docs/Web/API/Web_Storage_API/Using_the_Web_Storage_API.
Validation before editing:
Confirm the call is localStorage.setItem or sessionStorage.setItem with a string-literal key that lacks a version suffix: the rule's regex /(?:[._:-]v\d+|@\d+|\bv\d+\b)/i already accepts keys like "prefs:v1", "cache@1", or "stateV2": AND whose second argument is a literal JSON.stringify(...) call.
Suppress when: the serialized payload itself already encodes a schema version field.
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.
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.