generating-precommit

Generate Pre-commit Config

Create optimized .pre-commit-config.yaml for Python projects.

Tool Selection Rationale

Ruff replaces: black, autopep8, autoflake, isort, flake8, flake8-bandit

Still needed:

• gitleaks - Secrets detection (not Python-specific)
• pip-audit - Dependency vulnerabilities (not covered by ruff)
• pre-commit-hooks - File validation, merge conflicts

Dropped:

• bandit → ruff S rules cover security checks
• black → ruff format is identical, faster
• isort → ruff I rules
• flake8 → ruff check

Workflow

1. Check Existing Config

Glob: .pre-commit-config.yaml

If exists, ask via AskUserQuestion:

• "Merge hooks" - Keep custom hooks, update versions
• "Overwrite" - Replace entirely
• "Skip" - Don't modify

1b. Detect Redundant Tools

If existing config contains black, isort, flake8, autopep8, autoflake, or bandit, ask:

question: "Detected tools that ruff replaces. Migrate to ruff?"
header: "Migration"
options:
  - label: "Yes, replace with ruff"
    description: "Remove black/isort/flake8/bandit, use ruff instead"
  - label: "No, keep existing"
    description: "Keep current setup unchanged"

2. Generate .pre-commit-config.yaml

Read the base config from references/pre-commit-base.yaml and use it as the starting template.

Customizations to apply based on project context:

• If no chart/ directory, remove the exclude: '^chart/templates/' from check-yaml
• If project uses markdown files, uncomment the markdownlint section
• If project uses Makefiles, uncomment the mbake section
• If project uses Docker, uncomment the hadolint section
• If project has strict typing, uncomment the mypy section

Copy the base config to .pre-commit-config.yaml with applicable sections uncommented.

4. Report

Created .pre-commit-config.yaml

Hook ordering (autofix first to minimize retries):
  1. Security:    gitleaks, pip-audit, detect-private-key
  2. Autofix:     whitespace fixers (end-of-file, trailing, line-ending)
  3. Ruff:        ruff-format THEN ruff --fix (format before lint)
  4. Validation:  check-ast, check-yaml/json/toml, debug-statements
  5. Git quality: no-commit-to-branch, check-merge-conflict
  6. Commits:     conventional-pre-commit (commit-msg stage)

Ruff replaces: black, isort, flake8, bandit, autopep8

Install: pre-commit install
Run all: pre-commit run --all-files
Update:  pre-commit autoupdate

Version Updates

Check latest versions before generating: gitleaks, ruff-pre-commit, pre-commit-hooks, pip-audit (all on GitHub releases).