{"_id":"@a11yst/reporters","_rev":"3-4486f37af5dff41272c027007331f630","name":"@a11yst/reporters","dist-tags":{"latest":"1.0.2"},"versions":{"1.0.0":{"name":"@a11yst/reporters","version":"1.0.0","license":"MPL-2.0","_id":"@a11yst/reporters@1.0.0","maintainers":[{"name":"angelabenavente","email":"ang.ben.dev@gmail.com"}],"homepage":"https://github.com/angelabenavente/a11yst#readme","bugs":{"url":"https://github.com/angelabenavente/a11yst/issues"},"dist":{"shasum":"9c3196846fa53f63cc2a67d1cc5b17716610950a","tarball":"https://registry.npmjs.org/@a11yst/reporters/-/reporters-1.0.0.tgz","fileCount":67,"integrity":"sha512-rcU+yXiHYdRaPR5IRRn1YYiWUvvchEKfZ924RlexDNz0XWlrmzcCEELHaitOtmXq0misv5f+q73LaWL4coZBzw==","signatures":[{"sig":"MEYCIQDWGXXKgXUQaT16kBBEIoANu6Y2O7ngl8Mcao1tGW6HYgIhAMXTHxS59ELaTP+z/f4UxZEEc1pIWHkMCyfxbovFIamj","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":247670},"main":"./dist/index.js","type":"module","_from":"file:a11yst-reporters-1.0.0.tgz","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"scripts":{"build":"tsc -p tsconfig.json","clean":"rm -rf dist *.tsbuildinfo","typecheck":"tsc -p tsconfig.json --noEmit"},"_npmUser":{"name":"angelabenavente","email":"ang.ben.dev@gmail.com"},"_resolved":"/private/var/folders/tf/l5jz90dj0yncc_ds04tbfs5c0000gn/T/0aaeda818c139275242e6baabc735fd5/a11yst-reporters-1.0.0.tgz","_integrity":"sha512-rcU+yXiHYdRaPR5IRRn1YYiWUvvchEKfZ924RlexDNz0XWlrmzcCEELHaitOtmXq0misv5f+q73LaWL4coZBzw==","repository":{"url":"git+https://github.com/angelabenavente/a11yst.git","type":"git"},"_npmVersion":"10.9.0","description":"Static report generation for a11yst audit results","directories":{},"_nodeVersion":"22.12.0","dependencies":{"@a11yst/sarif":"1.0.0","@a11yst/types":"1.0.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.7.2","@types/node":"^22.10.2"},"_npmOperationalInternal":{"tmp":"tmp/reporters_1.0.0_1787506243293_0.7377910802177206","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"@a11yst/reporters","version":"1.0.1","license":"MPL-2.0","_id":"@a11yst/reporters@1.0.1","maintainers":[{"name":"angelabenavente","email":"ang.ben.dev@gmail.com"}],"homepage":"https://github.com/angelabenavente/a11yst#readme","bugs":{"url":"https://github.com/angelabenavente/a11yst/issues"},"dist":{"shasum":"e5a66e537e37bf2564e266179c8d4dda63012aa1","tarball":"https://registry.npmjs.org/@a11yst/reporters/-/reporters-1.0.1.tgz","fileCount":67,"integrity":"sha512-eztXHt+1oe2zXv9axWESxQBKZ6iOlxu0UIURmWyScFmAX/YQIndlkLZ62guwf272ZsqZAtlTAqY0DbcUdhspAw==","signatures":[{"sig":"MEUCIC8dgup9Jj8b+Anz5u9cYi2kPMFGcP+zQGJntAL9O2ZBAiEAnspPAkCGiMV2bgN9DQFZ1FJNu46xio2TzZN8AGDsB3U=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"},{"sig":"MEQCIDO+UhXMW7ujA+4h8oIgYSzlh65KEr/m6qcCzSznDFb+AiBQbQ6f4QsTvI/Gpk2bF9YyBA5AFXZK2BQLvCfcji0e2g==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":247670},"main":"./dist/index.js","type":"module","_from":"file:a11yst-reporters-1.0.1.tgz","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"scripts":{"build":"tsc -p tsconfig.json","clean":"rm -rf dist *.tsbuildinfo","typecheck":"tsc -p tsconfig.json --noEmit"},"_npmUser":{"name":"angelabenavente","email":"ang.ben.dev@gmail.com"},"_resolved":"/private/var/folders/tf/l5jz90dj0yncc_ds04tbfs5c0000gn/T/0277ba034f0716764ca90643a4f94f99/a11yst-reporters-1.0.1.tgz","_integrity":"sha512-eztXHt+1oe2zXv9axWESxQBKZ6iOlxu0UIURmWyScFmAX/YQIndlkLZ62guwf272ZsqZAtlTAqY0DbcUdhspAw==","repository":{"url":"git+https://github.com/angelabenavente/a11yst.git","type":"git"},"_npmVersion":"10.9.8","description":"Static report generation for a11yst audit results","directories":{},"_nodeVersion":"22.23.1","dependencies":{"@a11yst/sarif":"1.0.1","@a11yst/types":"1.0.1"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.7.2","@types/node":"^22.10.2"},"_npmOperationalInternal":{"tmp":"tmp/reporters_1.0.1_1787508738902_0.8321057482806915","host":"s3://npm-registry-packages-npm-production"}},"1.0.2":{"_id":"@a11yst/reporters@1.0.2","bugs":{"url":"https://github.com/angelabenavente/a11yst/issues"},"dist":{"shasum":"5aeed3197e5c86ece9a9aed6e8718be1f1a42624","tarball":"https://registry.npmjs.org/@a11yst/reporters/-/reporters-1.0.2.tgz","fileCount":67,"integrity":"sha512-PQfZcw4IqfI2wLsObTXIw4NrplSbfV0MGIhwaVvMkyFvXtZnJ5Fx0D3yd3lkoBI+fNPvEGMpvT+43F2m6KdTtw==","signatures":[{"sig":"MEQCIHj6J3UWEmz6Dpc4uGv7wkhvUdYAsqt+O+CAiWAqLo8UAiBo1FikmMGVfSMRAveQ3cX2j3vDKxzM1Srg/kzH9oZknw==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"},{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQDuAYsJdPvef1EnMhhlzAI1ZimXBCWdpG7w/KbgWq+aoAIgTrMoshL8GzcnY8Uax9L+G8gvXGsVsVVIaNPMykX93nw="}],"unpackedSize":247998},"main":"./dist/index.js","name":"@a11yst/reporters","type":"module","_from":"file:a11yst-reporters-1.0.2.tgz","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"license":"MPL-2.0","scripts":{"build":"tsc -p tsconfig.json","clean":"rm -rf dist *.tsbuildinfo","typecheck":"tsc -p tsconfig.json --noEmit"},"version":"1.0.2","_npmUser":{"name":"angelabenavente","email":"ang.ben.dev@gmail.com"},"homepage":"https://www.a11yst.dev","_resolved":"/private/var/folders/tf/l5jz90dj0yncc_ds04tbfs5c0000gn/T/2bc4b9c9f1aa8ab6ff4c001f9523af4a/a11yst-reporters-1.0.2.tgz","_integrity":"sha512-PQfZcw4IqfI2wLsObTXIw4NrplSbfV0MGIhwaVvMkyFvXtZnJ5Fx0D3yd3lkoBI+fNPvEGMpvT+43F2m6KdTtw==","repository":{"url":"git+https://github.com/angelabenavente/a11yst.git","type":"git"},"_npmVersion":"10.9.8","description":"Static report generation for a11yst audit results","directories":{},"maintainers":[{"name":"angelabenavente","email":"ang.ben.dev@gmail.com"}],"_nodeVersion":"22.23.1","dependencies":{"@a11yst/sarif":"1.0.2","@a11yst/types":"1.0.2"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.7.2","@types/node":"^22.10.2"},"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/reporters_1.0.2_1787683178480_0.7687632491701701"}}},"time":{"created":"2026-08-23T17:30:43.155Z","modified":"2026-08-25T18:39:38.752Z","1.0.0":"2026-08-23T17:30:43.448Z","1.0.1":"2026-08-23T18:12:19.008Z","1.0.2":"2026-08-25T18:39:38.575Z"},"bugs":{"url":"https://github.com/angelabenavente/a11yst/issues"},"license":"MPL-2.0","homepage":"https://www.a11yst.dev","repository":{"url":"git+https://github.com/angelabenavente/a11yst.git","type":"git"},"description":"Static report generation for a11yst audit results","maintainers":[{"name":"angelabenavente","email":"ang.ben.dev@gmail.com"}],"readme":"# `@a11yst/reporters` [![NPM version](https://img.shields.io/npm/v/@a11yst/reporters.svg?style=flat)](https://www.npmjs.com/package/@a11yst/reporters) [![License: MPL-2.0](https://img.shields.io/badge/License-MPL--2.0-blue.svg)](LICENSE) [![NPM total downloads](https://img.shields.io/npm/dt/@a11yst/reporters.svg?style=flat)](https://www.npmjs.com/package/@a11yst/reporters)\n\nStatic reporting for a11yst `AuditExecutionResult` documents.\n\n## Public API\n\n### HTML\n\n- `generateHtmlReport({ auditResult, outputDirectory, auditId? })` writes\n  `report/index.html`, `report/styles.css`, and `report/report.js`.\n- `renderHtmlReport(result, options?)`, `renderReportStyles()`, and\n  `renderReportScript()` return individual report assets as strings.\n\n### Markdown\n\n- `generateMarkdownReport(input, options?)` returns deterministic GitHub Flavored\n  Markdown from audit results, policy evaluation, and baseline summaries.\n- Bundle path during audit: `reports/a11yst.md`\n- Enable with `a11yst audit --markdown` or `reports.markdown` in config.\n- Custom copy: `a11yst audit --markdown-output <path>`\n- Offline generation: `a11yst report --from results.json --format markdown --output a11yst.md`\n\nMarkdown reports summarize CI policy status, lifecycle counts, breaches, comparison\ncoverage, classifications, and artifact links. They do not assert WCAG conformance.\n\n### GitHub Actions annotations\n\n- `generateGitHubAnnotations(input, options?)` returns workflow commands as a string\n  (not written to stdout by a11yst).\n- Bundle path during audit: `reports/github-annotations.txt`\n- Enable with `a11yst audit --github-annotations`\n- Custom copy: `a11yst audit --github-annotations-output <path>`\n- Offline generation: `a11yst report --from results.json --format github-annotations`\n\nIn GitHub Actions, pipe the artifact file to stdout in your workflow step, for\nexample `cat reports/github-annotations.txt`. a11yst does not upload results,\ncreate PR comments, or call GitHub APIs.\n\nAnnotations are limited to policy breaches, policy not-evaluated errors, and\noperational run failures. Known, resolved, and not-compared findings do not\ngenerate individual annotations by default.\n\nSource file locations are included only when a validated relative `sourceLocation`\nexists on a finding. a11yst does not invent paths.\n\n### GitHub Step Summary\n\n- `a11yst audit --github-step-summary` appends the same Markdown report to the\n  path in `GITHUB_STEP_SUMMARY` when that variable is set.\n- Does not require `--markdown` unless you also want the bundle artifact.\n- Does not expose the absolute Step Summary path in manifest or results.\n- Preserves existing summary content via append.\n\n### Shared\n\n- `readAuditResult(path)` parses and validates a persisted result.\n- `validateAuditResultDocument(value)` validates the schema boundary consumed\n  by reporters. Schema version `\"1\"` is currently supported.\n\n## Security and privacy\n\nReport text is escaped for HTML and Markdown. GitHub workflow commands use\nproperty and message escaping to prevent command injection. Keep generated\ndirectories and evidence together, and treat bundles as sensitive. a11yst does\nnot upload report data or implement telemetry.\n\nComplete GitHub Actions workflow templates are added in Phase 9g.\n\n## Report accessibility\n\nHTML reports include semantic landmarks, skip links, labeled controls, and\nreduced-motion styles. These features do not change audit limitations:\n\na11yst does not certify WCAG conformance.\n\nAutomated checks cover only part of accessibility.\n\nManual review and testing with disabled users remain necessary.\n","readmeFilename":"README.md"}