mirror of
https://github.com/j178/prek.git
synced 2026-04-03 17:34:03 +02:00
59230a7a72
* Add deduplicate feature # Conflicts: # src/cli/run/filter.rs * Linting * Linting * Fix failed test * Fix failed test * More testing * Revert "More testing" This reverts commit 40304335c49d27f7024703da4f3ac4d775af52f7. * Linting * Support orphan projects * Support orphan projects * Fix filter * Add a failing test * "orphan" is an static attribute, always in effect --------- Co-authored-by: Jo <10510431+j178@users.noreply.github.com>
93 lines
3.2 KiB
Markdown
93 lines
3.2 KiB
Markdown
# Configuration
|
|
|
|
Prek is fully compatible with pre-commit configuration file `.pre-commit-config.yaml`, for example:
|
|
|
|
```yaml
|
|
repos:
|
|
- repo: https://github.com/pre-commit/pre-commit-hooks
|
|
rev: v6.0.0
|
|
hooks:
|
|
- id: trailing-whitespace
|
|
- id: end-of-file-fixer
|
|
|
|
- repo: https://github.com/crate-ci/typos
|
|
rev: v1.36.2
|
|
hooks:
|
|
- id: typos
|
|
```
|
|
|
|
Your existing configs work unchanged with prek.
|
|
|
|
For configuration details, refer to the official pre-commit docs:
|
|
[pre-commit.com](https://pre-commit.com/)
|
|
|
|
## Prek specific configurations
|
|
|
|
### `minimum_prek_version`
|
|
|
|
Specify the minimum required version of prek for the configuration. If the installed version is lower, prek will exit with an error.
|
|
|
|
Example:
|
|
|
|
```yaml
|
|
minimum_prek_version: '0.2.0'
|
|
```
|
|
|
|
The original `minimum_pre_commit_version` option has no effect and gets ignored in prek.
|
|
|
|
### `orphan`
|
|
|
|
*Only applies in workspace mode with nested projects.*
|
|
|
|
By default, files in subprojects are processed multiple times - once for each project in the hierarchy that contains them. Setting `orphan: true` isolates the project from parent configurations, ensuring files in this project are processed only by this project and not by any parent projects.
|
|
|
|
Example:
|
|
|
|
```yaml
|
|
orphan: true
|
|
repos:
|
|
- repo: https://github.com/astral-sh/ruff-pre-commit
|
|
rev: v0.8.4
|
|
hooks:
|
|
- id: ruff
|
|
```
|
|
|
|
For more details and examples, see [Workspace Mode - File Processing Behavior](workspace.md#file-processing-behavior).
|
|
|
|
## Environment variables
|
|
|
|
Prek supports the following environment variables:
|
|
|
|
- `PREK_HOME` — Override the prek data directory (caches, toolchains, hook envs). Defaults to `~/.cache/prek` on macOS and Linux, and `%LOCALAPPDATA%\prek` on Windows.
|
|
- `PREK_COLOR` — Control colored output: auto (default), always, or never.
|
|
- `PREK_SKIP` — Comma-separated list of hook IDs to skip (e.g. black,ruff). See [Skipping Projects or Hooks](workspace.md#skipping-projects-or-hooks) for details.
|
|
- `PREK_ALLOW_NO_CONFIG` — Allow running without a .pre-commit-config.yaml (useful for ad‑hoc runs).
|
|
- `PREK_NO_CONCURRENCY` — Disable parallelism for installs and runs.
|
|
- `PREK_NO_FAST_PATH` — Disable Rust-native built-in hooks; always use the original hook implementation. See [Built-in Fast Hooks](builtin.md) for details.
|
|
|
|
- `PREK_UV_SOURCE` — Control how uv (Python package installer) is installed. Options:
|
|
|
|
- `github` (download from GitHub releases)
|
|
- `pypi` (install from PyPI)
|
|
- `tuna` (use Tsinghua University mirror)
|
|
- `aliyun` (use Alibaba Cloud mirror)
|
|
- `tencent` (use Tencent Cloud mirror)
|
|
- `pip` (install via pip)
|
|
- a custom PyPI mirror URL
|
|
|
|
If not set, prek automatically selects the best available source.
|
|
|
|
- `PREK_NATIVE_TLS` - Use system's trusted store instead of the bundled `webpki-roots` crate.
|
|
|
|
- `PREK_CONTAINER_RUNTIME` - Specify the container runtime to use for container-based hooks (e.g., `docker`, `docker_image`). Options:
|
|
|
|
- `auto` (default, auto-detect available runtime)
|
|
- `docker`
|
|
- `podman`
|
|
|
|
Compatibility fallbacks:
|
|
|
|
- `PRE_COMMIT_ALLOW_NO_CONFIG` — Fallback for `PREK_ALLOW_NO_CONFIG`.
|
|
- `PRE_COMMIT_NO_CONCURRENCY` — Fallback for `PREK_NO_CONCURRENCY`.
|
|
- `SKIP` — Fallback for `PREK_SKIP`.
|