Skip to content

report

Рендерит человеко-читаемый (или CI-читаемый) отчёт по скану.

Синопсис

archora report [path] [--format md|html|junit|json] [--base <file>] [options]

Опции

ОпцияПо умолчаниюЗначение
--format <fmt>mdОдин из md (алиас markdown), html, junit, json.
--output, -o <file>Запись отчёта в файл. Иначе — stdout.
--base <file>Baseline-снапшот. Сейчас влияет только на Markdown-формат.
--quietГлушит "Wrote …" в stderr.

Форматы

ФорматДля чегоЗаметки
mdPR-комментарии, командные чаты, GitHub IssuesЕсли задан --base, добавляется секция «What changed».
htmlСамодостаточный артефакт для архиваОдин файл, без внешних ассетов.
junitCI test-репортеры (GitLab, Jenkins, GitHub)Каждый цикл / нарушение слоя становится <testcase failure>.
jsonТо же, что analyzeИдентично выводу archora analyze.

Примеры

bash
# Markdown для PR-комментария
archora report . --format md -o report.md

# HTML, который можно открыть локально или приложить к билду
archora report . --format html -o report.html

# JUnit для GitHub-вкладки "Tests" через dorny/test-reporter
archora report . --format junit -o reports/archora.xml

# Markdown с диффом против baseline
archora report . --format md --base baseline.json -o report.md

В паре с check

report не валит билд — всегда возвращает 0 (или 2 при ошибке вызова). Связывайте с check, если хотите и красивый отчёт публиковать, и билд валить:

bash
archora report . --format md -o report.md --quiet
archora check . --fail-on grade:D --fail-on cycles:0

Выпущено под лицензией BUSL-1.1.