Repository navigation
test: fail when a size the readme claims stops being true - #195
Merged
Merged
Conversation
- the README tells a reader that a page with no Korean costs 53 KB and one with Korean 621 KB. both are right, and nothing would have caught them going wrong: a number in prose reads like background and is never re-checked, which is how the reserved font name survived three releases - the gate now requires every KB figure in the README to be a size the built package actually has, and reads `dist/` rather than `src/`, since the source cannot say what a reader downloads - ADR-0004 said "the package is 924 KB" in the present tense and it is 905 KB now. that line records what was weighed at the time, so it says "was, when this was decided" and is true permanently rather than approximately - verification: 27 checks pass; moving one README figure by 1 KB fails the new check, and the message names every size the package actually has
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The gate now checks that every
KBfigure inREADME.mdis a size the builtpackage actually has. One stale present-tense sentence in ADR-0004 is corrected
to the past tense it was always describing.
Why
A sweep of the seventeen documents in this repository for claims that rot found
that the reader-facing sizes were correct and unguarded, and one decision-record
size had already drifted:
README.mdADR-0004The failure mode is the one this project already paid for once. A number written
into prose is right on the day it is written and silently wrong afterwards,
because a sentence that reads like background is never re-read. That is the same
shape as the
@font-facerename that looked done for three releases.Everything else in the sweep came back clean: no broken relative links, no
reference to a file that does not exist, every external link resolves, and the
milestone claim in
CONTRIBUTING.mdis true (0 milestones, 7 releases).How it was verified
npm run check— 27 checks pass, the new one reporting that it examined 2figures.
README's
53 KBto54 KBproducesreadme sizes match the package: 54 KB matches nothing built — the package has 53 KB (the Latin subset), 568 KB (the Hangul subset), 621 KB (both subsets), 905 KB (the whole package). The README was restored and the gate re-run.npm run build, not from a staledist/.Limitations
KBonly. A figure written in MB or bytes is not covered; the twothe README states are both KB.
happens to equal another part of the package — 53 KB would still pass if the
sentence claimed it was the Hangul subset. It guards arithmetic, not meaning.
ADR-0003andADR-0004carry other sizes that are decision-time records andare deliberately not checked; the amendment convention already covers those.