Skip to content

feat(tooling): add category header comments to pre-commit configuration - #157

Merged
JacksonFergusonDev merged 3 commits into
mainfrom
feat/pre-commit-header-comments
Aug 14, 2026
Merged

feat(tooling): add category header comments to pre-commit configuration#157
JacksonFergusonDev merged 3 commits into
mainfrom
feat/pre-commit-header-comments

Conversation

@JacksonFergusonDev

Copy link
Copy Markdown
Owner

Summary

Adds descriptive, contextual header comments above each - repo: chunk in generated .pre-commit-config.yaml files. Each category comment is bound directly to its corresponding hook payload or toolchain aggregate block, ensuring comments only appear when their associated hooks are scaffolded into the workspace.

Changes

  • Executor Base & Local Blocks (src/protostar/executor.py):
    • Added # Generic hooks (configured to IGNORE Python) above the base repository configuration chunk.
    • Added # Local Python Toolchain (Managed via uv.lock) above the - repo: local container block.
  • Tooling Layer Modules (src/protostar/modules/tooling_layer.py):
    • MarkdownLintModule: Added # Markdown linting above - repo: https://github.com/DavidAnson/markdownlint-cli2.
    • CommitizenModule: Added # Commit message validation above - repo: https://github.com/commitizen-tools/commitizen.
    • RenovateModule: Added # Renovate config validation above - repo: https://github.com/renovatebot/pre-commit-hooks.
  • Repository Configuration & Docs:
    • Standardized root .pre-commit-config.yaml to follow the updated header comment styling.
    • Updated documentation snippet fixture docs/includes/cli_pre-commit-configyaml.md.
  • Test Suite (tests/test_executor.py):
    • Updated assertions to verify header comments across scaffold scenarios.

Verification

  • just test-unit passed (308 unit tests).
  • uv run ruff check . passed.
  • uv run ruff format --check . passed.
  • uv run mypy . passed.

@JacksonFergusonDev
JacksonFergusonDev merged commit fa1c89e into main Aug 14, 2026
9 of 10 checks passed
@JacksonFergusonDev
JacksonFergusonDev deleted the feat/pre-commit-header-comments branch August 14, 2026 20:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant