Add prek hook to forbid banned comment keywords (pragma:, type: ignore)#1833
Merged
nathanjmcdougall merged 3 commits intomainfrom Apr 7, 2026
Merged
Conversation
…olations Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/6152a7f0-e37e-4368-970d-9759057f1234 Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add prek hook to forbid banned comment keywords
Add prek hook to forbid banned comment keywords (pragma:, type: ignore)
Apr 7, 2026
nathanjmcdougall
requested changes
Apr 7, 2026
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/a1d3a492-0348-4ae1-9584-932216cf89dd Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
nathanjmcdougall
approved these changes
Apr 7, 2026
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.
Agents and developers occasionally introduce
# pragma: no coveror# type: ignore[...]comments. This project doesn't use coverage pragmas (write tests instead) and uses pyright, not mypy, for type checking.New hook:
hooks/check-comment-keywords.pytokenizemodule to inspect only comment tokens — no false positives from strings or docstrings--keyword(repeatable) via CLI, keeping the script project-agnostic.pre-commit-config.yamlapplying to all Python files viatypes: [python]:Cleanup of existing violations
# type: ignore[union-attr]comments fromsrc/usethis/_deps.pyandsrc/usethis/_file/pyproject_toml/deps.py— these were mypy suppressions unnecessary under ty/basedpyrightSkills used:
usethis-prek-hook-bespoke-create,usethis-qa-static-checks,usethis-lesson-create,usethis-github-issue-create