Когда репозиторий подключён, FISYCO проверяет каждый pull request на соответствие вашей дизайн-системе. Он оставляет один комментарий с замечаниями и ставит на коммит проверку «FISYCO design system». На этой странице описано, что проверяется, как читать замечания и как сделать проверку блокирующей.
Перед началом
- К проекту подключён репозиторий. См. Подключение репозитория.
- Для проекта настроена дизайн-система в коде: откройте проект и найдите Дизайн-система в коде в разделе Из кода.
- На GitHub приложению FISYCO нужно право на запись проверок. Если вы установили его до появления проверок, GitHub попросит подтвердить новое право.
Что проверяется
При каждом push в pull request на GitHub, merge request на GitLab или pull request на Bitbucket FISYCO читает изменённые файлы .tsx и .jsx. Он ищет:
Читаются только изменённые файлы, поэтому pull request не упрекают за код, которого он не касался.
Комментарий и проверка
- Один комментарий на pull request. FISYCO обновляет его при каждом push, а не добавляет новые. Когда замечания устранены, комментарий сообщает об этом.
- Одна проверка на последнем коммите. Без замечаний она проходит. С замечаниями она по умолчанию нейтральна: это подсказка, а не ошибка.
- GitLab и Bitbucket показывают результат как статус коммита или отчёт с тем же именем. В GitLab нет нейтрального статуса, поэтому там замечания отображаются как проваленная проверка.
Сделайте проверку блокирующей
- Откройте Дизайн-система в коде → Настройки.
- В разделе Проверка пул-реквестов включите Запрещать мерж, пока есть замечания по дизайн-системе. Изменить эту настройку могут только администраторы пространства.
- В правилах защиты веток вашего репозитория отметьте «FISYCO design system» как обязательную проверку.
С этой настройкой проверка падает, пока есть замечания. Мерж она останавливает, только когда её требует правило защиты ветки.
Советуем начать с настройки по умолчанию. Посмотрите, какие замечания исправляют, а какие игнорируют, настройте правила команды и включите блокировку, когда замечаниям начнут доверять.
Правила команды
В тех же настройках можно добавить правила, за которыми следит проверка:
- Компоненты, которые агентам нельзя брать: одно имя компонента на строку. Использование такого компонента становится замечанием.
- Скрывать устаревшие компоненты: поиск больше их не предлагает, а использование такого компонента считается нарушением правила.
- Запрещено в коде: текст, который не должен появляться в коде, и то, что использовать вместо него.
Те же правила получают ИИ-агенты через MCP-сервер FISYCO, поэтому агент узнаёт их до того, как напишет код.