Refactor/settings literal unions#459
Open
martinshub-tech wants to merge 2 commits into
Open
Conversation
|
@martinshub-tech Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
this pr closes #440
Why
src/context/SettingsContext.tsx stored network, addressDisplay, autoDismiss, and themeMode as plain strings. This allowed typos and made it impossible for TypeScript to catch invalid values. The UI already restricts selections to a known set, so the type layer should reflect the same constraints.
What was changed
Literal‑union types
ts
export type NetworkOption = 'public' | 'test';
export type AddressDisplayOption = 'full' | 'short' | 'friendly';
export type AutoDismissOption = 'off' | '3s' | '5s' | '8s';
export type ThemeMode = 'light' | 'dark' | 'system';
Validation helpers (coerceNetwork, coerceAddressDisplay, coerceAutoDismiss, coerceTheme) that safely coerce any stored value to a valid enum, falling back to the default values from defaultPersistedSettings.
Applied coercion when building persistedSettings so corrupted or out‑of‑domain values are clamped to defaults.
Added VALID_THEMES array to support theme validation.
Extended SettingsPayload / SettingsState to use the new union types throughout the context and UI.
Updated default values and ensured the new types flow through the provider’s state, setters, and persistence logic.
Impact
Compile‑time safety for settings‑related code.
Runtime safety: malformed localStorage entries can no longer break the app; they are automatically replaced with sensible defaults.
No UI changes – the existing Settings UI continues to work unchanged.