Skip to content

Offline, privacy-first grammar checker. Fast, open-source, Rust-powered

11.5 KB
Raw Blame
/**
 * Shared display configuration and helpers for the Harper editor UI.
 *
 * This module keeps editor-only presentation choices, such as lint-kind styles,
 * lint-kind ordering, font options, and small formatting helpers, out of Svelte
 * components. Canonical linting concepts still come from `harper.js` and
 * `lint-framework`; this file only describes how those values should appear in
 * the editor.
 */
import type { LintKind } from 'harper.js';
import type { UnpackedSuggestion } from './types.js';

export type EditorFontFamily = 'sans' | 'serif' | 'mono';

export type EditorFontSize = 'default' | number;

export type LintKindCounts = Record<LintKind, number>;

export const FONT_OPTIONS: {
	value: EditorFontFamily;
	label: string;
	sample: string;
	stack: string;
}[] = [
	{
		value: 'sans',
		label: 'Sans',
		sample: 'Aa',
		stack:
			"'Inter', -apple-system, BlinkMacSystemFont, 'SF Pro Text', 'Helvetica Neue', sans-serif",
	},
	{
		value: 'serif',
		label: 'Serif',
		sample: 'Aa',
		stack: "'Iowan Old Style', 'New York', Georgia, serif",
	},
	{
		value: 'mono',
		label: 'Mono',
		sample: 'Aa',
		stack: "'JetBrains Mono', ui-monospace, 'SF Mono', Menlo, monospace",
	},
];

export const FONT_SIZES = [12, 13, 14, 15, 16, 17, 18, 20, 22];
export const DEFAULT_FONT_SIZE = 'default';

export const LINT_KIND_ORDER: LintKind[] = [
	'Spelling',
	'Typo',
	'Capitalization',
	'Grammar',
	'Agreement',
	'BoundaryError',
	'Punctuation',
	'Usage',
	'WordChoice',
	'WordOrder',
	'Style',
	'Readability',
	'Enhancement',
	'Redundancy',
	'Repetition',
	'Formatting',
	'Regionalism',
	'Nonstandard',
	'Eggcorn',
	'Malapropism',
	'Miscellaneous',
];

/**
 * Presentation metadata for each Harper lint kind.
 *
 * Keeping these classes here lets the editor share one visual language across
 * cards, counts, and active states without spreading Tailwind class maps through
 * Svelte components. Every class string except `dotClass` also carries its
 * `dark:` variant, so the palette follows a `.dark` ancestor without extra
 * logic in components.
 */
export const LINT_KIND_STYLES: Record<
	LintKind,
	{
		label: string;
		dotClass: string;
		haloClass: string;
		textClass: string;
		softClass: string;
		activeClass: string;
	}
> = {
	Agreement: {
		label: 'Agreement',
		dotClass: 'bg-emerald-500',
		haloClass: 'bg-emerald-100 dark:bg-emerald-950',
		textClass: 'text-emerald-700 dark:text-emerald-300',
		softClass: 'bg-emerald-50 dark:bg-emerald-500/15',
		activeClass:
			'border-[rgba(28,26,22,0.14)] shadow-emerald-500/10 dark:border-white/15 dark:shadow-emerald-500/20',
	},
	BoundaryError: {
		label: 'Boundary',
		dotClass: 'bg-indigo-500',
		haloClass: 'bg-indigo-100 dark:bg-indigo-950',
		textClass: 'text-indigo-700 dark:text-indigo-300',
		softClass: 'bg-indigo-50 dark:bg-indigo-500/15',
		activeClass:
			'border-[rgba(28,26,22,0.14)] shadow-indigo-500/10 dark:border-white/15 dark:shadow-indigo-500/20',
	},
	Capitalization: {
		label: 'Capitalization',
		dotClass: 'bg-rose-500',
		haloClass: 'bg-rose-100 dark:bg-rose-950',
		textClass: 'text-rose-700 dark:text-rose-300',
		softClass: 'bg-rose-50 dark:bg-rose-500/15',
		activeClass:
			'border-[rgba(28,26,22,0.14)] shadow-rose-500/10 dark:border-white/15 dark:shadow-rose-500/20',
	},
	Eggcorn: {
		label: 'Eggcorn',
		dotClass: 'bg-violet-500',
		haloClass: 'bg-violet-100 dark:bg-violet-950',
		textClass: 'text-violet-700 dark:text-violet-300',
		softClass: 'bg-violet-50 dark:bg-violet-500/15',
		activeClass:
			'border-[rgba(28,26,22,0.14)] shadow-violet-500/10 dark:border-white/15 dark:shadow-violet-500/20',
	},
	Enhancement: {
		label: 'Enhancement',
		dotClass: 'bg-amber-600',
		haloClass: 'bg-amber-100 dark:bg-amber-950',
		textClass: 'text-amber-700 dark:text-amber-300',
		softClass: 'bg-amber-50 dark:bg-amber-500/15',
		activeClass:
			'border-[rgba(28,26,22,0.14)] shadow-amber-600/10 dark:border-white/15 dark:shadow-amber-600/20',
	},
	Formatting: {
		label: 'Formatting',
		dotClass: 'bg-slate-500',
		haloClass: 'bg-slate-100 dark:bg-slate-950',
		textClass: 'text-slate-700 dark:text-slate-300',
		softClass: 'bg-slate-50 dark:bg-slate-500/15',
		activeClass:
			'border-[rgba(28,26,22,0.14)] shadow-slate-500/10 dark:border-white/15 dark:shadow-slate-500/20',
	},
	Grammar: {
		label: 'Grammar',
		dotClass: 'bg-emerald-600',
		haloClass: 'bg-emerald-100 dark:bg-emerald-950',
		textClass: 'text-emerald-700 dark:text-emerald-300',
		softClass: 'bg-emerald-50 dark:bg-emerald-500/15',
		activeClass:
			'border-[rgba(28,26,22,0.14)] shadow-emerald-600/10 dark:border-white/15 dark:shadow-emerald-600/20',
	},
	Malapropism: {
		label: 'Malapropism',
		dotClass: 'bg-fuchsia-500',
		haloClass: 'bg-fuchsia-100 dark:bg-fuchsia-950',
		textClass: 'text-fuchsia-700 dark:text-fuchsia-300',
		softClass: 'bg-fuchsia-50 dark:bg-fuchsia-500/15',
		activeClass:
			'border-[rgba(28,26,22,0.14)] shadow-fuchsia-500/10 dark:border-white/15 dark:shadow-fuchsia-500/20',
	},
	Miscellaneous: {
		label: 'Miscellaneous',
		dotClass: 'bg-sky-500',
		haloClass: 'bg-sky-100 dark:bg-sky-950',
		textClass: 'text-sky-700 dark:text-sky-300',
		softClass: 'bg-sky-50 dark:bg-sky-500/15',
		activeClass:
			'border-[rgba(28,26,22,0.14)] shadow-sky-500/10 dark:border-white/15 dark:shadow-sky-500/20',
	},
	Nonstandard: {
		label: 'Nonstandard',
		dotClass: 'bg-stone-500',
		haloClass: 'bg-stone-100 dark:bg-stone-950',
		textClass: 'text-stone-700 dark:text-stone-300',
		softClass: 'bg-stone-50 dark:bg-stone-500/15',
		activeClass:
			'border-[rgba(28,26,22,0.14)] shadow-stone-500/10 dark:border-white/15 dark:shadow-stone-500/20',
	},
	Punctuation: {
		label: 'Punctuation',
		dotClass: 'bg-cyan-600',
		haloClass: 'bg-cyan-100 dark:bg-cyan-950',
		textClass: 'text-cyan-700 dark:text-cyan-300',
		softClass: 'bg-cyan-50 dark:bg-cyan-500/15',
		activeClass:
			'border-[rgba(28,26,22,0.14)] shadow-cyan-600/10 dark:border-white/15 dark:shadow-cyan-600/20',
	},
	Readability: {
		label: 'Readability',
		dotClass: 'bg-violet-600',
		haloClass: 'bg-violet-100 dark:bg-violet-950',
		textClass: 'text-violet-700 dark:text-violet-300',
		softClass: 'bg-violet-50 dark:bg-violet-500/15',
		activeClass:
			'border-[rgba(28,26,22,0.14)] shadow-violet-600/10 dark:border-white/15 dark:shadow-violet-600/20',
	},
	Redundancy: {
		label: 'Redundancy',
		dotClass: 'bg-amber-600',
		haloClass: 'bg-amber-100 dark:bg-amber-950',
		textClass: 'text-amber-700 dark:text-amber-300',
		softClass: 'bg-amber-50 dark:bg-amber-500/15',
		activeClass:
			'border-[rgba(28,26,22,0.14)] shadow-amber-600/10 dark:border-white/15 dark:shadow-amber-600/20',
	},
	Regionalism: {
		label: 'Regionalism',
		dotClass: 'bg-teal-700',
		haloClass: 'bg-teal-100 dark:bg-teal-950',
		textClass: 'text-teal-700 dark:text-teal-300',
		softClass: 'bg-teal-50 dark:bg-teal-500/15',
		activeClass:
			'border-[rgba(28,26,22,0.14)] shadow-teal-700/10 dark:border-white/15 dark:shadow-teal-700/20',
	},
	Repetition: {
		label: 'Repetition',
		dotClass: 'bg-amber-700',
		haloClass: 'bg-amber-100 dark:bg-amber-950',
		textClass: 'text-amber-700 dark:text-amber-300',
		softClass: 'bg-amber-50 dark:bg-amber-500/15',
		activeClass:
			'border-[rgba(28,26,22,0.14)] shadow-amber-700/10 dark:border-white/15 dark:shadow-amber-700/20',
	},
	Spelling: {
		label: 'Spelling',
		dotClass: 'bg-rose-500',
		haloClass: 'bg-rose-100 dark:bg-rose-950',
		textClass: 'text-rose-700 dark:text-rose-300',
		softClass: 'bg-rose-50 dark:bg-rose-500/15',
		activeClass:
			'border-[rgba(28,26,22,0.14)] shadow-rose-500/10 dark:border-white/15 dark:shadow-rose-500/20',
	},
	Style: {
		label: 'Style',
		dotClass: 'bg-blue-500',
		haloClass: 'bg-blue-100 dark:bg-blue-950',
		textClass: 'text-blue-700 dark:text-blue-300',
		softClass: 'bg-blue-50 dark:bg-blue-500/15',
		activeClass:
			'border-[rgba(28,26,22,0.14)] shadow-blue-500/10 dark:border-white/15 dark:shadow-blue-500/20',
	},
	Typo: {
		label: 'Typo',
		dotClass: 'bg-rose-500',
		haloClass: 'bg-rose-100 dark:bg-rose-950',
		textClass: 'text-rose-700 dark:text-rose-300',
		softClass: 'bg-rose-50 dark:bg-rose-500/15',
		activeClass:
			'border-[rgba(28,26,22,0.14)] shadow-rose-500/10 dark:border-white/15 dark:shadow-rose-500/20',
	},
	Usage: {
		label: 'Usage',
		dotClass: 'bg-green-600',
		haloClass: 'bg-green-100 dark:bg-green-950',
		textClass: 'text-green-700 dark:text-green-300',
		softClass: 'bg-green-50 dark:bg-green-500/15',
		activeClass:
			'border-[rgba(28,26,22,0.14)] shadow-green-600/10 dark:border-white/15 dark:shadow-green-600/20',
	},
	WordChoice: {
		label: 'Word Choice',
		dotClass: 'bg-blue-600',
		haloClass: 'bg-blue-100 dark:bg-blue-950',
		textClass: 'text-blue-700 dark:text-blue-300',
		softClass: 'bg-blue-50 dark:bg-blue-500/15',
		activeClass:
			'border-[rgba(28,26,22,0.14)] shadow-blue-600/10 dark:border-white/15 dark:shadow-blue-600/20',
	},
	WordOrder: {
		label: 'Word Order',
		dotClass: 'bg-indigo-600',
		haloClass: 'bg-indigo-100 dark:bg-indigo-950',
		textClass: 'text-indigo-700 dark:text-indigo-300',
		softClass: 'bg-indigo-50 dark:bg-indigo-500/15',
		activeClass:
			'border-[rgba(28,26,22,0.14)] shadow-indigo-600/10 dark:border-white/15 dark:shadow-indigo-600/20',
	},
};

export const LINT_KIND_STYLE_ENTRIES = LINT_KIND_ORDER.map(
	(key) => [key, LINT_KIND_STYLES[key]] as const,
);

/**
 * Create a zero-filled count map for every lint kind shown by the editor.
 *
 * Components use this as a stable accumulator shape so lint-kind count rendering
 * does not need to handle missing keys.
 */
export function createEmptyLintKindCounts(): LintKindCounts {
	return Object.fromEntries(LINT_KIND_ORDER.map((key) => [key, 0])) as LintKindCounts;
}

/**
 * Convert persisted or caller-provided font family values to a supported option.
 *
 * This keeps the editor resilient to stale settings or arbitrary input while
 * preserving a predictable default.
 */
export function normalizeFontFamily(value: string): EditorFontFamily {
	if (value === 'serif' || value === 'mono') {
		return value;
	}

	return 'sans';
}

/**
 * Resolve an editor font family option to the CSS stack used by the editor.
 *
 * Components call this instead of duplicating font-stack strings or fallback
 * behavior.
 */
export function fontStackFor(value: EditorFontFamily): string {
	return FONT_OPTIONS.find((option) => option.value === value)?.stack ?? FONT_OPTIONS[0].stack;
}

/**
 * Convert persisted or caller-provided font size values to a supported editor size.
 *
 * Numeric values are rounded and clamped so user input cannot produce unreadable
 * or layout-breaking editor text.
 */
export function normalizeFontSize(value: EditorFontSize | string): EditorFontSize {
	if (value === DEFAULT_FONT_SIZE || value == null || value === '') {
		return DEFAULT_FONT_SIZE;
	}

	const numericValue = typeof value === 'number' ? value : Number(value);
	if (!Number.isFinite(numericValue)) {
		return DEFAULT_FONT_SIZE;
	}

	const rounded = Math.round(numericValue);
	return Math.min(28, Math.max(11, rounded));
}

/**
 * Return the user-facing text for an unpacked suggestion.
 *
 * Replacement suggestions show their replacement text, while non-replacement
 * suggestions fall back to their kind so buttons still have meaningful labels.
 */
export function suggestionText(suggestion: UnpackedSuggestion): string {
	return suggestion.replacement_text !== '' ? suggestion.replacement_text : String(suggestion.kind);
}

/**
 * Count whitespace-delimited words for the editor status bar.
 *
 * This lightweight count is intentionally display-oriented and avoids coupling
 * status text to Harper's parser internals.
 */
export function wordCount(text: string): number {
	return text.trim().match(/\S+/g)?.length ?? 0;
}