test: run the README's own commands through the parser, and fix one it caught - #7
Merged
Merged
Conversation
…t caught The same guard as plugrl-server's, and it earned its place immediately: the README documented `--log-level debug` on the env client, which has never had that flag. It exists on plugrl-run-server, and the line was copied from there. The site audit had gone through this repository and missed it, because reading a flag does not tell you whether it parses. The README is corrected and says what happened rather than quietly dropping the flag. The test asserts up front that its regex matched at least three commands, since one that matched nothing would make every case below pass - which is not hypothetical here: the first version of the pattern missed every command in this file, because they are written `uv run plugrl-run-env-client` and it looked for the bare executable. Co-Authored-By: Claude Opus 5 (1M context) <[email protected]>
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
1 participant
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.
The same guard as PlugRL/plugrl-server#10, and it earned its place immediately.
What it found
The README documented
--log-level debugon the env client. That flag has never existed here. It exists onplugrl-run-server, and the line was copied across. There is no verbosity mechanism on this side at all —grep -rn "log_level\|configure_logging" src/returns nothing.The site-wide audit had already gone through this repository and missed it, because reading a flag does not tell you whether it parses.
The README is corrected and says what happened, rather than quietly dropping the flag.
The guard
Every bash block is scanned for env-client invocations, continuations joined, each command handed to
cli()withsys.argvpatched. Environments behind an optional extra are skipped from the registry rather than from the error text.It asserts up front that the regex matched at least three commands. That is not decoration: the first version of the pattern matched zero, because this README writes
uv run plugrl-run-env-clientand the pattern looked for the bare executable. The assertion is what surfaced that instead of reporting a clean pass over nothing.🤖 Generated with Claude Code