References¶

Information-oriented documentation. Use this section to look up the contract of each hook and the portfolio conventions that govern the repository.

Hook references¶

One page per hook under hooks/. Every page follows the same schema (short intro, Prerequisites, Arguments, Behaviour, Example, Troubleshooting).

guard-primary-checkout: block commits made in the primary checkout while it sits on a feature branch.

Common contract¶

These rules hold for every hook in the collection. Hook pages don't repeat them; instead, they reference this section.

Consumed remotely, pinned by tag¶

Hooks are consumed through pre-commit's standard repos: mechanism. The rev field is the single point of pinning:

repos:
  - repo: https://github.com/nolte/pre-commit-hooks
    rev: v1.0.0
    hooks:
      - id: guard-primary-checkout

Pin to a released tag for deterministic behaviour. Renovate bumps the rev in the consumer's config like any other dependency.

Fail open in automation¶

Every hook short-circuits to allow when the CI environment variable is set. CI checks the branch out in a detached HEAD inside a plain clone, which is indistinguishable from a primary checkout on a feature branch; the hooks target a developer's local commit, not the CI lint job.

Primary checkout versus linked worktree¶

Hooks that enforce the parallel-working-copies model act only in the primary checkout — distinguished by the per-worktree git-dir equalling the shared git-common-dir. In a linked worktree, feature-branch work is correct, so the hooks stay silent.

Configuration via `args:`¶

Tunable inputs are exposed through pre-commit args: with a sensible default. Each hook page lists its arguments in the Arguments table.

Repository governance¶

Governance and specs: portfolio conventions, reusable workflows, dependency governance, Vale stack, Probot settings.

Sources¶

.pre-commit-hooks.yaml (canonical hook manifest)
hooks/<id>.sh (canonical hook scripts)
CLAUDE.md