Skip to content

Latest commit

 

History

History
25 lines (15 loc) · 1.64 KB

README.md

File metadata and controls

25 lines (15 loc) · 1.64 KB

fallow-cov-protocol

CI Crates.io Docs.rs OpenSSF Scorecard License

Versioned JSON envelope types shared between the public fallow CLI and the closed-source fallow-cov production-coverage sidecar.

Why this crate exists

Fallow Cloud, the paid product that adds production data to fallow, uses a two-binary architecture. The open-source fallow CLI handles static analysis and IO. A separate closed-source sidecar (fallow-cov) does V8-to-Istanbul normalization, three-state tracking, and combined scoring. Both sides marshal data through JSON on stdin/stdout. This crate is the single source of truth for that envelope so the two repositories cannot drift.

Versioning

The protocol_version field is a full semver string. Consumers MUST reject mismatched majors and SHOULD forward-accept unknown fields and unknown enum variants (mapped to Unknown sentinel values).

Status

Early access. Breaking changes until 1.0.0.

License

MIT, see LICENSE.