Commons (5 of 6)
8 specifications, 124 requirements. All libraries
0028 Conformance levels
| Requirement | Mechanism | Who | Note |
|---|---|---|---|
FR-001 | check | bun test suite/ | mizan-levels.test.ts: Mizan's ontology holds the four levels with ranks 0 to 3, each entailing what it and the levels below it add |
FR-002 | check | bun test suite/ | mizan-levels.test.ts: every requirement is added by exactly one level and names a rule or says what else proves it |
FR-003 | check | bun test suite/ | mizan-levels.test.ts: L0 adds a manifest, a verify command and a version |
FR-004 | check | bun test suite/ | mizan-levels.test.ts: L1 adds the eight requirements of the core |
FR-005 | check | bun test suite/ | mizan-levels.test.ts: L2 adds the audit of terms, whose rules are the rules about terms |
FR-006 | check | bun test suite/ | mizan-levels.test.ts: L3 adds change control, release control and the quality records |
FR-007 | check | bun test suite/ | mizan-levels.test.ts: every rule a requirement names exists, and a family names at least one |
FR-008 | check | bun test suite/ | mizan-levels.test.ts: with no level the check has the findings, the baseline and the status of L3 |
FR-009 | check | bun test suite/ | mizan-levels.test.ts: below L3 only the rules the level entails run, a rule no requirement names from L1, and none at L0 |
FR-010 | check | bun test suite/ | mizan-levels.test.ts: a baseline line of a rule the level does not run is neither stale nor lost where the baseline is written |
FR-011 | check | bun test suite/ | mizan-levels.test.ts: check.ts takes --level and refuses a level that is not one of the four with status 2 |
FR-012 | check | bun test suite/ | mizan-levels.test.ts: --all runs the verify of every library a manifest declares from its folder, names each status and exits 1 where one fails, and the check without it runs none |
FR-013 | check | bun test suite/ | libraries.test.ts: a manifest at L1 or L2 whose verify script does not run the Mizan check with its level is found |
0029 Subject profiles
| Requirement | Mechanism | Who | Note |
|---|---|---|---|
FR-001 | check | bun test suite/ | mizan-profiles.test.ts: the ontology holds the five kinds of subject, a library released as ifr:Library and the rest as ifr:Software, each with a proof and templates |
FR-002 | check | bun test suite/ | mizan-profiles.test.ts: the head names the kind and the audience in any case, the first line counting; a kind or an audience that is none of the ontology's is mizan/profile-unknown |
FR-003 | check | bun test suite/ | mizan-profiles.test.ts: each profile that asks for sections has templates, each in an EARS pattern with a keyword |
FR-004 | check | bun test suite/ | mizan-profiles.test.ts: the profile of a library asks for no section |
FR-005 | check | bun test suite/ | mizan-profiles.test.ts: the profile of a service asks for its contract, contract tests, objectives and quality attributes, and names OpenAPI 3.1, AsyncAPI, JSON Schema, OpenTelemetry and ISO/IEC 25010 |
FR-006 | check | bun test suite/ | mizan-profiles.test.ts: the profile of an application asks for its journeys, accessibility and design system, and names WCAG 2.2 and Gherkin with a review row for what a check cannot prove |
FR-007 | check | bun test suite/ | mizan-profiles.test.ts: the profiles of an integration and of a platform ask for the sections their requirement names |
FR-008 | check | bun test suite/ | mizan-profiles.test.ts: the ontology holds the audience models b2b and b2b2c with their sections, proofs, standards and laws |
FR-009 | check | bun test suite/ | mizan-profiles.test.ts: b2b asks for tenant isolation, service level agreements, audit trail, data processing and security controls, naming SOC 2, ISO/IEC 27001 and NIST SP 800-53 |
FR-010 | check | bun test suite/ | mizan-profiles.test.ts: b2b2c asks for the five sections of b2b and for actor roles, consumer privacy and consent and data boundaries, citing the GDPR and the CCPA |
FR-011 | check | bun test suite/ | mizan-profiles.test.ts: a missing section is found once, a heading of level two or three that begins with its name is present in any case, and the finding is held by a baseline that only shrinks |
FR-012 | check | bun test suite/ | mizan-profiles.test.ts: a specification that declares nothing, or a library, has no finding; the check runs from L1 and not at L0 |
FR-013 | check | bun test suite/ | mizan-profiles.test.ts: every standard of a profile carries its edition or is marked to verify, and no profile names a company |
FR-014 | check | bun test suite/ | mizan-profiles.test.ts: the GDPR and the CCPA are mz:Authority individuals a requirement may cite |
0030 Generated workflows
| Requirement | Mechanism | Who | Note |
|---|---|---|---|
FR-001 | check | bun test suite/ | workflows.test.ts: a file in .github/workflows that is not <name>.auto.yml is found and named, and this repository's folder holds only generated files |
FR-002 | check | bun test suite/ | workflows.test.ts: a job that needs a job that is not there, a step that runs nothing, a workflow with no trigger and a composite step with no shell are findings; the generator writes nothing while there is one |
FR-003 | check | bun test ./tests/ | commons-workflows-schema.test.ts: every generated file is valid by the schema of SchemaStore, read by Python's jsonschema, and a broken workflow is refused by it |
FR-004 | check | bun test suite/ | workflows.test.ts: --check writes nothing and exits 1 naming a file that was edited and a generated file that no workflow makes; the tests workflow runs --check |
FR-005 | check | bun test suite/ | workflows.test.ts: an action with no version or pinned by a branch is a finding, and every action of the model's workflows is one of its table |
FR-006 | check | bun test suite/ | workflows.test.ts: the libraries are proved by one generated workflow, ci, made from the manifests; no library has a workflow of its own, and a library with no record of CI has verify on Linux alone |
FR-007 | check | bun test suite/ | workflows.test.ts and plan.test.ts: the plan and the one result are jobs of the workflow ci |
FR-008 | check | bun test suite/ | workflows.test.ts: the composite action is written with the line that says it is generated, and --check compares it |
FR-009 | check | bun test suite/ | workflows.test.ts: the one release workflow is run by hand from main, plans, proves and packs each library, publishes in the order of the record to npm with provenance (the token only where the repository has it) and to GitHub with its own token, skips a version that is there and tags with the runner; no library has a workflow of its own; a library with npm and no tools/pack.ts is a finding |
FR-010 | check | bun test suite/ | workflows.test.ts: no script of a bash step pipes into head, so that a long listing cannot fail the step that prints it (the evidence run of 08:00 failed at `ls -l _evidence | head -200`) |
FR-011 | check | bun test suite/ | ci-policy.test.ts: every step of the real workflows has a policy, and each rule of the validation finds what it is for on a workflow made to break it |
0031 Install locations
| Requirement | Mechanism | Who | Note |
|---|---|---|---|
FR-001 | review | 0032-libraries-by-concern FR-010 | kept by the library system: 0001-system FR-008 |
FR-002 | review | 0032-libraries-by-concern FR-010 | kept by the library system: 0001-system FR-008 |
FR-003 | review | 0032-libraries-by-concern FR-010 | kept by the library system: 0001-system FR-008 |
FR-004 | review | 0032-libraries-by-concern FR-010 | kept by the library system: 0001-system FR-008 |
FR-005 | check | bun test suite/ | ergonex-locations.test.ts: Ergonex's state record, evidence and lock are in the state folder and its tools in the data folder, nothing is written below the user's home, no folder or command file of its own is made; ergonex-onboarding.test.ts: init writes no command file |
FR-006 | check | bun test suite/ | ergonex-install.test.ts: the Windows installer installs its prerequisites with winget by package identifier and downloads nothing; the Linux and macOS one asks Bun's own installer |
FR-007 | none | Planned: a WinGet manifest, as typed code made into YAML, comes with the first release that has a binary |
0032 Libraries by concern
| Requirement | Mechanism | Who | Note |
|---|---|---|---|
FR-001 | check | bun test ./tests/ | commons-lift.test.ts: every folder of commons that is a library is named for its concern and its package is @intellectual-frontiers/<folder>; no folder is named for a language once the lift is complete |
FR-002 | check | bun test ./tests/ | commons-lift.test.ts: the table of the map is read, and each library that exists is in it with the modules it takes |
FR-003 | check | bun test ./tests/ | commons-lift.test.ts: the dependencies of each library are declared, acyclic and run to a lower layer, and no library imports a file outside its folder by a relative path |
FR-004 | review | 0032-libraries-by-concern FR-004 | a reviewer checks that no library is named for a technical layer |
FR-005 | check | bun test ./tests/release/ | tests/release/commons-packages.test.ts: the tarball of each library is installed under node_modules and run on Node 26 with no hook and on Bun |
FR-006 | check | bun test ./tests/release/ | tests/release/commons-packages.test.ts: Node 26 runs the compiled files of an installed package; the sources are erasable TypeScript only (tsconfig erasableSyntaxOnly) |
FR-007 | check | bun test ./tests/ | commons-lift.test.ts: each lifted library has a suite/ that its verify runs |
FR-008 | review | 0032-libraries-by-concern FR-008 | a reviewer checks that the ontology of a library is in its folder |
FR-009 | check | bun test suite/ | workflows.test.ts: the release workflow skips a version already on a registry and tags the version, from main |
FR-010 | review | 0032-libraries-by-concern FR-010 | a reviewer checks that the requirements of a lifted library are in its spec kit and that 0005 points at it |
FR-011 | review | 0032-libraries-by-concern FR-011 | a reviewer checks the importers of erga and stolos |
FR-012 | check | bun test ./tests/ | the compiler fails on any importer of a moved path; commons-lift.test.ts finds no import of a moved module's old path |
FR-013 | check | bun test ./tests/release/ | tests/release/commons-packages.test.ts: every npm library is packed, its tarball inspected, installed and a consumer of every entry type-checked with tsc 7 under nodenext |
0033 Kanon
| Requirement | Mechanism | Who | Note |
|---|---|---|---|
FR-001 | review | 0033-kanon FR-001 | a reviewer checks that the folders of a library that declares kanon are in the three layers by its table (the check of FR-011 holds the imports) |
FR-002 | review | 0033-kanon FR-002 | a reviewer checks that a lower layer derives what the layer above says by code and keeps no copy of it |
FR-003 | review | 0033-kanon FR-003 | a reviewer checks the trace graph of a library's model until the check finds an element with no edge; LayeredModel carries the edges (commons-kanon.test.ts) |
FR-004 | check | bun test ./tests/ | commons-kanon.test.ts: a table and a root give layers/above, layers/around and layers/cycle as data; the library's own tests are in commons/kanon/suite |
FR-005 | check | bun test ./tests/ | commons-kanon.test.ts: an annotation with no trace edge, no carried property and no unexpressed record is kanon/dropped, and is not once it is named |
FR-006 | check | bun test ./tests/ | commons-kanon.test.ts: an import by a relative path or by a path exports does not name is layers/relative or layers/private |
FR-007 | review | 0033-kanon FR-007 | a reviewer checks that the terms are used as the vocabulary says |
FR-008 | review | 0033-kanon FR-008 | a reviewer checks the table of the alignment against the standards; the ontology kanon is made from it (commons-kanon.test.ts reads the layers' viewpoints) |
FR-009 | review | 0033-kanon FR-009 | a reviewer checks which libraries are Kanon until data and headless declare their tables |
FR-010 | check | bun test ./tests/ | commons-kanon.test.ts: the manifest accepts a kanon table and refuses a unit in a fourth layer or a field of another form |
FR-011 | check | bun test ./tests/ | commons-kanon.test.ts: every code of the check is found as data from a table and a root |
FR-012 | check | bun run verify | commons/kanon: the verify of the library (its compiler, specification checker, rules, tests and the packing of its package) |
FR-013 | check | bun test ./tests/ | commons-kanon.test.ts: a LayeredModel is the shape of the layered model of the documentation generator, with the kinds and the id builders agreed |
FR-014 | check | bun test ./tests/ | commons-kanon.test.ts: the check of the manifests finds a library that declares kanon and whose verify does not run the check |
FR-015 | check | bun test ./tests/ | commons-kanon.test.ts: the ontology kanon has the ten classes, the three layers with their MDA viewpoints, and a record of the basis of each class |
FR-016 | review | 0033-kanon FR-016 | a reviewer checks that no requirement of another library's spec kit is edited by this specification |
FR-017 | review | 0033-kanon FR-017 | a reviewer checks the cross-reference of the ladder and Kanon until the two are unified or kept apart by decision (OQ-2) |
FR-018 | review | 0033-kanon FR-018 | a reviewer checks the typing of a Kanon library; commons/kanon is the example, and its tests prove its own (0001-kanon-checker FR-009) |
FR-019 | check | bun test ./tests/ | commons-kanon.test.ts: an instance that imports another is instances/sibling; the library's own tests are in commons/kanon/suite |
FR-020 | check | bun test ./tests/ | commons-kanon.test.ts: a plugin reaches the host through its exports only (layers/private) and a host that imports its extension is plugins/inverted; commons/kanon/suite |
FR-021 | check | bun test ./tests/ | commons-kanon.test.ts: the package of a member is made from the family rule and a noun that reads as a dialect is refused; commons/kanon/suite |
FR-022 | check | bun test ./tests/ | commons-kanon.test.ts: an annotation accounted for in one dialect and not the other is kanon/dropped for the other; commons/kanon/suite |
FR-023 | check | bun test ./tests/ | commons-kanon.test.ts: the matrix is built and rendered as Markdown; commons/kanon/suite holds the JSON and the property test |
FR-024 | check | bun test ./tests/ | commons-kanon.test.ts: the reserved names are refused to a library of no family; commons/libraries/suite/family.test.ts |
FR-025 | check | bun test ./tests/ | commons/kanon/suite/content.test.ts: a governance unit of data modules that imports a logical unit is layers/above |
FR-026 | check | bun test ./tests/ | commons/kanon/suite/content.test.ts: the bundle is the same bytes twice, loads whole and is refused whole with each fault named |
FR-027 | check | bun test ./tests/ | commons/kanon/suite/content.test.ts: a package of another scope is a member where the family takes any scope, with its role in its own table |
FR-028 | check | bun test ./tests/ | commons/kanon/suite/content.test.ts: with a vocabulary, a kind or a name it does not list is a finding; without one nothing is checked |
FR-029 | check | bun test ./tests/ | commons/kanon/suite/content.test.ts: dangling, relation-layer and duplicate-id are found and a cycle is not |
FR-030 | check | bun test ./tests/ | commons/kanon/suite/content.test.ts: the content claim with a third instance and no disposition is kanon/dropped and a dropped cell of the matrix |
FR-031 | check | bun test ./tests/ | commons-kanon.test.ts: the ontology kanon has the twelve classes, Relation and Bundle with their basis |
FR-032 | none | a recorded paragraph, nothing to run: a paragraph of this specification records that docs is not classified and how a consumer's ladder and the layers are kept apart | |
FR-033 | check | bun test ./tests/ | commons/libraries/suite/family.test.ts: content and content-* are refused to a library of no family |
0034 Archon
| Requirement | Mechanism | Who | Note |
|---|---|---|---|
FR-001 | review | 0034-archon FR-001 | a reviewer checks that no package, folder or command of commons is named stolos and that what the retired engine did that is general is done by a library |
FR-002 | review | 0034-archon FR-002 | a reviewer checks that no library carries a shim, re-export or migration path for the retired engine |
FR-003 | review | 0034-archon FR-003 | a reviewer checks that a fleet repository names its libraries by package at exact versions and holds its own data and composition root |
FR-004 | review | 0034-archon FR-004 | a reviewer checks the manifest and the Kanon table of archon: governance, logical and physical hold what FR-004 says |
FR-005 | review | 0034-archon FR-005 | a reviewer checks the names and the family field of each dialect and plugin package; the import check of 0033-kanon holds the public-exports rule |
FR-006 | review | 0034-archon FR-006 | a reviewer checks that one program is composed from the command branches of the chosen plugins and that reach and tier are governance, not code |
FR-007 | review | 0034-archon FR-007 | a reviewer checks that archon renders, runs through the Executor port and reads results, and holds no engine, module library or state store |
FR-008 | review | 0034-archon FR-008 | a reviewer checks that each dialect declares its guarantees as data and that the model gives expressed, carried or unexpressed per annotation and dialect |
FR-009 | review | 0034-archon FR-009 | a reviewer checks that the choice of dialect is policy and that the presets are named for the approach |
FR-010 | review | 0034-archon FR-010 | a reviewer checks that no client both reads and writes the same system |
FR-011 | review | 0034-archon FR-011 | a reviewer checks that rendered output is generated, marked as such and not edited by hand |
FR-012 | review | 0034-archon FR-012 | a reviewer checks each dialect's pins and that its conformance suite runs the real tool, including applying an order twice |
FR-013 | review | 0034-archon FR-013 | a reviewer checks the first dialects and what each says its tool is and is not used for |
FR-014 | review | 0034-archon FR-014 | a reviewer checks that the three profiles and their controls are requirements, that a control can be overridden with a recorded reason, and that no profile is chosen without telling the person |
FR-015 | review | 0034-archon FR-015 | a reviewer checks the floor: no secret, no stored passphrase, no agent approval, destructive actions need the marker and a typed confirmation |
FR-016 | review | 0034-archon FR-016 | a reviewer checks that the profile in force is the last approved tip's, with a test of a commit that lowers its own profile |
FR-017 | review | 0034-archon FR-017 | a reviewer checks the questions of initialization, the recommendation, the plain statement of what the profile allows and the report of weaker profiles as decisions |
FR-018 | review | 0034-archon FR-018 | a reviewer checks that each library has its own spec kit and release name and that each adversarial review's findings are closed or recorded as Decisions |
FR-019 | review | 0034-archon FR-019 | a reviewer checks that the first release waits for the slice in lab virtual machines and that the first dialect's measures are in its specification |
FR-020 | review | 0034-archon FR-020 | a reviewer checks that the old repository is archived, backed up and deleted only at the owner's request, with its tickets moved or closed one by one |
FR-021 | review | 0034-archon FR-021 | a reviewer checks that the work is one parent ticket with checklist items and comments, and that no ticket exists for a library, phase or sub-task |
0035 Licensing
| Requirement | Mechanism | Who | Note |
|---|---|---|---|
FR-001 | check | bun test suite/ | licensing.test.ts: the default is PolyForm-Noncommercial-1.0.0, no LICENSE of the repository is the MIT license, and the manifest, the packer and the generator read the one identifier |
FR-002 | check | bun test suite/ | licensing.test.ts: the official text is the one recorded by its standard (SHA-256), and a changed text is refused naming both hashes |
FR-003 | check | bun test suite/ | licensing.test.ts: a manifest license of the closed list is read and one that is not is refused naming it |
FR-004 | check | bun test suite/ | licensing.test.ts: every LICENSE begins with the required notice and ends with the official text unchanged |
FR-005 | check | bun test suite/ | licensing.test.ts: every library folder and the root hold the LICENSE the generator makes, and a hand edit is found |
FR-006 | check | bun test suite/ | licensing.test.ts: --check writes nothing and exits 1 naming a library with no LICENSE and the command, and the generator writes it |
FR-007 | check | bun test suite/ | licensing.test.ts: the verify of libraries and the dev loop run the check, and tests/commons-licensing.test.ts runs it on the real repository |
FR-008 | check | bun test suite/ | licensing.test.ts: a missing or empty LICENSING.md, COMMERCIAL.md, NOTICE, CONTRIBUTING.md or CITATION.cff, and one that lacks its facts, is found |
FR-009 | check | bun test suite/ | licensing.test.ts: CONTRIBUTING.md asks for git commit -s and Refs #N, and the trademark paragraph names the five names |
FR-010 | check | bun test suite/ | licensing.test.ts: THIRD_PARTY_NOTICES.md is what the record makes, and a vendored path that is gone is found |
FR-011 | check | bun test suite/ | licensing.test.ts: the README License section names the license, and AGENTS.md names the generator's command |
FR-012 | check | bun test suite/ | licensing.test.ts: the packer writes the SPDX id, packs the LICENSE and refuses a library that has none |