Code Graph
Открыть приложение: Построить граф кода репозитория → (products.documentize.ai)
В одном предложении
Code Graph берёт репозиторий GitHub с кодом на C#, разбирает его решение (solution) и выдаёт одну базу данных SQLite, в которой собраны проекты, типы, члены и связи между ними.
Чем он уникален
Результат — данные, а не документ. Вместо PDF или веб-страницы вы получаете файл .sqlite, который можно открыть любым инструментом для SQLite и самому делать запросы: «какие типы зависят от этого?», «что находится в этом проекте?». Это делает его структурной основой для инструментов, аудитов и знакомства с кодом, а также хорошим дополнением к тексту, который пишет Repo Docs.
Когда использовать и когда нет
- Используйте, когда вам нужна карта кодовой базы .NET, к которой можно делать запросы, — перед тем как вы присоединитесь к проекту, проведёте его ревью или рефакторинг.
- Не если вам нужна читаемая документация → Repo Docs.
- Не для вопросов о скомпилированной библиотеке → Assembly Chat.
- Не для кода не на C#. Code Graph разбирает решения на C#.
Прежде чем начать
- Репозиторий должен быть на GitHub; вводится как
owner/nameили полный URLhttps://github.com/owner/name. URL ветки из браузера (.../tree/dev) тоже работает и выбирает эту ветку. - В нём должен быть файл
.sln. Приложение выбирает самое неглубоко лежащее решение, отдавая предпочтение тому, чьё имя похоже на имя репозитория, и игнорирует папки вродеbin,obj,node_modulesи всё, что начинается с точки. Один запуск строит один граф по одному решению; если в репозитории несколько решений, берётся то, которое выберет приложение (на странице выбрать его нельзя). - Приватный репозиторий? Сначала пригласите аккаунт GitHub
arise-projectкак соавтора, как сказано в подсказке на странице. Без доступа запуск завершится сообщением о доступе.
Пошаговая инструкция
- Откройте Code Graph.
- Введите репозиторий GitHub.
- При желании введите Ветку (если пусто, используется ветка по умолчанию).
- Запустите. Сообщения о ходе работы показывают «Downloading owner/name», затем «Building the graph of <solution> @ <commit>».
- Когда закончится, скачайте файл
.sqlite.
В тексте страницы также упоминаются описания назначения, эмбеддинги и размещённый API запросов. В форме ввода, которую я просмотрел, есть только репозиторий и ветка, и ничто в просмотренном запуске не создаёт сводок или конечной точки для запросов (проверьте в работающем приложении).
Параметры
| Параметр | Что делает | По умолчанию | Рекомендуется |
|---|---|---|---|
| Репозиторий GitHub | Репозиторий для разбора (owner/name или URL, до 300 символов) | обязательно | Вставьте URL из браузера |
| Ветка | Ветка для разбора (до 200 символов). Имя ветки не может начинаться с -, содержать .., пробелы или специальные символы вроде ~ ^ : ? * [ | ветка по умолчанию | Называйте явно, когда работаете в ветке с новой функцией |
Других элементов управления нет.
Что вы получите
- Один файл с именем вида
owner-name-<первые 7 символов коммита>.sqlite, так что по имени точно видно, какой коммит был разобран. - Сводку результата: репозиторий, ветка, полный коммит и путь к использованному решению.
- Ваш репозиторий не изменяется.
Качество и ограничения
- Детерминированный разбор кода, а не догадка ИИ: то, что есть в графе, взято из исходников C#. Код, генерируемый при сборке, или лежащий вне решения, там не окажется.
- У запуска есть лимит времени. Если репозиторий слишком велик, чтобы разобрать его вовремя, запуск останавливается с сообщением об этом и о том, что подписка снимает лимит.
- Репозиторий без
.slnотклоняется с понятным сообщением. - Репозиторий скачивается как копия только для чтения на время запуска. Отправляется ли что-нибудь в языковую модель, для этого приложения не показано (проверьте в работающем приложении).
Хорошо сочетается с
- После: Repo Docs для читаемой документации того же репозитория; Refactor Assistant для классов, которые стоит разделить.
- Связанное: Assembly Chat для скомпилированной формы библиотеки.
Типичные ошибки и их исправление
- «is not a GitHub repository» → используйте
owner/nameили URL github.com; другие хосты не принимаются. - «has no .sln file» → в репозитории только файлы
.csprojили решение в другом формате. Добавьте или создайте файл решения либо используйте Repo Docs, который принимает и.csproj. - Ошибка доступа к приватному репозиторию → пригласите
arise-projectи повторите. - «not a valid branch name» → уберите пробелы и специальные символы.
То же в других каналах
Для этого приложения не проверено. О том, что есть для других приложений, см. каналы.
Попробуйте
Запустите Code Graph на небольшом публичном репозитории на C# с файлом решения в корне, например на любом знакомом вам примере приложения. Откройте скачанный .sqlite в программе для просмотра SQLite, посмотрите список таблиц и найдите строки, описывающие ваши проекты и типы.