WHAT TECHNOLOGIES GUIDELINES

Единый свод архитектурных стандартов, правил дизайн-системы, принципов KMP-разработки и использования библиотек экосистемы WHAT Technologies.

 

---

Назначение репозитория

Данный репозиторий является единственным источником правды для всех проектов организации WHAT Technologies. Он содержит формализованные правила, архитектурные контракты и дизайн-документы, обязательные для соблюдения как разработчиками, так и AI-агентами (LLM, Cursor, Copilot).

Цель правил:

1. Исключение велосипедов: Запрет на написание кастомного кода для задач, уже решенных в compose-foundation (хуки, хранилище, навигация, диалоги, логирование, иконки).
2. Чистая мультиплатформенность: Полный запрет на механизм expect/actual в бизнес-логике и UI. Вся платформенная специфика изолируется через интерфейсы и внедрение зависимостей (Koin DI).
3. Единая дизайн-система: Строгая темная эстетика (нейтральные тона #09090b), поддержка нескольких стилей тем (Monochrome, Brand Navy, Material You Dynamic, Plum), единые скругления shapes.large и фирменные анимации.
4. Предсказуемый MVI: Строгий контракт однонаправленного потока данных UIController<State, Action, Event>.

---

Навигация по разделам

1. Архитектура и стандарты KMP (architecture/)

• DI и интерфейсы ВМЕСТО expect/actual — фундаментальное правило: никаких expect/actual в фичах, только чистые интерфейсы в commonMain и реализация через Koin.
• MVI UIController и состояние — шаблон UIController<State, Action, Event>, collectStates(), канал CollectAction { }, контракт RemoteState.
• Реактивные хуки состояния — хуки useState, useSave, useChange, useInterval (Foreground Guard). Полный запрет на boilerplate remember { mutableStateOf(...) }.
• Навигация и глобальные окна — NavigationHost, вложенная навигация, BottomNavBar, стековые контроллеры ProvideGlobalDialog и ProvideGlobalSheet.
• Хранилище настроек и шифрование — реактивное хранилище PreferenceStorage, аппаратное шифрование AES-GCM (Android Keystore), делегаты boolean, string, model<T>.

2. Дизайн-система (design/)

• Философия и геометрия — формы, скругления shapes.large, обязательный .clip(...) при скролле, безопасные зоны systemBarsPadding().
• Многотемность и цветовая палитра — спецификация стилей тем (Monochrome, Brand Navy #1F2137, Dynamic Material You, Plum), семантические токены surfaceContainer, surfaceBright, surfaceDim.
• Компоненты интерфейса — правила верстки, SearchBox, StyledTextField, фоновые анимации LiquidBackground, Shimmer.
• Векторные иконки WHATIcons — полный каталог и правила использования фирменных иконок из foundation-ui.

3. Библиотека Compose Foundation (foundation/)

• Каталог 14 модулей и Do vs Don't — таблица соответствия готовых решений библиотек и запрещенных велосипедов.
• Главные антипаттерны — топ-10 ошибок, которые категорически запрещено допускать в кодовой базе.

4. Процессы разработки (process/)

• Чеклист коммита и релизов — порядок проверок, семантическое версионирование, выпуск GitHub Release и RuStore.
• Стандарты оформления README — правила визуального оформления репозиториев (Shields badges #09090b, отсутствие эмодзи).

5. Конфигурация для AI / IDE (configs/)

• .cursorrules — готовый файл правил для Cursor IDE / AI ассистентов.

---

_{© WHAT Technologies. Все права защищены.}