Document lint command and pre-commit hook - #54
Merged
Merged
Conversation
The pre-commit hook and `test lint` CLI command were not mentioned in any docs. Add a Linting section to cli/README.md (options, hook behaviour including worktree venv lookup, reinstall note), an optional hook-install step to README setup, and a linting entry under Testing.
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 pre-commit hook (
hooks/pre-commit) and thetest lintCLI command weren't mentioned in any docs; only the code referenced them. This PR adds:cli/README.mdtest lint --help), and what the hook does, including the main-repo venv lookup for worktrees added in Find main repo venv in pre-commit hook when run from a worktree #53.hooks/pre-commitchanges.tests.pyarchitecture notes.README.mdNote
--install-hookcurrently fails withFileNotFoundErrorfrom a linked worktree: it writes to<worktree>/.git/hooks/, but in a worktree.gitis a file. For now the docs say to run it from the main checkout. A code fix can follow in a separate PR, which would drop that caveat.🤖 Generated with Claude Code