Сгенерировано из grain.synx (bun run docs). Не править руками.
Полный стандарт — docs/. Проверка — bun grain.
- Чтение:
findgetlistcount - Ввод-вывод:
readwrite - Хранилище:
loadsave - Вычисление:
makederiveresolve - Преобразование:
parseformatencodedecodenormalizesignverifyhash - Мутация домена:
createdeletearchiverestore - Состояние:
ensureassertapplyset - Связь:
emitsend - Жизненный цикл:
startstop - Только UI:
usewithrender
Контракты: find* может вернуть null и никогда не бросает; get* гарантирует значение;
list* всегда коллекция; count* число. Предикат называется булевым префиксом, а не глаголом:
is* has* can* should* was* will* must*.
Запрещены: handle* → назови действие: submitLogin, retryPayout; process* → derive / apply / transform-глагол по существу; manage* → разбей на конкретные действия; do* → назови действие; perform* → назови действие; execute* → apply / start; check* → is* для ответа, assert* для инварианта; init* → start (процесс) / make (значение); update* → save / apply / set; fetch* → read (I/O) / load (агрегат); retrieve* → get / find; calculate* → derive; compute* → derive; generate* → make; build* → make; setup* → ensure / start; validate* → assert (бросает) / parse (возвращает разбор); transform* → derive / format; convert* → format / encode; prepare* → make; determine* → resolve; deal* → назови действие; run* → start / apply; trigger* → emit / send
- Единицы (число без суффикса — ошибка):
AtMsSecMinHoursDaysBytesKbMbGbCentsRatioPctCountIndexPxDegHzBpmDb - Безразмерные:
xyzidwidthheightdepthportpagelimitoffsetversionpriority - Булевы префиксы:
ishascanshouldwaswillmust - Слова-пустышки в именах:
datainfoobjobjecttemptmpstuffmiscthingthingsresretarrstrnumflagvalresulthelperhandlermanagerwrapperutilutils - Самопохвала:
enhancedadvancedcomprehensiveultimaterobustpowerfulseamlesssmartintelligentoptimizedimprovedmodernsimpleeasyquick - Разрешённые сокращения:
idurluridbiorpcttlutcapisqlcsshtmljsonjwts3ipdnscdnuims - Сокращение → слово:
cfg→configusr→userreq→requestres→responsemsg→messageerr→erroridx→indexbtn→buttonimg→imagesrc→sourcedst→targetdest→targetval→valuearr→liststr→textnum→numbercnt→countprev→previouscurr→currentattr→attributeelem→elementevt→eventfn→actioncb→actionopts→optionsargs→argumentsdesc→descriptiondoc→documentacc→accumulator
Порядок слов: домен → уточнение → единица (refreshTtlSec, priceCents).
Типы без префиксов и суффиксов: Track, не ITrack/TrackDTO. any не существует.
*.entry.ts — точка входа процесса; *.route.ts — HTTP; *.rpc.ts — gRPC; *.store.ts — единственное место с SQL/ORM; *.wire.ts — клиент к чужому API; *.policy.ts — правила доступа, чисто; *.shape.ts — типы и схемы; *.event.ts — контракты событий; *.job.ts — фон и крон, идемпотентно; *.pure.ts — чистые вычисления, ноль I/O
- Запрещённые имена файлов:
utilsutilhelpershelpercommonsharedmisclibmaintypesconstantsservicemanagerhandlerindex - Запрещённые каталоги:
utilshelperscommonsharedmisclibcorestuffservicescontrollersmanagershandlers - Имена от фреймворка (оставить как есть):
pagelayouttemplateloadingerrornot-foundglobal-errorroutemiddlewaresitemaprobotsopengraph-imageiconapple-iconmanifestdefaultinstrumentationmodbuild
Каталог называется по домену, не по технике. Глубина внутри src — не больше 3
(под app/pages/kotlin/java/Sources не считается: там иерархия это URL).
Публичный вход пакета — public.ts. Только именованные экспорты.
Событие — свершившийся факт: v1.{домен}.{предмет}.{что произошло}, причастие из закрытого списка
(activated added approved archived banned cancelled changed created decided deleted enrolled executed, …). Не команда: v1.invoice.paid, не v1.payInvoice.
Живой сабджект не переименовывают — это миграция, а не рефакторинг.
Пять тегов, ничего кроме: why: perf: safety: spec: ref:.
Комментарий отвечает «почему», а не «что». Запрещены TODO, ASCII-разделители, эмодзи,
нумерация шагов, JSDoc, повторяющий сигнатуру.
- вложенность ≤ 2, аргументов ≤ 3, функция ≤ 40 строк, файл ≤ 400
- воронка: guard → acquire → derive → effect, всегда в этом порядке
catchобязан пробросить дальше или вернуть типизированный отказ- код отказа —
домен.предмет.причина(auth.token.expired) - независимые
await— черезPromise.all
Время, случайность и process.env берутся только в ролях entry route rpc job wire —
внутрь домена они приходят аргументом. Зависимости направлены внутрь:
pure → pure, shape; policy → pure, shape, policy; shape → shape; store → shape, pure, store; wire → shape, pure, wire; event → shape, pure, event.
// grain:allow <правило> — <причина> — причина обязательна.
Долг легаси записан в baseline.synx: гейт валит только новое.