Add check-list-referenced hook to keep README tool commands in sync#1722
Merged
nathanjmcdougall merged 3 commits intomainfrom Apr 1, 2026
Merged
Add check-list-referenced hook to keep README tool commands in sync#1722nathanjmcdougall merged 3 commits intomainfrom
nathanjmcdougall merged 3 commits intomainfrom
Conversation
… in README Create a generic hook that parses a Python list constant via AST and checks each item appears in a target file with a given pattern. Register it in .pre-commit-config.yaml to verify ALL_TOOL_COMMANDS are referenced in README.md. Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/99f2cb98-5708-460b-a131-abff18d6a22c Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add hook-based system to keep README TOC up-to-date
Add check-list-referenced hook to keep README tool commands in sync
Apr 1, 2026
nathanjmcdougall
requested changes
Apr 1, 2026
…MMAND_STRS Replace AST-based source file parsing with importlib-based module import. The hook now accepts --variable as a dotted path (e.g. pkg.mod.ALL_TOOL_COMMAND_STRS) and checks each string directly. Add ALL_TOOL_COMMAND_STRS derived constant in tool.py containing the prefixed command strings. Remove --source-file and --pattern args. Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/38399814-f18a-4a0d-91fd-e52b58a189b6 Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
nathanjmcdougall
approved these changes
Apr 1, 2026
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
After #1639 where an agent failed to update docs when adding a new command, this adds a pre-commit hook that verifies all entries in
ALL_TOOL_COMMANDSare referenced in the README. If a developer adds a tool to the registry but forgets to document it, CI catches it.New hook:
hooks/check-list-referenced.pyGeneric, reusable hook that:
importlib(e.g.pkg.mod.VAR_NAME)check-banned-words)New derived constant:
ALL_TOOL_COMMAND_STRSAdded in
src/usethis/_ui/interface/tool.py, this constant derives the full prefixed command strings (e.g."usethis tool ruff") fromALL_TOOL_COMMANDS, so the hook can check them directly without needing a pattern argument.Registration in
.pre-commit-config.yamlFailure output when a tool is missing from the README: