Skip to content

Add a machine-readable fixture summary command #63

Description

@knytcomics-ui

Category

Good First

Summary

Add npm run report to emit deterministic JSON summarizing fixture counts, score bands, risk patterns, transaction files, version, and file hashes.

Current Behavior

The validator prints limited textual counts, but consumers must parse raw files for structured dataset information.

Problem

Review and release automation cannot reliably consume a stable dataset summary.

Why This Matters

A machine-readable report improves contributor feedback, release review, and research automation.

Proposed Scope

Implement a dependency-free reporting script with stable field names and ordering.

Acceptance Criteria

  • npm run report emits valid deterministic JSON.
  • Output includes label/type/risk-pattern counts.
  • Output includes transaction files, version, and hashes.
  • Repeated runs are byte-identical when inputs are unchanged.
  • README documents the command.

Technical Considerations

Use package.json, destinations.json, scores.json, CHANGELOG.md, and transactions/.

Testing Requirements

Verify output against the current dataset and stable ordering.

Cross-Repository Impact

None identified; research may consume the report later.

Out of Scope

Do not implement the broader analytics proposed in issue #10.

Complexity

One bounded script and documentation update.

Impact

Medium — improves dataset transparency and automation.

Suggested Labels

good first issue, area: tooling, area: fixtures

Metadata

Metadata

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardThird CampaignCampaign: Third Campaignarea: fixturesDestination and transaction fixture coveragearea: toolingAuthoring and automation scriptsenhancementNew feature or requestgood first issueGood for newcomers

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions