Проверка дизайн-системы в pull request: замечания

Когда дизайн-система в коде подключена, FISYCO проверяет по ней каждый pull request в репозитории проекта. Он оставляет один комментарий с замечаниями и ставит на последний коммит проверку FISYCO design system. По умолчанию замечания остаются подсказками, но проверку можно сделать блокирующей.

Перед началом

К проекту подключён репозиторий. См. Подключение репозитория.
Дизайн-система в коде подключена и проиндексирована хотя бы раз. См. Подключение дизайн-системы в коде. До первой индексации проверка молчит: сравнивать не с чем.
На GitHub приложению FISYCO нужно право Checks: read and write, чтобы ставить проверку. Без него комментарий всё равно появится.

Что смотрит проверка

FISYCO запускает проверку, когда pull request на GitHub, merge request на GitLab или pull request на Bitbucket открывают, открывают заново или пушат в него новые коммиты. Читаются только изменённые в pull request файлы .tsx и .jsx на последнем коммите, не больше 60. Файлы вне pull request не читаются.

Эти файлы сравниваются с последним индексом дизайн-системы, с подключёнными к ней библиотеками токенов, иконок и иллюстраций и с правилами вашей команды. Комментарий бот пишет на английском, поэтому в таблице заголовки замечаний даны так, как вы их увидите.

Замечание	Когда появляется
Your team's design system rules	компонент, скрытый вашими правилами, или текст, который команда запретила в коде
This already exists in your design system	компонент вне дизайн-системы, очень похожий на компонент из неё; замечание называет этот компонент и, если может, пример его применения
Deprecated components	компонент с пометкой deprecated, с заменой, если она известна
Colours written past the tokens	цвет, записанный значением, с подходящим токеном, если он есть; сырой токен шкалы вместо семантического; отступ в px, равный значению токена
Icons inlined instead of taken from the library	вставленный в код `<svg>` или SVG-файл в роли картинки, с ассетом библиотеки, если он совпал
Shared components changed here	изменённый компонент дизайн-системы, который применяется в других местах, с числом мест и файлов

Каждое замечание ссылается на файл и строку. В одном комментарии до 12 замечаний, и нарушения правил команды идут первыми.

Комментарий и проверка

Один комментарий на pull request. При каждом push FISYCO правит его, а не добавляет новый. Если push снял все замечания, комментарий сообщит, что прежние замечания устранены. Pull request, где замечаний не было, комментария не получает.
Одна проверка на последнем коммите. Без замечаний она проходит. С замечаниями она нейтральна: видна, но не красная.
GitLab показывает статус коммита, а Bitbucket отчёт, оба с именем FISYCO design system. Нейтрального состояния у них нет, поэтому с замечаниями они проходят, а число замечаний видно в описании.

Каждая выполненная проверка записывается в Журнал дизайн-системы как Пул-реквест проверен.

Сделать проверку блокирующей

Откройте проект, найдите Дизайн-система в коде в разделе Из кода и перейдите в Настройки.
В блоке Проверка пул-реквестов включите Запрещать мерж, пока есть замечания по дизайн-системе. Менять это могут только администраторы пространства.
В правилах защиты веток репозитория отметьте FISYCO design system как обязательную проверку.

С этой настройкой проверка падает, пока остаются замечания, у всех трёх провайдеров, а комментарий сообщает, что пространство требует её прохождения. Мерж она остановит только после шага 3: запрещает его именно правило защиты ветки.

Начните с режима по умолчанию. Посмотрите, какие замечания исправляют, а какие пропускают, настройте правила команды и включайте блокировку, когда замечаниям начнут доверять.

Правила команды

На той же странице Настройки есть блок Правила для ИИ-агентов. Проверка тоже им следует: скрытые компоненты, устаревшие компоненты, текст, запрещённый в коде, и обязательность токенов для цвета и отступов. Если команда выключит Цвет только токенами, цвета значением перестанут давать замечания. Те же правила получают ИИ-агенты через MCP-сервер FISYCO. Подробнее: Правила для ИИ-агентов.

Разговор в pull request от FISYCO

Когда FISYCO открывает pull request с патчем, он отвечает там и на комментарии. Это работает на GitHub: учитываются комментарии, комментарии к строкам и ревью.

На вопрос или замечание FISYCO отвечает списком того, что меняет pull request. Список взят из той же записи, что и описание.
Одобрения и благодарности вроде «LGTM» или эмодзи остаются без ответа. Сообщения ботов тоже.
Ветку по комментарию FISYCO не переписывает. Ветка принадлежит команде, и правка по замечанию остаётся за вами.
В pull request, открытых людьми, FISYCO не отвечает: там работает только проверка, описанная выше.

Как готовятся патчи и когда они открываются, описано в статье Патчи и автономность.