pre-commit Framework

By default, pre-commit stores its repository cache in ~/.cache/pre-commit. You can change this location using one of two environment variables:

1. PRE_COMMIT_HOME: Sets the specific directory for the cache.
2. XDG_CACHE_HOME: Sets the base cache directory; pre-commit will then use $XDG_CACHE_HOME/pre-commit.

The hook repository must have a Cargo.toml that produces at least one binary. pre-commit installs it via cargo install --bins into the pre-commit cache. The entry must match the binary name.

Dependencies:

• Use {package_name}:{package_version} for library dependencies (used to build the hook).
• Use cli:{package_name}:{package_version} for CLI dependencies (built separately).

To find hooks compatible with your specific language or project type, you can use advanced search queries on Sourcegraph or GitHub. This is the recommended way to discover hooks that are already being used in successful projects.

Using Sourcegraph

Use these queries to find hooks targeting specific file types:

• Python hooks: file:^\.pre-commit-hooks\.yaml$ "types: [python]"
• Shell hooks: file:^\.pre-commit-hooks\.yaml$ "types: [shell]"
• Popular configurations: file:^\.pre-commit-config\.yaml$

Using GitHub

Search for repositories that define hooks using the following query:

• path:.pre-commit-hooks.yaml language:YAML

Sourcegraph Python search:
file:^\.pre-commit-hooks\.yaml$ "types: [python]"

GitHub search:
path:.pre-commit-hooks.yaml language:YAML

language: pygrep is a cross-platform Python implementation of grep. It is used to prevent commits by matching files against a regular expression.

• Entry: The regex pattern.
• Case Insensitivity: Start the entry with (?i) or use args: [-i].
• Multiline: Use args: [--multiline].
• Negation: Use args: [--negate] to require all files to match.

The hook repository must have a renv.lock file. pre-commit restores the environment using renv::restore().

• Entry: The entry should be Rscript -e {expression} or Rscript path/relative/to/hook/root.
• Isolation: The R Startup process is skipped (emulating --vanilla).
• Dependencies: additional_dependencies are passed to pkg> add using Pkg REPL mode syntax.

- id: foo-without-args
  name: ...
  language: julia
  entry: bin/foo.jl
- id: bar-with-args
  name: ...
  language: julia
  entry: bin/bar.jl --arg1 --arg2
- id: baz-with-extra-deps
  name: ...
  language: julia
  entry: bin/baz.jl
  additional_dependencies:
   - 'ExtraDepA@1'
   - 'ExtraDepB@2.4'

Because pre-commit downloads and builds environments, using CI caching is highly recommended to speed up builds. Note that for immutable caches (like Azure Pipelines, CircleCI, or GitHub Actions), you should include the Python version and the .pre-commit-config.yaml hash in your cache key to ensure cache invalidation when configurations change.

GitHub Actions Example:

    - name: set PY
      run: echo "PY=$(python -VV | sha256sum | cut -d' ' -f1)" >> $GITHUB_ENV
    - uses: actions/cache@v3
      with:
        path: ~/.cache/pre-commit
        key: pre-commit|${{ env.PY }}|${{ hashFiles('.pre-commit-config.yaml') }}

GitLab CI Example:

my_job:
  variables:
    PRE_COMMIT_HOME: ${CI_PROJECT_DIR}/.cache/pre-commit
  cache:
    paths:
      - ${PRE_COMMIT_HOME}

The hook repository must contain Go source code. pre-commit installs it via go install ./... into an isolated GOPATH. The entry must match an executable in the GOPATH/bin directory.

Features:

• Supports additional_dependencies (passed to go install).
• Supports language_version (as of 3.0.0).
• pre-commit will bootstrap go if it is not present.