Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
693 changes: 693 additions & 0 deletions apps/ui/src/components/settings-view/index.test.tsx

Large diffs are not rendered by default.

1,187 changes: 1,044 additions & 143 deletions apps/ui/src/components/settings-view/index.tsx

Large diffs are not rendered by default.

61 changes: 61 additions & 0 deletions apps/ui/src/components/settings-view/preferences.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
import { describe, expect, it } from 'vitest';
import { UNSET, diffPreferencesFromSaved, toPreferencesFormData } from './preferences';
import type { UserPreferences } from '@/data/core';

const SAVED_PREFERENCES: UserPreferences = {
editor: 'zed',
terminal: 'terminal',
colorScheme: 'system',
locale: 'en',
defaultSiteDirectory: '/Users/example/Studio',
studioCliInstalled: false,
};

describe( 'settings preference helpers', () => {
it( 'resolves form defaults from saved preferences in one place', () => {
expect(
toPreferencesFormData( {
...SAVED_PREFERENCES,
editor: null,
terminal: null,
locale: 'missing-locale',
} )
).toEqual( {
editor: UNSET,
terminal: UNSET,
colorScheme: 'system',
locale: 'en',
defaultSiteDirectory: '/Users/example/Studio',
studioCliInstalled: false,
} );
} );

it( 'returns an empty save diff when form values match saved defaults', () => {
expect(
diffPreferencesFromSaved( toPreferencesFormData( SAVED_PREFERENCES ), SAVED_PREFERENCES )
).toEqual( {} );
} );

it( 'diffs default site directory and Studio CLI state with other preference fields', () => {
expect(
diffPreferencesFromSaved(
{
editor: UNSET,
terminal: 'iterm',
colorScheme: 'dark',
locale: 'es',
defaultSiteDirectory: '/Users/example/Sites',
studioCliInstalled: true,
},
SAVED_PREFERENCES
)
).toEqual( {
editor: null,
terminal: 'iterm',
colorScheme: 'dark',
locale: 'es',
defaultSiteDirectory: '/Users/example/Sites',
studioCliInstalled: true,
} );
} );
} );
60 changes: 60 additions & 0 deletions apps/ui/src/components/settings-view/preferences.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
import { isSupportedLocale } from '@studio/common/lib/locale';
import type {
ColorScheme,
SupportedEditor,
SupportedLocale,
SupportedTerminal,
UserPreferences,
WritableUserPreferences,
} from '@/data/core';

export const UNSET = '' as const;

export interface PreferencesFormData {
editor: SupportedEditor | typeof UNSET;
terminal: SupportedTerminal | typeof UNSET;
colorScheme: ColorScheme;
locale: SupportedLocale;
defaultSiteDirectory: string;
studioCliInstalled: boolean;
}

// The saved locale can be any string the main process resolved (including ones
// outside our catalog). Clamp to a SupportedLocale so form controls always have
// a valid option selected.
export function resolveFormLocale( locale: string | undefined ): SupportedLocale {
return isSupportedLocale( locale ) ? locale : 'en';
}

export function toPreferencesFormData( prefs: UserPreferences ): PreferencesFormData {
return {
editor: prefs.editor ?? UNSET,
terminal: prefs.terminal ?? UNSET,
colorScheme: prefs.colorScheme,
locale: resolveFormLocale( prefs.locale ),
defaultSiteDirectory: prefs.defaultSiteDirectory,
studioCliInstalled: prefs.studioCliInstalled,
};
}

export function diffPreferencesFromSaved(
next: PreferencesFormData,
saved: UserPreferences
): Partial< WritableUserPreferences > {
const patch: Partial< WritableUserPreferences > = {};
const nextEditor: SupportedEditor | null = next.editor === UNSET ? null : next.editor;
const nextTerminal: SupportedTerminal | null = next.terminal === UNSET ? null : next.terminal;

if ( nextEditor !== saved.editor ) patch.editor = nextEditor;
if ( nextTerminal !== saved.terminal ) patch.terminal = nextTerminal;
if ( next.colorScheme !== saved.colorScheme ) patch.colorScheme = next.colorScheme;
if ( next.locale !== resolveFormLocale( saved.locale ) ) patch.locale = next.locale;
if ( next.defaultSiteDirectory !== saved.defaultSiteDirectory ) {
patch.defaultSiteDirectory = next.defaultSiteDirectory;
}
if ( next.studioCliInstalled !== saved.studioCliInstalled ) {
patch.studioCliInstalled = next.studioCliInstalled;
}

return patch;
}
Loading