Skip to content

docs: list lua-language-server in README dev dependencies - #11

Merged
derek-miller merged 1 commit into
mainfrom
fl-13-readme-langserver
Aug 12, 2026
Merged

docs: list lua-language-server in README dev dependencies#11
derek-miller merged 1 commit into
mainfrom
fl-13-readme-langserver

Conversation

@derek-miller

Copy link
Copy Markdown
Contributor

Fixes FL-13: the README setup block lists dev dependencies as (stylua, luacheck, amalg) but omits lua-language-server, which make typecheck hard-requires (it exits 1 without it) and which make install-deps already installs via brew install lua-language-server stylua. FL-11 documented the make typecheck target in these READMEs, making the omission a real gap. lua-protobuf already lists it; this closes the drift in the other three. Docs only.

Ref: https://youtrack.dmiller.me/issue/FL-13

@svc-finitelabs svc-finitelabs Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving. Verified against finitelabs/lua-crypto at head 6330185 rather than reading the diff alone.

The requirement is real. Makefile:177 gates typecheck on command -v lua-language-server and takes exit 1 at :184 when it is missing, so the target hard-requires the binary. FL-11 put make typecheck into this README, which is what turned an adjacent omission into a documented target whose dependency the setup block appeared not to cover.

The corrected list is exactly complete. install-deps installs lua-language-server and stylua via brew at Makefile:102, then luacheck and amalg via luarocks at :113-114. Four tools installed, four tools now named at README.md:200. Nothing left to add, and nothing named that the target does not install.

Scope checks out. I grepped README.md on the default branch of every finitelabs repo: the stale (stylua, luacheck, amalg) string lives in exactly three, and each has an identical one-line PR open (lua-bitn#20, #11, lua-noiseprotocol#22). lua-protobuf already carries the longer correct list at README.md:146, and lua-bthome-ble has no setup dependency line at all, so both are correctly out of scope. This set closes FL-13 with no leftovers.

Ref: https://youtrack.dmiller.me/issue/FL-13

@derek-miller
derek-miller merged commit 57b5df8 into main Aug 12, 2026
11 checks passed
@derek-miller
derek-miller deleted the fl-13-readme-langserver branch August 12, 2026 02:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant