@systemfsoftware/stryker-js-cli-contract

The Stryker CLI product contract. It is implementation-free: nothing here imports the CLI, and the CLI imports everything here. The machine stream the stryker executable writes, the version that stream declares, the stock mutator catalog and the span taxonomy are all defined once, in this package, and the published JSON Schema documents are generated from those definitions.

Install

pnpm add @systemfsoftware/stryker-js-cli-contract

Entry point

The package groups its exports into namespaces. RunEvent holds the machine stream: the RunEvent union of every event kind the CLI emits, each event's class, the RunEventWireLine newline-delimited JSON codec a consumer decodes stdout with, and StreamSchemaVersion (6.0, the version the stream declares). OutputMode holds the output mode and its signal (OutputMode, ModeSignal) as the stream header carries them. StockCatalog holds the stock mutator catalog and its name vocabulary (StockCatalog, StockMutatorName, StockDefaultName, StockOptInName). SpanTaxonomy holds the names the CLI's traces use and each member's attributes (Spans, SpanName, SpanMember, spanMembers), plus rpcServedSpanOf for the RPC method spans a plugin worker serves.

import { RunEvent } from '@systemfsoftware/stryker-js-cli-contract'

const decoded = Schema.decodeUnknownResult(RunEvent.RunEventWireLine)(line)

Published documents

The package commits the documents generated from its contracts and exports them as subpaths, so a consumer can validate against the same bytes the contract declares:

• @systemfsoftware/stryker-js-cli-contract/contract/stream.schema.json — the JSON Schema of the RunEvent union.
• @systemfsoftware/stryker-js-cli-contract/contract/stock-catalog.json — the stock catalog entries.
• @systemfsoftware/stryker-js-cli-contract/contract/span-taxonomy.json — the span names and their attributes.

Every committed document equals its generated form: a test in this package regenerates each one from its contract and fails when the committed bytes differ. Run pnpm --filter @systemfsoftware/stryker-js-cli-contract generate:contract to rewrite them and review the diff; never hand-edit one.

Compatibility

The package's version tracks the contract it publishes. Removing or narrowing a declared member of a published document — an event kind, a catalog entry or its name or tier, a span or one of its attributes — is an incompatible change: the version guard fails it until the package takes a major bump (minor while the package is 0.x), and a breaking change to the stream additionally raises the major segment of the StreamSchemaVersion the schema declares. Additive changes need no bump.

License

Apache-2.0. Part of systemfsoftware.