feat: emit per-check progress to stderr during runs - #108
Open
danielcalvolopez wants to merge 1 commit into
Open
danielcalvolopez wants to merge 1 commit into
danielcalvolopez wants to merge 1 commit into
Conversation
Between the "Running checks on..." banner and the final report, afdocs was silent, making a slow run indistinguishable from a hung one. The runner now exposes an onProgress callback on RunnerOptions that fires start/complete events per selected check, and the CLI renders them as numbered stderr lines: [7/24] llms-txt-directive-html... done (47 tested, 3 fetch errors, 12s) The start fragment is written without a trailing newline so a stalled check leaves its name visible on screen. Completion lines include the tested-page and fetch-error counts from check details, doubling as a live signal of bot-protection interference (agent-ecosystem#104). Progress goes to stderr for every output format so json/scorecard stdout stays parseable; the new -q/--quiet flag suppresses it (and the banner) for clean CI logs. Closes agent-ecosystem#105
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #105
What changed
Between the
Running checks on <site>...banner and the final report, afdocs emitted nothing, so on a slow or hostile site there was no way to distinguish "working through many slow requests" from "hung" without inspecting the process from outside. This adds lightweight check-level progress on stderr:RunnerOptionsgains an optionalonProgresscallback that fires astartandcompleteevent per selected check, carryingindex/total, theCheckResult, and wall-clock duration. The library API stays output-agnostic; event types are exported from the public API.details, doubling as an early live signal of the bot-protection interference pattern from Run-level diagnostic for bot-protection interference (spec v0.6.0bot-protection-interference) #104.-q, --quiet: suppresses progress and the banner for clean CI logs.json, pipedscorecard) is never contaminated.Per the issue's notes, this implements check-level granularity only (the best effort/value point); per-page ticks within multi-page checks are left as a possible follow-up.
Testing
--quiet, json stdout stays parseable). Full suite: 1360 passing.--quietproduces zero stderr bytes,-f json > report.jsonstays parseable while progress streams to the terminal.docs/reference/cli.md.