IF Commons GitHub

A read-only static report site

0002Active

0002-report-site · owner if · domain commons

Requirements

FR-001checkpassing

A report MUST be made from a title, the instant the posture is of, a framework's id and title, an assessment, the grades of its objectives, optionally the matrix of responsibility and the titles of requirements; it MUST show what it is given and work out no standing or grade of its own.

Enforced (check): .github: cd commons/posture-report && bun run verify — suite/site.test.ts

Proved by: posture-report/suite/site.test.ts

Written in: posture-report/src/governance/model.ts

Tests: passed: suite/site.test.ts the site has the index, the stylesheet, a page for each requirement and the data, and the

Cited by: governance/model, Posture Report

FR-002checkpassing

The site MUST have an index.html, a style.css, a page requirements/<id>.html for each requirement of the assessment, and report.json with the counts, roll-ups and grades the pages are made from.

Enforced (check): .github: cd commons/posture-report && bun run verify — suite/site.test.ts

Proved by: posture-report/suite/site.test.ts

Written in: posture-report/src/logical/site.ts

Tests: passed: suite/site.test.ts the site has the index, the stylesheet, a page for each requirement and the data, and the

Cited by: Posture Report, logical/site

FR-003checkpassing

The index MUST list each requirement with its standing, its number of objectives and who answers for it (or that this is not stated), the count of objectives in each standing and of each grade, the requirements nobody is named for, and the evidence that names objectives the framework does not have; it MUST give no percentage.

Enforced (check): .github: cd commons/posture-report && bun run verify — suite/site.test.ts

Proved by: posture-report/suite/site.test.ts

Written in: posture-report/src/logical/site.ts

Tests: passed: suite/site.test.ts the site has the index, the stylesheet, a page for each requirement and the data, and the

FR-004checkpassing

A requirement's page MUST give, for each of its objectives, the statement, its standing and grade (with the record the grade rests on, its origin and its age), and a table of the evidence with its method, result, who made it, when and the source; and who answers for the requirement with the note of a shared one.

Enforced (check): .github: cd commons/posture-report && bun run verify — suite/site.test.ts

Proved by: posture-report/suite/site.test.ts

Written in: posture-report/src/logical/site.ts

Tests: passed: suite/site.test.ts a requirement's page gives each objective with its standing, grade and basis, a table of e

FR-005checkpassing

Every text that comes from the input MUST be escaped for HTML; a file name MUST keep only letters, digits, dots, dashes and underscores; the pages MUST have a language, a title, headings and tables with column headers.

Enforced (check): .github: cd commons/posture-report && bun run verify — suite/site.test.ts

Proved by: posture-report/suite/site.test.ts

Written in: posture-report/src/logical/site.ts

Tests: passed: suite/site.test.ts hostile text is escaped, file names are safe, there is no script and no address of anywher

FR-006checkpassing

The site MUST be plain HTML and one stylesheet with no script and no address of anywhere (no link, font, image or form that reaches out), so that it can be opened from a file and kept as evidence; and the same input MUST give the same bytes.

Enforced (check): .github: cd commons/posture-report && bun run verify — suite/site.test.ts

Proved by: posture-report/suite/site.test.ts

Written in: posture-report/src/logical/site.ts

Tests: passed: suite/site.test.ts hostile text is escaped, file names are safe, there is no script and no address of anywher

Cited by: Posture Report, logical/site

FR-007checkpassing

Writing a site MUST put each file under the folder given, in the order of their paths, and MUST refuse a file whose path leaves the site.

Enforced (check): .github: cd commons/posture-report && bun run verify — suite/site.test.ts

Proved by: posture-report/suite/site.test.ts

Written in: posture-report/src/physical/site.ts

Tests: passed: suite/site.test.ts a site is written under the folder in the order of its paths, and a path that leaves the s

Cited by: Posture Report, physical/site

Acceptance scenarios

  1. Given an assessment with one requirement met and one with no evidence, When the site is made, Then the index lists both with their standing and a page exists for each, per FR-002 and FR-003.
  2. Given a statement that contains <script>, When the site is made, Then no page contains a script element, per FR-005 and FR-006.

Out of scope

  • Serving the site, signing it and publishing it: the program that uses the library.
  • Printing and PDF.
  • Several tenants in one site: a portfolio page is a later addition.

Edge cases

  • A requirement with no responsibility stated is shown as not stated, per FR-003.
  • An objective with no evidence says so, per FR-004.

Assumptions

  • A reader's browser follows the system's light or dark preference through the stylesheet.

Open questions

  • None.

Key entities

  • Report input, Site.

Success criteria

SC-001success criterion

A posture can be handed over as a folder of files that opens offline and shows, for every requirement, what supports it and how strongly.

Review & acceptance checklist

  • [x] Every requirement is testable (MUST / MUST NOT), not aspirational
  • [x] No company fact is asserted here
  • [x] Every open item is marked, not silently decided

Cited by

governance/model, Posture Report, logical/site, physical/site

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