Skip to content

Make CLI lesson output easier to read - #227

Open
skovranek wants to merge 5 commits into
mainfrom
8533_ms_feat_readable_cli_output
Open

skovranek wants to merge 5 commits into
mainfrom
8533_ms_feat_readable_cli_output

Conversation

@skovranek

@skovranek skovranek commented Nov 4, 2026 •

Copy link
Copy Markdown
Member

resolves bootdotdev/go-api-gate#8533.

  1. Replace boxed test output with numbered step headings, grouped checks, and indented diagnostic sections.
  2. Put failed checks first and show expected/actual values for exit codes, HTTP statuses, and failed JSON assertions.
  3. Preserve the run/submit distinction: runs show expectations and output without grading labels; submissions show PASS/FAIL and a final failure summary with the command or request.
  4. Keep the existing running/submitting lesson wording, including next-lesson selection and submission confirmation. Retain the header in the final report.
  5. Add green PASS, red FAIL, bold step headings, muted labels, and a local run-only option for testing without grading. Include the v1.33.0 version bump.

Run — correct application

All 33 steps are displayed with expectations and actual output, without grading labels.

Full run output — correct application

Long lesson run, correct application

Run — incorrect application

All 33 steps still appear. The changed checkout response is visible as output, but the run does not mark checks as passing or failing.

Full run output — incorrect application

Long lesson run, incorrect application

Submit — passing checks

Passing — default

All 33 successful steps are summarized.

Long lesson submit passing, default

Passing — verbose

All 33 steps are expanded with checks, response bodies, and captured variables.

Full verbose submit output — all checks pass

Long lesson submit passing, verbose

Submit — failing check

Failing — default

Steps 1–15 remain compact. Step 16 expands to show the request and its expected/actual HTTP status, followed by the failure summary.

Long lesson submit failing, default

Failing — verbose

The successful steps, failing step, and later ungraded checks retain their detailed output. The final summary identifies step 16.

Full verbose submit output — failure at step 16

Long lesson submit failing, verbose

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant