Skip to content

Exempt nopep8 as a Leading Directive in the Prose Gate #2833

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ptr727 merged 3 commits into from
Oct 11, 2026
Merged

Exempt nopep8 as a Leading Directive in the Prose Gate #2833

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3a40ee2
Exempt nopep8 as a Leading Directive in the Prose Gate
ptr727 Oct 11, 2026
1ad556d
Drop the Redundant nopep8 Entry From the Tool Directive Pattern
ptr727 Oct 11, 2026
f5d0322
Pin the Lowercase nopep8 Spelling in the Directive Case Test
ptr727 Oct 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/actions/prose-gate/prose_lint.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1568,7 +1568,7 @@ def resume_at(carry: Carried, line: str) -> tuple[Carried, int | None]:
# A tool's name is anchored at the body's start, since a comment naming one mid-sentence is prose.
NOT_PROSE = re.compile(
r"^(?:!|\s*[-=#*/<>]+\s*$|ruff:|mypy:|(?i:flake8)[:=]|v\d+(?:\.\d+)*$"
r"|(?:(?i:noqa)|type:\s*ignore|pylint|shellcheck|markdownlint|omit from toc|prettier|eslint"
r"|(?:(?i:noqa|nopep8)|type:\s*ignore|pylint|shellcheck|markdownlint|omit from toc|prettier|eslint"
r"|SPDX|Copyright)\b|(?i:c?spell|spell-?checker):)"
)

Expand Down Expand Up @@ -1671,7 +1671,7 @@ def resume_at(carry: Carried, line: str) -> tuple[Carried, int | None]:
# So a name here is exempt from that one rule, and a name in `NOT_PROSE` from all three.
TOOL_DIRECTIVE = re.compile(
r"^(?:syntax=|escape=|fmt:\s*(?:on|off|skip)\b|pragma:|nosec\b|checkov:|hadolint\b"
r"|renovate:|yaml-language-server:|-\*-\s*coding[:=]|pyright:|isort:|(?i:nopep8)\b"
r"|renovate:|yaml-language-server:|-\*-\s*coding[:=]|pyright:|isort:"
r"|codespell:|doctest:)"
)

Expand Down
2 changes: 2 additions & 0 deletions tests/test_prose_lint.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1592,6 +1592,8 @@ def test_a_directive_is_read_in_any_letter_case_its_tool_reads(self) -> None:
("tool.py", "# NoQA\n"),
("tool.py", "# NOPEP8\n"),
("tool.py", "# NoPep8: E501\n"),
("tool.py", "# NOPEP8: E501. Another sentence follows.\n"),
("tool.py", "# nopep8\n"),
("app.ts", "// cspell:ignore vendorid\n"),
("app.ts", "// CSPELL: ignore vendorid\n"),
("app.ts", "// spell-checker: disable\n"),
Expand Down
Loading