IF Commons GitHub

commands

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

The commands of the quality system that report on it (commons 0001-quality-evidence FR-015, FR-024, FR-027, FR-030 to FR-040), run by quality.ts: index writes (or --checks) the index of the branch and the objectives' metrics, freshness judges every requirement and opens the nonconformances it calls for, nonconformances lists them and links one to its Problem change request, capa open|verify|close carries a CAPA through its three states, register shows the proof register with the grade and day of each row's evidence, tier judges the tier a harness claims, and attest records a statement, a review or a probe's report as evidence.

Exit status: 0 where it did what was asked and nothing is wrong, 1 where it found something (a stale proof, an index that differs, a tier that is not met) or refused, 2 for a command line that does not fit. The day today is read once, here, from the clock; every judgement below takes it as an argument.

Source: commons/quality/src/commands.ts

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

clockDayfunctionno test imports it
function clockDay(): string

The day today, from the clock: the one place the commands read it.

indexCommandfunctionno test imports it
function indexCommand(rest: readonly string[]): Promise<number>

quality index: the index of the branch, derived from it alone (FR-024).

freshnessCommandfunctionno test imports it
function freshnessCommand(rest: readonly string[]): Promise<number>

quality freshness: every requirement judged by time and by change; with --open the nonconformances it calls for are opened (FR-015, FR-030, FR-038).

nonconformancesCommandfunctionno test imports it
function nonconformancesCommand(rest: readonly string[]): Promise<number>

quality nonconformances: the nonconformances and their CAPA, closed ones kept (FR-031, FR-036); --link records the Problem change request.

capaCommandfunctionno test imports it
function capaCommand(rest: readonly string[]): Promise<number>

quality capa open|verify|close (FR-033 to FR-035).

verificationsfunction
function verifications(repo: string, ledger: Ledger, run: { readonly traceId: string; readonly revision: string | undefi… (17818 characters)
function verifications(repo: string, ledger: Ledger, run: { readonly traceId: string; readonly revision: string | undefined; readonly day: string; readonly cases: readonly { readonly name: string; readonly requirements: readonly string[]; readonly outcome: string; }[]; }): Promise<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 verify CAPA from a run: the named test passed, at a revision that holds the corrective change's last commit (FR-034).

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

runFactsOffunctionno test imports it
function runFactsOf(q: QualityRecord, revision: string | undefined, day: string): { readonly traceId: string; readonly revision: string | undefined; readonly day: string; readonly cases: readonly { readonly name: string; readonly requirements: readonly string[]; readonly outcome: string; }[]; }

The cases of a kept record as the verification of a CAPA reads them.

registerCommandfunctionno test imports it
function registerCommand(rest: readonly string[]): Promise<number>

quality register: the proof register with the grade and day of each row's evidence, generated (FR-027).

queryCommandfunction
function queryCommand(rest: readonly string[]): Promise<number>

quality query "SELECT ...": one read-only SELECT over the runs and the cases kept on the quality branch (relations runs, cases and case_requirements), as a table or with --json (0002-quality-query FR-004, FR-005). It writes nothing; a question that is refused or cannot be answered ends with 1.

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

archiveCommandfunction
function archiveCommand(rest: readonly string[]): Promise<number>

quality archive --tag NAME: where the retention period the harness's record states (retentionDays) has passed for the oldest evidence, a Git tag on the tip of the quality branch archives it; nothing is ever deleted, and there is no option that deletes (FR-050).

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

tierCommandfunction
function tierCommand(rest: readonly string[]): Promise<number>

quality tier: the claim judged against the requirements of the tier and those below it (FR-040).

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

attestCommandfunctionno test imports it
function attestCommand(rest: readonly string[]): Promise<number>

quality attest: a statement (E1), a review (E2) or a probe's typed result (E5) kept as evidence on the branch (FR-026, FR-029).

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