forgeplan coverage
forgeplan coverage сверяет модули, обнаруженные forgeplan scan, с разделами Affected Files в каждом артефакте и сообщает, какие модули не имеют задокументированного решения. Непокрытые модули - это слепые пятна: код, который вы запускаете без какого-либо задокументированного обоснования.
Это представление проекта “знаем ли мы, почему это существует?”. В сочетании с drift (соответствуют ли ADRs по-прежнему коду?) оно обеспечивает полную сверку кодовой базы ⟷ артефактов.
Когда использовать
Заголовок раздела «Когда использовать»- Архитектурный обзор: “какие модули полностью недокументированы?”
- После рефакторинга, который разделил или объединил модули - повторное сканирование, пересчёт покрытия.
- Онбординг: покажите новому члену команды, какие файлы имеют ADRs, которые он должен прочитать в первую очередь.
- Заполнение устаревших данных: используйте
--backfillдля автоматической вставки разделовAffected Filesв артефакты, созданные до требования о связывании модулей.
Когда НЕ использовать
Заголовок раздела «Когда НЕ использовать»- До запуска
forgeplan scan- для покрытия сначала требуется инвентаризация модулей. - В маленьких проектах с 1–2 файлами - сигнал низкий.
Использование
Заголовок раздела «Использование»forgeplan coverage [OPTIONS] --backfill Заполнить раздел "Affected Files" в отсутствующих артефактах -h, --help Вывести справку -V, --version Вывести версиюПримеры
Заголовок раздела «Примеры»Стандартный отчёт о покрытии
Заголовок раздела «Стандартный отчёт о покрытии»forgeplan scan # обновить список модулейforgeplan coverageВывод:
Decision coverage─────────────────covered (5): crates/forgeplan-core/src/scoring ADR-001, PRD-005 crates/forgeplan-core/src/lifecycle ADR-005 crates/forgeplan-core/src/db ADR-002, ADR-003 crates/forgeplan-core/src/search PRD-039, RFC-006 crates/forgeplan-cli/src/commands RFC-001
uncovered (3) ⚠ blind spots: crates/forgeplan-core/src/fpf crates/forgeplan-core/src/routing crates/forgeplan-mcp/src/transport
overall coverage: 62% (5 of 8 modules)Заполнение устаревших артефактов
Заголовок раздела «Заполнение устаревших артефактов»forgeplan coverage --backfillДобавляет раздел-заполнитель ## Affected Files в артефакты, у которых его нет, делая их видимыми для покрытия и drift в будущем. Вам всё равно придётся заполнять список вручную, но структура будет готова.
Фокус на непокрытых модулях
Заголовок раздела «Фокус на непокрытых модулях»forgeplan coverage --json | jq '.uncovered[]'Создаёт плоский список, который можно передать генератору бэклога: “напишите ADR для каждого непокрытого модуля”.
Интерпретация вывода
Заголовок раздела «Интерпретация вывода»| Раздел | Значение |
|---|---|
| covered | модуль → список артефактов, объявляющих его в Affected Files |
| uncovered | модуль с нулевыми ссылками на артефакты - задокументируйте обоснование! |
| overall | процент отсканированных модулей, имеющих хотя бы одно решение |
Здоровый проект имеет покрытие выше 70%. Ниже 50% означает, что вы пишете код интуитивно. 100% обычно является избыточной документацией - некоторым служебным модулям не нужны ADRs.
Как это вписывается в рабочий процесс
Заголовок раздела «Как это вписывается в рабочий процесс»scan → coverage → spot uncovered module → forgeplan new adr → link affected files → re-runПокрытие - это инструмент “что мне документировать дальше?”. Оно превращает архитектурный обзор из “ощущений” в приоритизированный список.
См. также
Заголовок раздела «См. также»forgeplan scan- заполнить инвентаризацию модулейforgeplan drift- вторая половина сверки кодовой базыforgeplan new adr- создать недостающую документациюforgeplan health- включает покрытие в сводку на уровне проекта- Обзор CLI