Commons (1 of 6)
8 specifications, 144 requirements. All libraries
0001 Software supply chain
| Requirement | Mechanism | Who | Note |
|---|---|---|---|
FR-001 | check | bun test ./tests/ | Layout: the files the specification names are there |
FR-002 | check | bun test ./tests/ | Generated and Generator: the files say they are generated, carry .auto. and are what the tool makes |
FR-003 | check | bun test ./tests/ | Module: the TypeScript module says what the TOML says; archon's own check follows its wiring |
FR-004 | check | archon: archon test | archon's SBOM tests: components carry package URLs of the type the table names, percent-encoded, and the document validates against SPDX 3.0.1 |
FR-005 | check | archon: archon test | archon's SBOM tests: pinned programs carry the lock's download address and SHA-256, system packages the manager that supplied them |
FR-006 | check | bun test ./tests/ | Generated: a family is verified only with where and when, and a catalogued family has no assurance |
FR-007 | none | a property of the text, read by a person |
0002 Packaging
| Requirement | Mechanism | Who | Note |
|---|---|---|---|
FR-001 | check | bun test ./tests/ | Generator: a term with no definition is refused; Layout: the files are there |
FR-002 | check | bun test ./tests/ | Generated: every manager and operating-system row of upt is in the table |
FR-003 | check | bun test ./tests/ | Generated: upt is credited with its licence and the identifier left out is said |
FR-004 | check | bun test ./tests/ | Generated: a supported family is complete and says how far it has been tried; Generator: a verified family with no where or when is refused |
FR-005 | check | bun test ./tests/ | Generated: pacman -Sy and AUR helpers are prohibitions with reasons, and nothing usable is forbidden; Generator: a forbidden command is refused |
FR-006 | check | bun test ./tests/ | Generated: a command is a list of words with no shell syntax; Generator: shell syntax is refused |
FR-007 | check | bun test ./tests/ | Generated: every detecting ID detects one family; Generator: two families claiming one ID are refused |
FR-008 | check | bun test ./tests/ | Generated: required programs are named for every supported family |
FR-009 | check | bun test ./tests/ | Generator: the committed files and the TypeScript module are what the ontology makes, the same bytes twice, and a hand edit fails --check |
FR-010 | check | bun test ./tests/ | Generator: every rule broken is named and nothing is written |
FR-011 | check | bun test ./tests/ | Generated: the schema, the source hash and the content |
FR-012 | check | bun test ./tests/ | ShellFragment: marks, POSIX sh, shellcheck, and what each function answers |
FR-013 | check | archon: archon test | archon's packaging tests: only an allowed executable is run, shell syntax and forbidden commands are refused |
FR-014 | check | bun test ./tests/ | Pins: the env file, the TOML and the TypeScript module agree, and Bun is pinned on every platform; Generator: a bad checksum, a pin with no version and a repeated key are refused |
FR-015 | check | archon: archon test | archon's pin tests: its built-in pins are the file commons generates, and the store reads them |
FR-016 | check | bun test ./tests/ | Record: the fields, their order and their values, as the TypeScript module carries them; Generator: a bad field is refused |
FR-017 | check | bun test ./tests/ | Pins: a pinned platform has an address, a format and a folder, an unpinned one says why, and the pins state each |
FR-018 | check | bun test ./tests/ | Generator: an address that is not https, holds a user name, a format that is none of three, a folder that leaves its root, a half-stated checksum and a checksum twice are each refused |
FR-019 | check | bun test ./tests/ | Pins: the env file, the TOML and the module carry the addresses of the pins, and the Bun installer and the conformance job read them |
FR-020 | check | bun test ./tests/ | Pins: downloadOf gives the version, address, SHA-256, format and folder of a pin on a platform, or why it is unpinned |
FR-021 | check | bun test ./tests/ | Managers: mise is a tool manager with four unverified commands of origin memory |
FR-022 | check | bun test ./tests/ | Managers: apt, pacman, dnf, brew and winget each have a query-version command |
FR-023 | check | bun test ./tests/ | Names: the ontology and its generated files say archon only of commons/archon and of the origin archon |
FR-024 | check | bun test ./tests/ | Managers: apt, brew, winget and mise have an install-exact command of origin memory, unverified |
FR-025 | check | bun test ./tests/ | Commands: commandOf gives the words, executable, environment, administrator need and verification of an operation of a manager, for every manager and operation |
FR-026 | check | bun test ./tests/ | Commands: exactVersionOf, managerIds, operationNames, prohibitionsOf and describeCommandError |
FR-027 | check | bun test ./tests/ | Commands: every error of the reader is a value of a closed union and is told in one sentence |
FR-028 | check | bun test ./tests/ | Tables: the generated files carry install-exact |
FR-029 | check | bun test ./tests/ | Commands: missingExitStatus is stated for the query-installed of apt and brew and absent elsewhere |
FR-030 | check | bun test ./tests/ | the three classes of the distribution are in the ontology and its audit, unaligned, with the examined standards |
FR-031 | check | bun test ./tests/ | the peer and optional peer classes map to the SPDX 3.0.1 relationship types read |
0003 Mizan, the IF Spec Profile
| Requirement | Mechanism | Who | Note |
|---|---|---|---|
FR-001 | check | bun test ./tests/ | Mizan: the tool runs on commons' own folder and each rule is broken in a copy and named |
FR-002 | check | bun test ./tests/ | Mizan: the tool runs on commons' own folder and each rule is broken in a copy and named |
FR-003 | check | bun test ./tests/ | Mizan: the tool runs on commons' own folder and each rule is broken in a copy and named |
FR-004 | check | bun test ./tests/ | Mizan: the tool runs on commons' own folder and each rule is broken in a copy and named |
FR-005 | check | bun test ./tests/ | Mizan: the tool runs on commons' own folder and each rule is broken in a copy and named |
FR-006 | check | bun test ./tests/ | Mizan: the tool runs on commons' own folder and each rule is broken in a copy and named |
FR-007 | check | bun test ./tests/ | Mizan: the tool runs on commons' own folder and each rule is broken in a copy and named |
FR-008 | check | bun test ./tests/ | Mizan: a Part of line naming no specification of the folder, or the specification itself, is named |
FR-009 | check | bun test ./tests/ | Mizan: the old tool name runs the new one and gives the same findings |
FR-010 | check | bun test ./tests/ | Mizan: Active and Deferred are accepted, a word outside the list is named |
FR-011 | check | bun test suite/ | mizan-oscal-register.test.ts: the requirements of a folder are implemented-requirements of a component definition and the proofs observations of assessment results, both valid against the official OSCAL 1.2.3 schemas |
FR-012 | check | bun test ./tests/ | Mizan: a Spec Kit form specification is accepted and its missing section and status are named |
FR-013 | check | bun test suite/ | mizan.test.ts: the six EARS patterns told apart; a requirement with no keyword and a trigger not in its pattern named |
FR-014 | check | bun test suite/ | mizan.test.ts: a scenario out of order or citing no requirement named |
FR-015 | check | bun test suite/ | mizan.test.ts: a new finding fails, the baseline holds, a fixed finding makes its line stale, commons' own folder passes |
FR-016 | check | bun test suite/ | mizan-oscal-register.test.ts: a row of reviewed.tsv is read as a review row of the register, and enforcement.tsv decides where both name a requirement |
FR-017 | check | bun test suite/ | mizan-boundaries.test.ts: Mizan's files import only node: built-ins, the kernel, the runtime, the ontology, the types of the Git host contract (githost/types.ts) and themselves |
FR-018 | check | bun test ./tests/ | Mizan ontology: the Turtle is current, a stale file is named with exit 1, a broken ontology stops with exit 2 |
FR-019 | check | bun test suite/ | mizan.test.ts: the command run as a program: new, held and stale findings, a plugin added beside the rules |
FR-020 | check | bun test suite/ | mizan.test.ts: an undefined prefixed name is found once with its line, a prefix that is not given is not read, and commons' own specifications are read for real |
FR-021 | check | bun test suite/ | mizan-oscal-register.test.ts: the control ids, the properties, the passing, accepted and gap observations, and the evidence of a proof |
FR-022 | check | bun test suite/ | mizan-oscal-register.test.ts: the same bytes on two runs and whatever order the tests come in, a changed requirement or proof changes the version and nothing else does |
FR-023 | check | bun test suite/ | mizan-oscal-register.test.ts: the files are current, --check names a stale one with exit 1, and each validates against the pinned official schema (jsonschema) |
FR-040 | check | bun test suite/ | mizan.test.ts: a harness folder with its own audit is held: a term with no record fails, a missing decision is held by the baseline, an overdue one fails, a specification naming an undefined term is found; stolos runs it on itself |
FR-041 | check | bun test ./tests/ | commons-mizan-harness.test.ts: a folder of three-digit specifications is clean, a gap is told with three digits, a bare citation is read at the folder's width, a number of two or five digits and a folder named so are named, and a folder of four digits reads as before |
FR-042 | check | bun test ./tests/ | commons-mizan-harness.test.ts: the registers and the baseline are read from the folder --register names, by check(root, { register }) and as programs, and a stale baseline line is named there; a missing --register value is refused |
FR-043 | check | bun test suite/ | mizan-harness-requests.test.ts: the proof register is read from a path given as an option, with Windows line ends, and the two OSCAL documents are the same bytes as from enforcement.tsv beside the specifications; a path that is not there is an error |
FR-044 | check | bun test suite/ | mizan-harness-requests.test.ts: a requirement that names a term which does not cite it back is a finding (once for each requirement and term, ranges read, the whole specification not), the stage runs only where definitions are given, and its findings are held by the baseline and go stale when fixed |
0004 Rules
| Requirement | Mechanism | Who | Note |
|---|---|---|---|
FR-001 | check | bun test ./tests/ | Rules: the set, the generator's refusals, the portability tool and its use on the installer script |
FR-002 | check | bun test ./tests/ | Rules: the set, the generator's refusals, the portability tool and its use on the installer script |
FR-003 | check | bun test ./tests/ | Rules: the set, the generator's refusals, the portability tool and its use on the installer script |
FR-004 | check | bun test ./tests/ | Rules: the set, the generator's refusals, the portability tool and its use on the installer script |
0005 TypeScript practice
| Requirement | Mechanism | Who | Note |
|---|---|---|---|
FR-001 | check | bun test ./tests/ | commons-typescript-practice.test.ts: every package says "type": "module" and node >=26, and the sources use no enum, namespace or parameter property |
FR-004 | check | bun test ./tests/ | commons-typescript-practice.test.ts: no source of a library names a vendor global, a jsr:, npm:, @std/ or URL import; the lint rules are errors in bunfig.toml |
FR-015 | check | bun test ./tests/ | commons-typescript-practice.test.ts: every file of a library's src/ and suite/ begins with a TSDoc block that says @module, and every export of src/ has TSDoc |
FR-016 | check | bun test ./tests/ | commons-typescript-practice.test.ts: the dependencies of the root and of every library are exact or links, and a lockfile is beside each package that installs packages |
FR-017 | check | bun test ./tests/ | commons-typescript-practice.test.ts: commons/tsconfig.base.json sets the strict options and every tsconfig extends it; `repoctl check` runs tsc 7 on the tests and the tools |
FR-018 | gate | .github/workflows/ci.auto.yml | the job of each affected library runs verify and the tests on Bun and on Node 26, and on macOS and Windows where the library's record says so |
FR-026 | check | bun test ./tests/ | commons-typescript-practice.test.ts: no formatter, linter, test framework or package manager but Bun is a dependency, and the pins name Bun's version |
FR-027 | gate | .github/workflows/tests.auto.yml | the check job runs bun fmt --check on the tools and the tests, with the [fmt] section of bunfig.toml |
FR-028 | check | bun test ./tests/ | commons-typescript-practice.test.ts: bunfig.toml makes an error of every rule FR-028 names; the check job of tests.auto.yml runs the linter with no warning allowed |
FR-076 | check | bun test ./tests/ | commons-typescript-practice.test.ts: every import of a library's own package name in its sources names an entry of its exports |
FR-077 | check | bun test suite/ | layers.test.ts: a library that imports its own layers by package name has them checked by resolving each specifier through its exports |
0006 Signals
| Requirement | Mechanism | Who | Note |
|---|---|---|---|
FR-001 | review | 0032-libraries-by-concern FR-010 | kept by the library telemetry: 0001-telemetry FR-001 |
FR-002 | review | 0032-libraries-by-concern FR-010 | kept by the library telemetry: 0001-telemetry FR-002 |
FR-003 | review | 0032-libraries-by-concern FR-010 | kept by the library telemetry: 0001-telemetry FR-003 |
FR-004 | review | 0032-libraries-by-concern FR-010 | kept by the library telemetry: 0001-telemetry FR-004 |
FR-005 | review | 0032-libraries-by-concern FR-010 | kept by the library telemetry: 0001-telemetry FR-005 |
FR-006 | review | 0032-libraries-by-concern FR-010 | kept by the library telemetry: 0001-telemetry FR-006 |
FR-007 | review | 0032-libraries-by-concern FR-010 | kept by the library telemetry: 0001-telemetry FR-007 |
FR-008 | review | 0032-libraries-by-concern FR-010 | kept by the library telemetry: 0001-telemetry FR-008 |
FR-009 | review | 0032-libraries-by-concern FR-010 | kept by the library telemetry: 0001-telemetry FR-009 |
FR-010 | review | 0032-libraries-by-concern FR-010 | kept by the library telemetry: 0001-telemetry FR-010 |
FR-011 | review | 0032-libraries-by-concern FR-010 | kept by the library telemetry: 0001-telemetry FR-011 |
FR-012 | review | 0032-libraries-by-concern FR-010 | kept by the library telemetry: 0001-telemetry FR-012 |
FR-013 | review | 0032-libraries-by-concern FR-010 | kept by the library telemetry: 0001-telemetry FR-013 |
FR-014 | review | 0032-libraries-by-concern FR-010 | kept by the library telemetry: 0001-telemetry FR-014 |
FR-015 | review | 0032-libraries-by-concern FR-010 | kept by the library telemetry: 0001-telemetry FR-015 |
FR-016 | review | 0032-libraries-by-concern FR-010 | kept by the library telemetry: 0001-telemetry FR-016 |
FR-017 | review | 0032-libraries-by-concern FR-010 | kept by the library telemetry: 0001-telemetry FR-017 |
FR-018 | review | 0032-libraries-by-concern FR-010 | kept by the library telemetry: 0001-telemetry FR-018 |
FR-019 | review | 0032-libraries-by-concern FR-010 | kept by the library telemetry: 0001-telemetry FR-019 |
FR-020 | review | 0032-libraries-by-concern FR-010 | kept by the library telemetry: 0001-telemetry FR-020 |
FR-021 | review | 0032-libraries-by-concern FR-010 | kept by the library telemetry: 0001-telemetry FR-021 |
FR-022 | review | 0032-libraries-by-concern FR-010 | kept by the library terminal: terminal 0001-terminal FR-003 |
FR-023 | review | 0032-libraries-by-concern FR-010 | kept by the library telemetry: 0001-telemetry FR-022 |
FR-024 | review | 0032-libraries-by-concern FR-010 | kept by the library telemetry: 0001-telemetry FR-023 |
FR-025 | review | 0032-libraries-by-concern FR-010 | kept by the library terminal: terminal 0001-terminal FR-005 |
FR-026 | review | 0032-libraries-by-concern FR-010 | kept by the library telemetry: 0001-telemetry FR-024 |
FR-027 | review | 0032-libraries-by-concern FR-010 | kept by the library telemetry: 0001-telemetry FR-025 |
0007 GRC engineering
| Requirement | Mechanism | Who | Note |
|---|---|---|---|
FR-001 | review | 0032-libraries-by-concern FR-010 | kept by the library grc: 0001-grc-engineering FR-001 |
FR-002 | review | 0032-libraries-by-concern FR-010 | kept by the library grc: 0001-grc-engineering FR-002 |
FR-003 | review | 0032-libraries-by-concern FR-010 | kept by the library grc: 0001-grc-engineering FR-003 |
FR-004 | review | 0032-libraries-by-concern FR-010 | kept by the library grc: 0001-grc-engineering FR-004 |
FR-005 | review | 0032-libraries-by-concern FR-010 | kept by the library grc: 0001-grc-engineering FR-005 |
FR-006 | review | 0032-libraries-by-concern FR-010 | kept by the library grc: 0001-grc-engineering FR-006 |
FR-007 | review | 0032-libraries-by-concern FR-010 | kept by the library grc: 0001-grc-engineering FR-007 |
FR-008 | review | 0032-libraries-by-concern FR-010 | kept by the library grc: 0001-grc-engineering FR-008 |
FR-009 | review | 0032-libraries-by-concern FR-010 | kept by the library grc: 0001-grc-engineering FR-009 |
FR-010 | review | 0032-libraries-by-concern FR-010 | kept by the library grc: 0001-grc-engineering FR-010 |
FR-011 | review | 0032-libraries-by-concern FR-010 | kept by the library grc: 0001-grc-engineering FR-011 |
FR-012 | review | 0032-libraries-by-concern FR-010 | kept by the library grc: 0001-grc-engineering FR-012 |
FR-013 | review | 0032-libraries-by-concern FR-010 | kept by the library grc: 0001-grc-engineering FR-013 |
FR-014 | review | 0032-libraries-by-concern FR-010 | kept by the library grc: 0001-grc-engineering FR-014 |
FR-015 | review | 0032-libraries-by-concern FR-010 | kept by the library grc: 0001-grc-engineering FR-015 |
FR-016 | review | 0032-libraries-by-concern FR-010 | kept by the library grc: 0001-grc-engineering FR-016 |
FR-017 | review | 0032-libraries-by-concern FR-010 | kept by the library grc: 0001-grc-engineering FR-017 |
FR-018 | review | 0032-libraries-by-concern FR-010 | kept by the library grc: 0001-grc-engineering FR-018 |
FR-019 | review | 0032-libraries-by-concern FR-010 | kept by the library grc: 0001-grc-engineering FR-019 |
FR-020 | review | 0032-libraries-by-concern FR-010 | kept by the library grc: 0001-grc-engineering FR-020 |
FR-021 | review | 0032-libraries-by-concern FR-010 | kept by the library system: 0001-system FR-014 |
FR-022 | review | 0032-libraries-by-concern FR-010 | kept by the library grc: 0001-grc-engineering FR-021 |
0008 Test evidence
| Requirement | Mechanism | Who | Note |
|---|---|---|---|
FR-001 | review | 0032-libraries-by-concern FR-010 | kept by the library test: 0001-test FR-004 |
FR-002 | review | 0032-libraries-by-concern FR-010 | kept by the library test: 0001-test FR-005 |
FR-003 | review | 0032-libraries-by-concern FR-010 | kept by the library test: 0001-test FR-006 |
FR-004 | review | 0032-libraries-by-concern FR-010 | kept by the library quality: 0001-quality-evidence FR-001 |
FR-005 | review | 0032-libraries-by-concern FR-010 | kept by the library quality: 0001-quality-evidence FR-002 |
FR-006 | review | 0032-libraries-by-concern FR-010 | kept by the library quality: 0001-quality-evidence FR-003 |
FR-007 | review | 0032-libraries-by-concern FR-010 | kept by the library quality: 0001-quality-evidence FR-004 |
FR-008 | review | 0032-libraries-by-concern FR-010 | kept by the library quality: 0001-quality-evidence FR-005 |
FR-009 | review | 0032-libraries-by-concern FR-010 | kept by the library quality: 0001-quality-evidence FR-006 |
FR-010 | review | 0032-libraries-by-concern FR-010 | kept by the library quality: 0001-quality-evidence FR-007 |
FR-011 | review | 0032-libraries-by-concern FR-010 | kept by the library quality: 0001-quality-evidence FR-008 |
FR-012 | review | 0032-libraries-by-concern FR-010 | kept by the library quality: 0001-quality-evidence FR-009 |
FR-013 | review | 0032-libraries-by-concern FR-010 | kept by the library quality: 0001-quality-evidence FR-010 |
FR-014 | check | .github/workflows/ifc-typescript.auto.yml test job | CI runs the suite through ifc test on each runtime and system and uploads the record and reports |