docs: README check description now lists typecheck - #9
Conversation
There was a problem hiding this comment.
Verdict: looks correct, ship it. Filing this as a comment rather than a formal approve: squash auto-merge was armed on this PR at 2026-08-12T01:34:17Z, reviewDecision is REVIEW_REQUIRED, and two matrix jobs are still running, so an approve from me is the last gate and would merge this itself once they go green. That trigger is yours to pull, not mine. Nothing here is a reservation about the change.
Verified every changed line against the Makefile at 3f03f1d rather than against the PR description:
check: format-check lint typecheck, so "format check, lint, and typecheck" is accurate.format-checkrunsstylua --check, so "Check formatting without modifying" is accurate.typecheckrunslua-language-server --check, and the new line matches themake helpwording verbatim.- The block now matches the Code Quality section of
make helpin both contents and order, and the comment column stays at 26 across all five lines. Check(the job that runsmake check) is already green on the head; the Lua matrix jobs are still running but do not touch docs.
Two leftovers of the same drift, both out of scope here, worth a follow-up:
1. CLAUDE.md:62-63 is now the stale copy. It reads:
make helpis stale on this point: it describescheckas "format-check and lint" and omits typecheck.
be34f24 (#8) fixed make help, and CLAUDE.md has not been touched since f886c04, which lands before it. So the file now tells a reader that a correct help target is wrong. That is the same defect FL-11 exists to fix, one file over, and since it is the agent-facing doc it is the copy most likely to be acted on.
2. README.md:200 still reads # Install development dependencies (stylua, luacheck, amalg). install-deps also runs brew install lua-language-server stylua, and the block this PR just edited now documents make typecheck as needing lua-language-server. The setup line is where a reader would go looking for it and not find it.
Neither blocks this merge.
|
Follow-up filed for the first leftover in the review above: FL-14. Re-scoping it, since it is two repos rather than one: the same The second leftover, README:200's dev dependency list, is already tracked as FL-13, fleet-scoped. All 11 check runs on |
|
Auto-merge is now disarmed on this PR, so an approving review is no longer the merge trigger. Content is verified correct per your review, so please go ahead and post the approve. I will merge manually once it lands and CI is green. |
There was a problem hiding this comment.
Approving now that auto-merge is off.
The earlier review on this same head (3f03f1d) was posted as a COMMENT rather than an approve only because squash auto-merge was armed at the time: with reviewDecision at REVIEW_REQUIRED, an approve would have been the merge rather than a verdict. Auto-merge was disabled at 02:37Z with the head unchanged, so the approve is now just the verdict. Nothing about the code changed the assessment.
Re-verified the three added/changed README lines against Makefile at 3f03f1d:
make checkreally isformat-check lint typecheck(Makefile:188), so the old "format check and lint" description was understating it.make format-checkshells out tostylua --check(Makefile:137-140).make typecheckshells out tolua-language-server --check(Makefile:177-180).
The block also now matches the Code Quality section of make help (Makefile:216-221) in contents and order: check, format, format-check, lint, typecheck.
All 11 contexts required by the main ruleset are green at this head (Check, Build Combined Module, Lua 5.1 through 5.4, luajit-2.0/2.1, and the three lua-openssl pins). The ruleset wants one approving review, which this supplies. Merge is yours to take.
Non-blocking, already tracked so no action needed here: README Setup still lists make install-deps as "(stylua, luacheck, amalg)" while the recipe also brews lua-language-server (Makefile:102), which now matters because this block documents make typecheck. That is FL-13, fleet-scoped. Separately, CLAUDE.md:62-63 still tells a reader that make help is stale on exactly this point, which stopped being true when #8 landed; that is FL-14.
Fixes FL-11: the README still described
make checkas format-check and lint, butcheckgainedtypecheckas a prerequisite (shipped tomake helpin FL-10). Corrects the description and documents themake typechecktarget. Docs-only, no behaviour change.Ref: https://youtrack.dmiller.me/issue/FL-11