Refactor Assistant
Открыть приложение: Спланировать рефакторинг → (products.documentize.ai)
В одном предложении
Refactor Assistant сканирует репозиторий C# на GitHub в поисках слишком больших классов, скрывающих отдельные обязанности, ранжирует их и, когда вы решите, выносит выбранные части в новые классы и открывает pull request.
Чем он уникален
Он работает в два отдельных шага с человеческим решением между ними. Сканирование (в интерфейсе «suggest») только читает и ничего не меняет. Затем Применить выносит лишь те «швы», которые вы поставили в очередь. Каждый класс показан со своими швами (шов — это одна скрытая обязанность, которую можно вынести), оценкой и вердиктом, так что вы решаете на основании доказательств, а не позволяете ИИ переписывать что вздумается.
Когда использовать и когда нет
- Используйте для классов C#, которые разрослись до «делает всё», когда вам нужен ранжированный список того, что разделять.
- Не для документации → Repo Docs. Не для полной структурной карты → Code Graph.
- Не для языков, кроме C#.
- Не как проверка сборки. Страница прямо говорит: Documentize никогда не собирает и не запускает ваш код, так что проверкой сборки служит ваш CI для pull request.
Прежде чем начать
- Репозиторий GitHub (
owner/nameили URL) с кодом на C#. Приватный репозиторий: сначала дайте доступarise-project, как сказано в подсказке на странице. - Для Применить: нужно быть авторизованным, а страница сообщает, что «Применить» требует платного плана и занимает от 10 до 30 минут на шов.
- Конфиденциальность: код читается для анализа; «Применить» записывает ветку и pull request от имени
arise-project. Считайте, что репозиторий доступен этому аккаунту и службе языковой модели, используемой для анализа (точный поток данных проверьте в работающем приложении).
Пошаговая инструкция
- Введите репозиторий GitHub и при желании Ветку.
- Выберите, сколько Кандидатов показывать (10, 25 или 50), или введите одно имя класса для проверки (необязательно).
- Запустите сканирование. Прочитайте плитки (просканировано классов, кандидаты, найдено швов, уже отрефакторено, отклонено, слишком большие) и список.
- Отфильтруйте по проекту или вердикту, откройте класс, чтобы увидеть его структуру, и откройте каждый шов: оценка, связность (cohesion), места вызова для делегирования, что уходит вместе с ним, что остаётся.
- Предпросмотр плана: контракт, под который будет написан новый класс, и что переносится. Пока ничего не создаётся.
- Добавьте в очередь применения нужные швы (не более 5 за запуск), выберите Один pull request, один коммит на каждый шов или Один запрос на слияние на шов и нажмите Применить.
- Следите за шагами (План, Контракт, Генерировать, Исправить цикл, Сборка, Обзор, Коммит) и откройте pull request. Соберите его своим CI.
Параметры
| Параметр | Что делает | По умолчанию | Рекомендуется |
|---|---|---|---|
| Ветка | Ветка для анализа и для открытия pull request | ветка по умолчанию | Используйте стабильную ветку |
| Кандидаты для отображения | Размер ранжированного списка: 10, 25 или 50 | 10 | Сначала 10 |
| Проверьте один класс | Сканировать только один класс, показав каждый шов, включая уже закрытые | пусто | Когда вы уже подозреваете какой-то класс |
| Вердикт (фильтр) | Стоит разделить, Инфраструктура, Слишком тесно связано, Урегулировано, Не оценено | все | Начните с «Стоит разделить» |
| Проект (фильтр) | Ограничивает список одним проектом | все | Используйте в больших решениях |
| Режим (Применить) | Один pull request с одним коммитом на шов или один pull request на шов в отдельной ветке | один PR | Один PR на шов, если ваша команда проверяет мелкое |
Что вы получите
- Сканирование: отчёт на странице, сохранённый как запуск, который можно открыть снова. Есть также История всего, что решено по репозиторию (отклонено, предложено, извлечено), видимая после входа.
- Применить: pull request с извлечёнными классами и сводкой файлов и проверок. Исходы по каждому шву: В запросе на слияние, Не стоит обзора, Не удалось, Пропущено, Не начато, Время истекло. Если ничего не сохранено, pull request не открывается.
Качество и ограничения
- Сканирование — только анализ; «Применить» — это код, созданный ИИ, не скомпилированный Documentize. Проверяйте каждый pull request и перед слиянием дайте отработать CI.
- У сканирования есть лимит времени; репозиторий, слишком большой, чтобы просканировать его вовремя, отклоняется с сообщением. «Применить» занимает несколько минут на шов.
- Не более 5 швов за один запуск «Применить».
Хорошо сочетается с
- До: Code Graph, чтобы увидеть форму решения.
- После: Repo Docs, чтобы описать новую структуру.
- Связанное: Доверие, проверка и ограничения результатов ИИ.
Типичные ошибки и их исправление
- «Choose at least one seam» → сначала просканируйте, поставьте в очередь шов, затем «Применить».
- «At most 5 seams» → остальное поставьте в очередь для второго запуска.
- «A seam reference is not valid» → результат устарел; просканируйте снова.
- Ожидание скомпилированного результата → pull request — это предложенный код; сборка — ваш CI.
- «This result is no longer available» → просканируйте снова.
То же в других каналах
Для этого приложения не проверено. См. каналы.
Попробуйте
Просканируйте публичный репозиторий C# с «Кандидаты для отображения» = 10. Откройте верхний класс с вердиктом «Стоит разделить», прочитайте его первый шов и нажмите Предпросмотр плана. Не применяйте; оцените, совпадает ли предложенное разделение с тем, как вы сами разрезали бы этот класс.