goblindegook/musarrif

Purpose and runtime entry points

Muṣarrif is an offline-capable Arabic verb conjugator and recognition-drill PWA, with a Tauri 2 desktop wrapper. The browser UI starts at src/ui/main.tsx, composes application routing/state in src/ui/app.tsx, and is built from index.html through Vite. Desktop startup is Rust/Tauri at src-tauri/src/main.rs, configured by src-tauri/tauri.conf.json.

Lexicon and localization boundary

The curated lexical source is src/data/roots.json: roots, verb forms, vowel patterns, voice/nominal support, and related metadata. Human-facing root and verb labels are separate locale datasets in src/ui/locales/en.verbs.json, src/ui/locales/it.verbs.json, and src/ui/locales/pt.verbs.json. This separation lets deterministic grammar operate on transliterated lexical metadata while the UI renders localized text.

Conjugation engine

Pure TypeScript paradigm modules transform a selected root/verb plus grammatical dimensions into conjugated Arabic forms and explanatory annotations. Key orchestration and domain boundaries are src/paradigms/conjugation.ts, src/paradigms/verbs.ts, and src/paradigms/roots.ts; tense/voice implementations are partitioned under src/paradigms/active/, src/paradigms/passive/, and src/paradigms/nominal/. Search resolves user input into roots and verbs through src/paradigms/search.ts.

Reference-mode flow

Users navigate to lookup/conjugation views through src/ui/routes.ts and src/ui/pages/ConjugationMode.tsx. src/ui/organisms/ConjugateBox.tsx collects search and grammatical selections, invokes the paradigm/search layer, and presents output via src/ui/organisms/ConjugationTable.tsx plus insight panels. The UI is therefore a consumer of grammar-domain results, rather than embedding morphology rules.

Exercise and SRS flow

Exercise mode is coordinated in src/ui/pages/ExerciseMode.tsx. src/exercises/exercises.ts selects exercise types; focused generators in src/exercises/generators/ create prompts, answers, and distractors from paradigm data. Answer outcomes feed scheduling and progress logic in src/exercises/srs.ts, src/exercises/scheduler.ts, and src/exercises/mastery.ts. This isolates learning policy from both UI rendering and conjugation rules.

Client persistence and device capabilities

Browser-facing hooks maintain local user state—SRS data, settings/dimensions, favorites, recents, and stats—behind src/ui/hooks/useSrsStore.ts, src/ui/hooks/useDimensionStore.ts, and src/ui/user-data.ts. Speech and speech recognition are optional browser capabilities via src/ui/hooks/useSpeech.ts and src/ui/hooks/useSpeechRecognition.ts. Optical transfer components (src/ui/organisms/OpticalSend.tsx, src/ui/organisms/OpticalReceive.tsx) support local data exchange without a backend.

External systems and maintenance pipeline

The deployed web target is a static Vite PWA; no application server or database is represented. Tauri supplies the desktop host. Node/TypeScript scripts maintain lexicon and validate external references: scripts/verb.mts edits lexical/localization data, while scripts/lib/elixirfm.mts, scripts/lib/reverso.mts, and scripts/lib/wiktionary.mts fetch external conjugation sources to generate regression expectations. CI is defined in .github/workflows/ci.yml.