@vibecodeqa/schema
v0.4.2
Published
Shared VibeCode QA report schema, types, and check metadata.
Maintainers
Readme
@vibecodeqa/schema
Shared report contract for VibeCode QA.
This package is intentionally a tiny leaf dependency:
- report types
- check metadata
- category weight rollups
- Zod runtime validation
It does not contain scanning logic, file IO, React, Tauri, MCP, or GitHub code.
Usage
import { CHECK_META, parseReport, type VibeReport } from "@vibecodeqa/schema";
const report: VibeReport = parseReport(json);
const checkCount = Object.keys(CHECK_META).length;parseReport() keeps the report shape strict where the vocabulary is truly closed
(grade, issue severity) and forward-compatible where producers evolve over time
(stack detector values, workspace tool names, and extra report fields). Consumers can
validate reports without dropping future CLI data.
Publishing
This package is intended to be published publicly as @vibecodeqa/schema.
The GitHub workflow uses npm OIDC trusted publishing. Before the first release, configure
the npm package/scope to trust the vibecodeqa/schema repository workflow:
- package:
@vibecodeqa/schema - workflow:
.github/workflows/publish.yml - environment: none
Local verification:
pnpm build
pnpm test
npm publish --dry-run --access public