Line

You are reading the unreleased docs (next). See latest (v0.9)

ui/client/features/spec-breakdown/domain/SpecBreakdownView

(R6) -- pure view-model builders (DOMAIN-001: no fetch, no React, no dates).

Cockpit client (features), next. Source: ui/client/features/spec-breakdown/domain/SpecBreakdownView.ts.

Type Aliases#

SentenceView#

SentenceView = ReadBackSentence & object

Defined in: ui/client/features/spec-breakdown/domain/SpecBreakdownView.ts:28

Type Declaration#

tone

tone: "ok" | "warn" | "error"

Functions#

coverageSummary()#

coverageSummary(readBack): string

Defined in: ui/client/features/spec-breakdown/domain/SpecBreakdownView.ts:39

One line summarizing whether the requirement is fully accounted for, for a heading.

Parameters#

readBack

ReadBack

Returns#

string


rowsByGroup()#

rowsByGroup(readBack, group): SpecRow[]

Defined in: ui/client/features/spec-breakdown/domain/SpecBreakdownView.ts:24

Rows of one group only, in the table's declared order (states, events, transitions, functions).

Parameters#

readBack

ReadBack

group

SpecRowGroup

Returns#

SpecRow[]


sentenceViews()#

sentenceViews(readBack): SentenceView[]

Defined in: ui/client/features/spec-breakdown/domain/SpecBreakdownView.ts:34

The read-back's sentences, each tagged with a display tone: covered is the calm default, an explicit out-of-scope call is a deliberate decision (warn, not an error), and uncovered is the one state that means "the spec does not account for this sentence" (error) -- the "diff against the original requirement" the acceptance criteria asks for: every original sentence, and whether the spec accounts for it.

Parameters#

readBack

ReadBack

Returns#

SentenceView[]


specRows()#

specRows(readBack): SpecRow[]

Defined in: ui/client/features/spec-breakdown/domain/SpecBreakdownView.ts:10

The spec's states/events/transitions/functions, one row per id, in first-seen order across sentences.

Parameters#

readBack

ReadBack

Returns#

SpecRow[]