Skip to content

Lint: flag invariants and action.preserves not covered by a test #6

Description

@JAORMX

Summary

Add a lint/completeness signal that flags every invariant.id (entity-level and model-level) and every action.preserves entry that is not referenced by any test in the repo. This is the durable, on-mission version of "wire testing in from the model": modelith already emits completeness findings (e.g. entities with no invariants, entities no scenario touches). This extends that discipline outward to the model↔test relationship.

Why a checker, not a generator

The tempting version — generate a skipped t.Skip test stub per invariant — is a false green: coverage tools count the stub as present, go test passes, CI is green, and the test asserts nothing. A directory of 40 skipped invariant tests reads as "we have invariant coverage" while proving nothing. Worse, the model↔test link is by invariant.id, and renaming an invariant is a first-class modelith operation (IDs sharpen as understanding does) — a generator would then clobber human-written bodies or orphan them.

Checking references instead of generating code turns the false-green inside out: rather than emitting stubs that lie, flag the invariants that lack a real test. It's deterministic, its output is disposable (a finding, not owned code), and it survives renames because it checks references rather than owning generated files.

Open design question (must resolve before building)

modelith today reads a single YAML file; traceability requires knowing what tests exist. Two candidate input surfaces:

  1. Marker convention — tests reference the invariant id in a structured, greppable way (e.g. a comment token or test-name convention); modelith scans a configured test path.
  2. Sidecar manifest — a small mapping file (invariant-id → test reference) that the Skill: author property tests from a model's invariants and actions #5 skill emits and the engineer maintains; modelith validates coverage against it.

Option 2 keeps modelith's "reads declared inputs" character intact and pairs naturally with #5; option 1 is lower-friction but expands modelith into a repo scanner. Decide this first — it's the crux of whether this stays on-mission.

Scope

  • New completeness (or a new "traceability") category finding.
  • Likely warning severity by default (an unproven invariant is a gap, not a structural error), with an opt-in strict mode consistent with how completeness is already treated.
  • Golden/lint-model test coverage consistent with the existing internal/lint conventions.

Relationship to the other issues

Background

Descends from "Tier 2" of a three-tier design discussion, reshaped by a skeptic pass from generate stubs to check references. Consider recording the decision in audits/.

🤖 Generated with Claude Code

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions