Documentation
¶
Overview ¶
Package samples provides the canonical sample scorecard used to drive the landing page hero and the app's dev-seed data. The fixture is hand-built rather than captured from a real scan so the numbers stay stable and don't leak details about real orgs.
Fixture() is the single source of truth; consumers either call scanner.GenerateReport(samples.Fixture()) in process (the app's dev-seed does this) or pipe `go run github.com/CodatusHQ/scanner/cmd/generate-sample` into a Markdown file (codatus.com refreshes its committed copy this way). No rendered .md is committed in this repo - the fixture is the artifact.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Fixture ¶
func Fixture() scanner.ScanResult
Fixture returns a deterministic ScanResult for the fictional "acme-corp" org. The shape is tuned so the generated scorecard exercises every section: Scored rules table with mixed pass rates, Score callout in the Moderate range, Additional checks table, all three buckets in Repository details (Strong / Moderate / Weak), Rule reference (split by category), and a Skipped section.
Types ¶
This section is empty.
Source Files