IF Commons GitHub

pure/ladder

Written to: 1 requirement: 1 proved, 0 partly, 0 failing, 0 with no test recorded. 0001-quality-evidence FR-014

The evidence ladder of each requirement (commons 0001-quality-evidence FR-014, FR-016, FR-026 to FR-029): what each piece of evidence of a requirement is worth (E1 a statement, E2 a review, E3 a run, E4 a run kept chained and signed, E5 a probe of the system in operation), the grade of the requirement as the highest grade of its fresh evidence, whether it is counted proved at the grade its risk asks, the review debt as a number, and the nonconformances the system opens itself from a failed or a stale proof (FR-015).

  • A run is the newest run that names the requirement: it proves it where a case passed and none failed; it is graded as the quality branch grades it (E3, E4), and an older run is superseded by it. A case that did not run proves nothing (FR-013, FR-019).
  • A review made by an agent is said so in the record (by) and is graded no higher than E2 (FR-029).
  • A count of proved requirements is shown only with its grade and the review debt beside it (FR-014, FR-028): showProofCount refuses to show one that lacks either.

Pure: it reads records and judgements it is given; host/gather.ts finds them with real git. The grade a requirement needs follows its risk (FR-016): E3 and, where one of its tests is of high risk (0008-test-evidence FR-001), E4.

import { judgeRequirement, reviewDebt } from "./ladder.ts";

Source: commons/quality/src/pure/ladder.ts

19 of 31 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.

RunResulttypeno test imports it
type RunResult = "pass" | "fail" | "unproven";

What a run showed of one requirement: it passed, failed, or proved nothing (every case that names it was skipped, cancelled, a todo or not_run).

RunEvidencetypeno test imports it
type RunEvidence = { readonly kind: "run"; readonly requirement: string; readonly traceId: string; /** The UTC d… (558 characters)
type RunEvidence = {
  readonly kind: "run";
  readonly requirement: string;
  readonly traceId: string;
  /** The UTC day the run ended, `YYYY-MM-DD`. */
  readonly day: string;
  readonly at: Instant;
  readonly revision?: string;
  /** The grade the quality branch gives the run (`E3`, `E4`); `E3` where it is not kept. */
  readonly grade: Grade;
  readonly result: RunResult;
  readonly risk: Risk;
  /** The files of the tests that name it. */
  readonly files: readonly string[];
  /** What failed, or why nothing ran. */
  readonly detail: string;
};

The newest run's evidence of one requirement.

AttestedEvidencetypeno test imports it
type AttestedEvidence = {
  readonly kind: "statement" | "review" | "probe";
  readonly requirement: string;
  readonly day: string;
  readonly at: Instant;
  /** Whether a person or an agent made it (FR-029); a probe is neither. */
  readonly by?: "person" | "agent";
  readonly who?: string;
  readonly result: "pass" | "fail";
  readonly sample?: boolean;
  readonly source?: string;
};

A person's or an agent's statement (E1), review (E2) or a probe's report (E5) of one requirement.

Evidencetype
type Evidence = RunEvidence | AttestedEvidence;

A piece of evidence of a requirement.

Imported by 11 tests of the run (11 passed, 0 failed): the library's results

evidenceOfRunfunction
function evidenceOfRun(q: QualityRecord, grade: Grade): readonly RunEvidence[]

The requirements a record's cases name, and what the run showed of each (the cases that ran or did not).

Imported by 17 tests of the run (17 passed, 0 failed): the library's results

evidenceOfLedgerfunction
function evidenceOfLedger(l: Ledger): readonly AttestedEvidence[]

The evidence the ledger holds: its statements, reviews and probes, each at noon of its day.

Imported by 16 tests of the run (16 passed, 0 failed): the library's results

gradeOfEvidencefunction
function gradeOfEvidence(e: Evidence): Grade

What a piece of evidence is worth on its own (FR-026, FR-029): a passing run its grade, a statement E1, a review E2 (an agent's no higher), a passing probe E5; what failed or proved nothing is E0.

Imported by 16 tests of the run (16 passed, 0 failed): the library's results

gradeRequiredfunction
function gradeRequired(risk: Risk): Grade

The grade a requirement needs to be counted proved (FR-016) by its risk alone: E4 where one of its tests is of high risk, else E3.

Imported by 17 tests of the run (17 passed, 0 failed): the library's results

regulatedInProductionfunction
function regulatedInProduction(declaration: Declaration | undefined, today: string): boolean

Whether a harness is regulated and in production on today: it declares a regulated domain (0020-ifccm FR-010) and its production day has come. The declaration and the day are arguments, never read here.

Imported by 6 tests of the run (6 passed, 0 failed): the library's results

gradeNeededfunction
function gradeNeeded(risk: Risk, declaration: Declaration | undefined, today: string): Grade

The grade a requirement needs to be counted proved (FR-016): E3, E4 where one of its tests is of high risk, and E4 for every requirement of a harness that declares a regulated domain and has declared production by today.

Imported by 6 tests of the run (6 passed, 0 failed): the library's results

AssuranceContexttypeno test imports it
type AssuranceContext = { readonly declaration: Declaration | undefined; readonly today: string };

What a harness has declared and the day it is judged on: the two facts the grade a requirement needs depends on besides its risk (FR-016).

Judgedtypeno test imports it
type Judged = { readonly evidence: Evidence; readonly grade: Grade; readonly freshness: FreshnessVerdict };

A piece of evidence and its freshness (FR-030).

Judgementtypeno test imports it
type Judgement = { readonly requirement: string; /** The highest grade of its fresh evidence (FR-026); `E0` where it… (1047 characters)
type Judgement = {
  readonly requirement: string;
  /** The highest grade of its fresh evidence (FR-026); `E0` where it has none. */
  readonly grade: Grade;
  /** The day of the evidence that gives the grade. */
  readonly day?: string;
  /** The freshness of that evidence, or `None` where the requirement has none that counts. */
  readonly freshness: FreshnessState | "None";
  readonly risk: Risk;
  readonly required: Grade;
  /** Whether it is counted proved: its grade is at least what its risk asks (FR-016). */
  readonly proved: boolean;
  /** The newest run or probe of it that failed, which opens a nonconformance (FR-015). */
  readonly failed?: Judged;
  /** The best evidence of it that is stale where nothing fresh gives its grade: a stale proof opens a nonconformance (FR-030). */
  readonly stale?: Judged;
  /** How many of its newest run's cases did not run. */
  readonly unproven: boolean;
  /** Whether a statement or a review of an agent gives the grade (said so in the record, FR-029). */
  readonly byAgent: boolean;
};

A requirement as the ladder judges it.

supersedingfunction
function superseding(evidence: readonly Evidence[]): readonly Evidence[]

The newest evidence of each kind that supersedes: only the newest run of a requirement and its newest probe count; every statement and review does. A correction is a new run that supersedes the first (0021-ifqs edge cases), which stays on the branch.

Imported by 11 tests of the run (11 passed, 0 failed): the library's results

judgeRequirementfunction
function judgeRequirement(requirement: string, judged: readonly Judged[], context?: AssuranceContext | undefined): Judgement

One requirement judged from all the evidence of it, each piece with the freshness the caller found (FR-026, FR-030, FR-016).

Imported by 17 tests of the run (17 passed, 0 failed): the library's results

reviewDebtfunction
function reviewDebt(js: readonly Judgement[]): number

The review debt (ifqs:ReviewDebt, FR-028): how many requirements' best fresh evidence is E1 or E2.

Imported by 11 tests of the run (11 passed, 0 failed): the library's results

reviewDebtByAgentfunction
function reviewDebtByAgent(js: readonly Judgement[]): number

The review debt that rests on an agent's statement or review (0001-quality-evidence FR-051): counted apart from a person's, because an agent's review is graded below a run.

Imported by 11 tests of the run (11 passed, 0 failed): the library's results

reviewDebtByPersonfunction
function reviewDebtByPerson(js: readonly Judgement[]): number

The review debt that rests on a person's statement or review (0001-quality-evidence FR-051).

Imported by 11 tests of the run (11 passed, 0 failed): the library's results

Summarytypeno test imports it
type Summary = { readonly requirements: number; readonly byGrade: Readonly<Record<Grade, number>>; readonly proved… (704 characters)
type Summary = {
  readonly requirements: number;
  readonly byGrade: Readonly<Record<Grade, number>>;
  readonly proved: number;
  /** How many proved requirements stand at each grade. */
  readonly provedByGrade: Readonly<Record<Grade, number>>;
  /** The review debt in all: the sum of the two that follow (FR-051). */
  readonly reviewDebt: number;
  /** The part of the review debt that rests on an agent's evidence (FR-051). */
  readonly reviewDebtByAgent: number;
  /** The part of the review debt that rests on a person's evidence (FR-051). */
  readonly reviewDebtByPerson: number;
  readonly stale: number;
  /** Requirements whose newest run proved nothing. */
  readonly unproven: number;
};

The counts of a set of judgements: how many requirements are at each grade, how many are proved and at what grade, and the review debt.

summarizefunction
function summarize(js: readonly Judgement[]): Summary

The summary of judgements.

Imported by 11 tests of the run (11 passed, 0 failed): the library's results

shareAtOrAbovefunctionno test imports it
function shareAtOrAbove(s: Summary, grade: Grade): number

The share of requirements at a grade or above, from 0 to 1 (1 where there are none to judge).

ProofCounttypeno test imports it
type ProofCount = {
  readonly proved: number;
  readonly provedByGrade: Readonly<Record<Grade, number>>;
  readonly reviewDebt: number;
};

A count of proved requirements as it may be shown: with the grade it is counted at and the review debt (FR-014, FR-028).

showProofCountfunction
function showProofCount(count: { readonly proved: number; readonly provedByGrade?: Readonly<Record<Grade, number>> | undefined; readonly reviewDebt?: number | undefined; readonly reviewDebtByAgent?: number | undefined; readonly reviewDebtByPerson?: number | undefined; }): Result<string, string>

A count of requirements proved as text, never without its grade and its review debt (FR-014, FR-028, SC-003): a count that lacks the grade it is counted at, or the review debt, is refused. The text is 12 proved (E4 2, E3 10), review debt 3.

Imported by 11 tests of the run (11 passed, 0 failed): the library's results

DebtJudgementtypeno test imports it
type DebtJudgement = { readonly ok: boolean; readonly message: string };

The review debt judged against the revision before it (FR-028): it MUST NOT grow without a Decision.

judgeDebtfunction
function judgeDebt(previous: number | undefined, now: number, decided: boolean): DebtJudgement

Whether the review debt at a revision is allowed: no more than at its parent, or a Decision covers the growth.

Imported by 11 tests of the run (11 passed, 0 failed): the library's results

nonconformancesFromfunction
function nonconformancesFrom(js: readonly Judgement[], ledger: Ledger, day: string): readonly (import("/home/runner/work… (17620 characters)
function nonconformancesFrom(js: readonly Judgement[], ledger: Ledger, day: string): readonly (import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"plan-registered">; id: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; plan: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ title: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; cases: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<readonly import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ name: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; requirements: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<readonly import("/home/runner/work/.github/.github/commons/core/src/brand").Brand<string, "RequirementId">[]>; acceptance: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }, { file: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }>[]>; }, Record<never, never>>>; by: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ name: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }, { role: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }>>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, Record<never, never>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"sample-drawn">; id: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; subject: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"agent-reviews" | "records" | "runs">; rule: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"hash-ranked/1">; seed: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; population: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ count: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<number>; sha256: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/brand").Brand<string, "Sha256">>; }, Record<never, never>>>; size: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<number>; items: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<readonly string[]>; by: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ name: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }, { role: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }>>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, { ratePermille: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<number>; }> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"sample-attested">; sample: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; results: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<readonly import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ item: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; verdict: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"fail" | "pass">; }, { note: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }>[]>; person: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ name: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }, { role: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }>>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, {}> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"mutation-run">; id: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; tool: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ name: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }, { version: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }>>; revision: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; results: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<readonly import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ requirement: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/brand").Brand<string, "RequirementId">>; mutants: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<number>; killed: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<number>; survived: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<number>; }, { timeout: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<number>; noCoverage: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<number>; equivalent: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<number>; }>[]>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, Record<never, never>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"nonconformance-opened">; id: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; requirement: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/brand").Brand<string, "RequirementId">>; cause: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"budget-spent" | "failed" | "probe-failed" | "stale">; reason: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; evidence: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{}, { traceId: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; path: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; revision: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }>>; openedBy: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"system">; }, Readonly<Record<string, import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<unknown>>>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"agent">; name: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }, Readonly<Record<string, import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<unknown>>>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"role">; role: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }, Readonly<Record<string, import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<unknown>>>>>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, {}> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"nonconformance-linked">; id: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; problem: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ number: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<number>; }, { repo: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }>>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, Readonly<Record<string, import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<unknown>>>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"capa-opened">; id: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; nonconformance: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; action: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; test: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ requirement: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/brand").Brand<string, "RequirementId">>; name: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }, Record<never, never>>>; correctiveRevision: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; openedBy: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"system">; }, Readonly<Record<string, import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<unknown>>>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"agent">; name: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }, Readonly<Record<string, import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<unknown>>>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"role">; role: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }, Readonly<Record<string, import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<unknown>>>>>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, { author: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"capa-verified">; id: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; traceId: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; revision: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, Readonly<Record<string, import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<unknown>>>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"capa-closed">; id: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; decision: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ id: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; person: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, { role: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }>>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, Readonly<Record<string, import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<unknown>>>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"nonconformance-closed">; id: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; capa: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, Readonly<Record<string, import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<unknown>>>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"statement">; requirement: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/brand").Brand<string, "RequirementId">>; by: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"agent" | "person">; who: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, { note: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"review">; requirement: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/brand").Brand<string, "RequirementId">>; by: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"agent" | "person">; who: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, { sample: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<boolean>; }> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"probe">; requirement: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/brand").Brand<string, "RequirementId">>; outcome: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"fail" | "pass">; source: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, Readonly<Record<string, import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<unknown>>>>)[]

The events that open the nonconformances the judgements call for (FR-015): one for each requirement whose newest result failed, one for each whose proof is stale; none where one is already open for it.

Imported by 11 tests of the run (11 passed, 0 failed): the library's results

RegisterRowtype
type RegisterRow = { readonly requirement: string; readonly mechanism: string; readonly by: string; readonly note: string };

A row of the proof register (enforcement.tsv, 0003-mizan FR-005).

Imported by 6 tests of the run (6 passed, 0 failed): the library's results

parseRegisterfunction
function parseRegister(text: string): readonly RegisterRow[]

The rows of enforcement.tsv: its four columns; comment lines, blank lines and the header are not rows.

Imported by 11 tests of the run (11 passed, 0 failed): the library's results

REGISTER_VIEW_HEADERconstno test imports it
const REGISTER_VIEW_HEADER: string

The generated header of the register's view.

registerViewfunction
function registerView(rows: readonly RegisterRow[], judgements: ReadonlyMap<string, Judgement>): string

The register shown with the grade and the day of the evidence of each row, generated and never written by hand (FR-027): the rows of enforcement.tsv in their order, each with the grade of the requirement, the day of the evidence that gives it, its freshness and whether it is counted proved; the totals follow, with the review debt beside the count of proved (FR-014, FR-028).

Imported by 11 tests of the run (11 passed, 0 failed): the library's results

bestGradefunctionno test imports it
function bestGrade(gs: readonly Grade[]): Grade

The best grade of a list, for callers that fold grades.

Titles, headings, exports, tables, columns and requirements. Esc closes.