Skip to content

Show actionable CLI output with a reproducible sample page - #377

Open
galafis wants to merge 1 commit into
pa11y:mainfrom
galafis:docs-actionable-output-example
Open

galafis wants to merge 1 commit into
pa11y:mainfrom
galafis:docs-actionable-output-example

Conversation

@galafis

@galafis galafis commented Oct 24, 2026

Copy link
Copy Markdown

Add a small HTML page with a missing language attribute and show its actual CLI output in the README. Explain the issue count, selector, source excerpt, page summary, stdout/stderr and default exit status. The same example also shows how adding lang="en" changes the result.

Closes #87.

Validation on Node 24 / Windows:

  • Ran the sample against the real bundled browser: one issue, exit 2.
  • Added the matching language attribute in a temporary copy: zero issues, exit 0.
  • All 59 unit tests pass.
  • ESLint has no errors and reports the existing max-statements warning in testRunner.
  • git diff --check passes.

The displayed absolute path is shortened; terminal wrapping is called out in the text.

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.

Include output sample in documentation.

1 participant