Skip to content

pre-commit.md

Latest commit

 

History

History
122 lines (92 loc) · 3.89 KB

pre-commit.md

File metadata and controls

122 lines (92 loc) · 3.89 KB

Using VibeGuard with pre-commit

VibeGuard ships a .pre-commit-hooks.yaml so any project using pre-commit can drop the gate into its local hook chain in two lines — no local-hook boilerplate, no custom shell wrapper, no second tool to keep version-pinned.

Install pre-commit

pip install pre-commit
pre-commit install

Add VibeGuard to .pre-commit-config.yaml

repos:
  - repo: https://github.com/dgenio/vibeguard
    rev: v0.6.0   # pin to a released tag — never `main`
    hooks:
      - id: vibeguard-gate

vibeguard-gate runs vibeguard gate --fail-on high by default. It blocks the commit if any finding at or above high severity is reported. Override the threshold via args:

      - id: vibeguard-gate
        args: [--fail-on, critical]

Available hooks

Hook ID Command Exit behaviour Typical use
vibeguard-gate vibeguard gate Non-zero on findings at or above --fail-on (default high). Block risky commits in pre-commit / pre-push.
vibeguard-scan vibeguard scan Always 0 — informational only. Print findings without blocking commits.
vibeguard-validate-config vibeguard validate Non-zero if vibeguard.yaml fails schema validation. Catch config typos before they break CI.

Each hook declares pass_filenames: false because VibeGuard scans the working tree as a whole; passing individual staged paths would drop the cross-file context the rules rely on (e.g. package leak detection, missing- tests checks).

vibeguard-validate-config is the one exception — it runs only when vibeguard.yaml itself changes (files: ^vibeguard\.yaml$).

Common configurations

Gate on critical only — surface everything else without blocking

repos:
  - repo: https://github.com/dgenio/vibeguard
    rev: v0.6.0
    hooks:
      - id: vibeguard-gate
        args: [--fail-on, critical]
      - id: vibeguard-scan

Run on pre-push instead of pre-commit

repos:
  - repo: https://github.com/dgenio/vibeguard
    rev: v0.6.0
    hooks:
      - id: vibeguard-gate
        stages: [pre-push]

Scope to a sub-directory (monorepos)

      - id: vibeguard-gate
        args: [--fail-on, high, --path, packages/api]

Use a custom config file

      - id: vibeguard-gate
        args: [--fail-on, high, --config, .vibeguard/strict.yaml]

Skipping the hook ad-hoc

Use the standard pre-commit escape hatch:

SKIP=vibeguard-gate git commit -m "wip"

CI: pre-commit.ci autoupdate

pre-commit.ci picks the repo up automatically. Add this to .pre-commit-config.yaml to opt-in to weekly rev: bumps:

ci:
  autoupdate_schedule: weekly

Troubleshooting

  • command not found: vibeguard — pre-commit installs the hook in its own isolated virtualenv, so the host shell does not need vibeguard on $PATH. If you see this error, check that language: python is set in .pre-commit-hooks.yaml (it ships that way by default).
  • Repository not in expected format — pin rev: to a released tag, not a branch name. main is rejected by pre-commit.
  • Different findings between hook and CI — both run the same vibeguard binary; the most common cause is a different --fail-on value or a missing vibeguard.yaml in the working tree.

Related