Checkwright

Checkwright companion

Checkwright’s gates over a repository whose specs another toolkit writes. This directory holds what fits each install tier to a Spec Kit or OpenSpec spec tree, and the tests that prove it.

What it holds

  • A recipe per toolkit, in <toolkit>/recipe/: the knob lines that fit the profiles to the toolkit’s layout, applied by init --recipe <toolkit>.
  • A lifecycle layer for OpenSpec, in openspec/lifecycle/: the knob lines that let lifecycle-kit’s stage machine read a change’s in-flight deltas as amendments, applied with --recipe openspec-lifecycle.
  • A Spec Kit extension, in speckit/, whose install command installs Checkwright and applies the Spec Kit recipe for you.
  • A fixture tree per toolkit, in fixtures/, in the toolkit’s own layout, with one planted defect per claimed gate. The consumer smoke installs the profile on each tree, applies the recipe, and asserts the battery green and each defect caught.
  • The tested versions, in toolkits.list.
  • The left-out kits, in exclusions.list: each kit a toolkit’s complement line leaves out, with the toolkit’s own surface that does its job.
  • The toolkits’ own checks, in native.list, which the toolkit leg runs and the support table lists.

Using it

  • Spec Kit: add the extension from a Checkwright release and run its install command (speckit/README.md).
  • OpenSpec: install the prose profile with --recipe openspec.

Each toolkit also has a complement line, which installs every kit but those whose job the toolkit already does, and a full line, which installs every kit and on OpenSpec applies openspec/lifecycle/ too (SPEC.md §The tiers).

What the gates catch in a spec tree, which checks each toolkit gets and the tested versions are on the Spec toolkits page, and each route is on its toolkit’s page: Spec Kit and OpenSpec.

Where the design lives

companion/SPEC.md: how a recipe is applied, each recipe line with the idiom it answers, the lifecycle layer, the tested claim, the fixture rules, the extension’s contract, the pack step, the toolkit legs, the support table and the honest limits.

License

Licensed under Apache-2.0, with the text in LICENSE at the repository root.