style: format docs markdown

This commit is contained in:
2026-09-09 04:13:13 +05:00
parent 46da54140c
commit 64e35f4fdf
36 changed files with 2092 additions and 1187 deletions
+32 -32
View File
@@ -1,12 +1,11 @@
# План: закрытие техдолга перед переездом `old/` (C17)
> Статус: план к выполнению. Ветка `feat/redesign`.
> Входит в гейт перед переездом старых файлов в `old/` (backlog №14; см. также
> Статус: план к выполнению. Ветка `feat/redesign`. Входит в гейт перед
> переездом старых файлов в `old/` (backlog №14; см. также
> `archive/plan-migrate-remaining.md` — техдолг «чинить по заведённым задачам,
> не игнорировать правилами»).
> Целевое состояние по завершении: `svelte-check` → 0 errors, `pnpm test` →
> зелёный, `lint:all` → без ошибок (допустим только задокументированный остаток),
> дизайн-токены → единый словарь `preview.css`.
> не игнорировать правилами»). Целевое состояние по завершении: `svelte-check` →
> 0 errors, `pnpm test` → зелёный, `lint:all` → без ошибок (допустим только
> задокументированный остаток), дизайн-токены → единый словарь `preview.css`.
## Состав техдолга (на 2026-09-07)
@@ -15,9 +14,9 @@
svelte-check, висит на каждом прогоне.
- **фейл теста** — `src/lib/palette.test.ts`: `ENOENT src/app.css` (файл
разъехался на `old.css` + `design2.css` при редизайне). Тест проверял
контрасты палитры по токенам старого `app.css` (`text/surface/bg/link/
accent/danger/border`). При гейтах `pnpm test` красный, хотя 607 тестов
проходят.
контрасты палитры по токенам старого `app.css`
(`text/surface/bg/link/ accent/danger/border`). При гейтах `pnpm test`
красный, хотя 607 тестов проходят.
- **design-tokens в `kit/**`** — ~335 ошибок `lint:all` от локального плагина
`eslint-plugins/design-tokens` (захардкоженные цвета/размеры/длительности/
z-index/`color-mix()` в `<style>`-блоках svelte), плюс stylelint по CSS.
@@ -43,46 +42,47 @@
### Этап 2 — миграция `kit/**` на design-токены (main объём)
Цель — `lint:all` без ошибок design-tokens (все примитивы/`color-mix()`
уходят в токены `preview.css`).
Цель — `lint:all` без ошибок design-tokens (все примитивы/`color-mix()` уходят в
токены `preview.css`).
**Вариант А (основной): авто-фикс одноразовым скриптом.**
Писать скрипт ТОЛЬКО если он гарантированно ничего не испортит. Гарантии:
**Вариант А (основной): авто-фикс одноразовым скриптом.** Писать скрипт ТОЛЬКО
если он гарантированно ничего не испортит. Гарантии:
- Скрипт — одноразовый (`web/scripts/fix-design-tokens.mjs`), после прогона
удаляется либо помечается неактуальным.
- Строгая карта замен: примитив → токен **1:1, только если значение точно
совпадает с уже существующим токеном словаря** `preview.css`
(цвет → `--color-*`/`--brand-*`, радиус → `--radius-*`, размер →
совпадает с уже существующим токеном словаря** `preview.css` (цвет →
`--color-*`/`--brand-*`, радиус → `--radius-*`, размер →
`--space-*`/`--size-*`, длительность → `--duration-*`, z-index → `--z-*`).
Никаких новых токенов скрипт не генерирует.
- Замены — только примитивы, не содержащие `var()`/`calc()`/`color-mix()`;
исключения по правилам плагина (0, 0px, 1px, проценты, unitless) не
трогаются. `color-mix()` → выносится в `preview.css` как производный
`--color-*` токен (может требовать ручного решения имени).
исключения по правилам плагина (0, 0px, 1px, проценты, unitless) не трогаются.
`color-mix()` → выносится в `preview.css` как производный `--color-*` токен
(может требовать ручного решения имени).
- Скрипт обрабатывает только `src/lib/components/kit/**` и `src/preview.css`
(scoped-пути плагина) и только `<style>`-блоки/`.css` — логику/разметку не
меняет, только строки стилей.
- После прогона: обязательный дифф-ревью (все изменения — замена значений на
`var(--x)`, ничего удалено/переставлено), затем полный `lint:all` +
`svelte-check` + `pnpm test`. Если хоть что-то вне «замена примитива на
токен» — скрипт считается проваленным, откатываем и переходим на вариант Б.
`svelte-check` + `pnpm test`. Если хоть что-то вне «замена примитива на токен»
— скрипт считается проваленным, откатываем и переходим на вариант Б.
**Вариант Б (страховка): руками, пакетами по компонентам.**
Если скрипт не удался — чистим/заводим токены вручную, пакетами по компонентам
(12 на задачу, диф < ~500 строк). Отсутствующие токены (например
`--space-2xl`/`--space-panel`, уже дважды обходились в SchemaTextSource)
добавляем в словарь `preview.css` осознанно.
**Вариант Б (страховка): руками, пакетами по компонентам.** Если скрипт не
удался — чистим/заводим токены вручную, пакетами по компонентам (12 на задачу,
диф < ~500 строк). Отсутствующие токены (например `--space-2xl`/`--space-panel`,
уже дважды обходились в SchemaTextSource) добавляем в словарь `preview.css`
осознанно.
Гейт этапа: `pnpm --dir web lint:all` — только допустимый остаток (неиспользуемые
токены — варнинг), плюс регресс-прогон тестов и svelte-check.
Гейт этапа: `pnpm --dir web lint:all` — только допустимый остаток
(неиспользуемые токены — варнинг), плюс регресс-прогон тестов и svelte-check.
### Этап 3 — чистота словаря `preview.css`
- Разобрать варнинги неиспользуемых токенов (check-tokens): либо использовать,
либо удалить из словаря.
- После этапа 2 — повторный аудит токенов (`pnpm --dir web exec node
scripts/check-tokens.mjs`): parity light/dark, hct-only, без мёртвых токенов.
- После этапа 2 — повторный аудит токенов
(`pnpm --dir web exec node scripts/check-tokens.mjs`): parity light/dark,
hct-only, без мёртвых токенов.
### Этап 4 — финальные гейты (гейт переезда `old/`)
@@ -92,12 +92,12 @@
4. `pnpm --dir web lint:all` → 0 (или только задокументированный остаток)
5. Обе ветки открываются: старый UI `/`, новый `/preview`
После зеленых гейтов — закрытие задач и переход к `backlog` №14
(переезд старых файлов в `old/`).
После зеленых гейтов — закрытие задач и переход к `backlog` №14 (переезд старых
файлов в `old/`).
## Порядок и коммиты
- Коммиты атомарные, < ~500 строк (AGENTS). По завершении каждой мини-задачи —
ревью (агент не коммитит).
- Техдолг чинится по заведённым задачам, правила линтеров не отключаются и не
игнорируются.
игнорируются.